diff options
Diffstat (limited to 'data/zh_cn/cms/2024-03-30')
| -rw-r--r-- | data/zh_cn/cms/2024-03-30/api-docs.php | 31190 |
1 files changed, 13447 insertions, 17743 deletions
diff --git a/data/zh_cn/cms/2024-03-30/api-docs.php b/data/zh_cn/cms/2024-03-30/api-docs.php index fff67ea..158f476 100644 --- a/data/zh_cn/cms/2024-03-30/api-docs.php +++ b/data/zh_cn/cms/2024-03-30/api-docs.php @@ -1,895 +1,464 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'Cms', - 'version' => '2024-03-30', - ], + 'info' => ['style' => 'ROA', 'product' => 'Cms', 'version' => '2024-03-30'], 'directories' => [ [ - 'id' => 372127, - 'title' => '工作空间', + 'children' => ['ExecuteQuery'], 'type' => 'directory', - 'children' => [ - 'PutWorkspace', - 'GetWorkspace', - 'ListWorkspaces', - 'DeleteWorkspace', - 'CreateCloudResource', - 'GetCloudResource', - 'GetCloudResourceData', - 'DeleteCloudResource', - 'CreateEntityStore', - 'GetEntityStore', - 'GetEntityStoreData', - 'DeleteEntityStore', - 'CreateUmodel', - 'GetUmodel', - 'UpdateUmodel', - 'DeleteUmodel', - 'GetUmodelData', - 'UpsertUmodelData', - 'DeleteUmodelData', - 'GetUmodelCommonSchemaRef', - 'DeleteUmodelCommonSchemaRef', - 'UpsertUmodelCommonSchemaRef', - ], + 'title' => '数据集', + 'id' => 436361, ], [ - 'id' => 372150, - 'title' => '数字员工', + 'children' => ['CreateContextStore', 'UpdateContextStore', 'ListContextStores', 'GetContextStore', 'DeleteContextStore', 'AddContexts', 'UpdateContext', 'SearchContext', 'GetContext', 'DeleteContexts', 'DeleteContext', 'CreateContextStoreAPIKey', 'ListContextStoreAPIKeys', 'DeleteContextStoreAPIKey'], 'type' => 'directory', - 'children' => [ - 'CreateChat', - 'CreateDigitalEmployee', - 'GetDigitalEmployee', - 'UpdateDigitalEmployee', - 'ListDigitalEmployees', - 'DeleteDigitalEmployee', - 'CreateThread', - 'GetThread', - 'GetThreadData', - 'ListThreads', - 'UpdateThread', - 'DeleteThread', - ], + 'title' => '上下文库', + 'id' => 448763, ], [ - 'id' => 372163, - 'title' => '数据接入', + 'children' => ['UpdateMemoryStore', 'UpdateMemory', 'ListMemoryStores', 'GetMemoryStore', 'GetMemoryHistory', 'GetMemory', 'GetMemories', 'DeleteMemoryStore', 'DeleteMemory', 'DeleteMemories', 'AddMemories', 'CreateMemoryStore'], 'type' => 'directory', - 'children' => [ - 'UpdateIntegrationPolicy', - 'DeleteIntegrationPolicy', - 'CreateIntegrationPolicy', - 'UpdateAddonRelease', - 'ListIntegrationPolicyStorageRequirements', - 'ListIntegrationPolicyPodMonitors', - 'ListIntegrationPolicyDashboards', - 'ListIntegrationPolicyCustomScrapeJobRules', - 'ListIntegrationPolicies', - 'ListAddonReleases', - 'GetIntegrationPolicy', - 'GetAddonRelease', - 'DeleteAddonRelease', - 'CreateAddonRelease', - ], + 'title' => '记忆库', + 'id' => 410737, ], [ - 'id' => 372178, - 'title' => '应用监控/用户体验监控', - 'type' => 'directory', 'children' => [ - 'GetServiceObservability', - 'DeleteService', - 'UpdateService', - 'GetService', - 'CreateService', - 'ListServices', - 'ListServices', + 'PutWorkspace', 'GetWorkspace', 'ListWorkspaces', 'DeleteWorkspace', 'CreateCloudResource', 'GetCloudResource', 'GetCloudResourceData', 'DeleteCloudResource', 'CreateEntityStore', 'GetEntityStore', 'GetEntityStoreData', 'DeleteEntityStore', 'CreateUmodel', 'GetUmodel', 'UpdateUmodel', 'DeleteUmodel', 'GetUmodelData', 'UpsertUmodelData', 'DeleteUmodelData', 'GetUmodelCommonSchemaRef', + 'DeleteUmodelCommonSchemaRef', 'UpsertUmodelCommonSchemaRef', ], + 'type' => 'directory', + 'title' => '工作空间', + 'id' => 419962, ], [ - 'id' => 372185, - 'title' => 'Prometheus', + 'children' => ['GetAddon', 'GetAddonSchema', 'UpdateIntegrationPolicy', 'DeleteIntegrationPolicy', 'CreateIntegrationPolicy', 'UpdateAddonRelease', 'ListIntegrationPolicyStorageRequirements', 'ListIntegrationPolicyPodMonitors', 'ListIntegrationPolicyDashboards', 'ListIntegrationPolicyCustomScrapeJobRules', 'ListIntegrationPolicies', 'GetIntegrationPolicy', 'GetAddonRelease', 'CreateAddonRelease', 'ListIntegrationPolicyServiceMonitors', 'ListIntegrationPolicyCollectors', 'ListIntegrationPolicyAddons'], 'type' => 'directory', - 'children' => [ - 'CreatePrometheusVirtualInstance', - 'ListPrometheusVirtualInstances', - 'GetAggTaskGroup', - 'CreateAggTaskGroup', - 'DeleteAggTaskGroup', - 'UpdateAggTaskGroupStatus', - 'UpdateAggTaskGroup', - 'ListAggTaskGroups', - 'DeletePrometheusInstance', - 'DeletePrometheusView', - 'GetPrometheusInstance', - 'GetPrometheusView', - 'ListPrometheusDashboards', - 'UpdatePrometheusView', - 'UpdatePrometheusInstance', - 'ListPrometheusViews', - 'ListPrometheusInstances', - 'CreatePrometheusInstance', - 'CreatePrometheusView', - ], + 'title' => '数据接入', + 'id' => 264511, ], [ - 'id' => 372210, - 'title' => '告警', + 'children' => ['CreateServiceObservability', 'CreateServiceRecord', 'UpdateServiceRecord', 'GetServiceRecord', 'DeleteServiceRecord', 'ListServiceRecords', 'GetServiceObservability', 'DeleteService', 'UpdateService', 'GetService', 'CreateService', 'ListServices'], 'type' => 'directory', - 'children' => [ - 'ListAlertActions', - 'UpdateSubscription', - 'CreateAlertWebhook', - 'DeleteAlertWebhooks', - 'ListAlertWebhooks', - 'UpdateAlertWebhook', - 'UpdateNotifyStrategy', - ], + 'title' => '应用监控/用户体验监控', + 'id' => 264649, ], [ - 'id' => 372218, - 'title' => '控制台内嵌', - 'type' => 'directory', 'children' => [ - 'CreateTicket', + 'CreatePrometheusInstance', 'GetPrometheusInstance', 'ListPrometheusInstances', 'UpdatePrometheusInstance', 'DeletePrometheusInstance', 'DeleteDeliveryTask', 'UpdateDeliveryTask', 'ListDeliveryTasks', 'GetDeliveryTask', 'CreateDeliveryTask', 'CreatePrometheusVirtualInstance', 'ListPrometheusVirtualInstances', 'DeletePrometheusVirtualInstance', 'GetAggTaskGroup', 'CreateAggTaskGroup', 'DeleteAggTaskGroup', 'UpdateAggTaskGroupStatus', 'UpdateAggTaskGroup', 'ListAggTaskGroups', 'ListPrometheusDashboards', + 'DeletePrometheusView', 'GetPrometheusView', 'UpdatePrometheusView', 'ListPrometheusViews', 'CreatePrometheusView', ], + 'type' => 'directory', + 'title' => 'Prometheus', + 'id' => 265154, ], [ - 'id' => 372220, - 'title' => '标签资源组', + 'children' => ['ListAlertActions', 'CreateAlertWebhook', 'DeleteAlertWebhooks', 'ListAlertWebhooks', 'UpdateAlertWebhook', 'UpdateNotifyStrategy'], 'type' => 'directory', - 'children' => [ - 'TagResources', - 'UntagResources', - 'ListTagResources', - 'ChangeResourceGroup', - ], + 'title' => '告警', + 'id' => 264800, ], [ - 'id' => 372225, - 'title' => '地域', + 'children' => ['CreateTicket'], 'type' => 'directory', - 'children' => [ - 'DescribeRegions', - ], + 'title' => '控制台内嵌', + 'id' => 265112, ], [ - 'id' => 372227, - 'title' => '服务开通', + 'children' => ['GetCmsService'], 'type' => 'directory', - 'children' => [ - 'GetCmsService', - ], + 'title' => '服务开通', + 'id' => 270677, ], [ - 'id' => 372229, - 'title' => '其他', - 'type' => 'directory', 'children' => [ - 'CreateBizTrace', - 'CreateServiceObservability', - 'DeleteBizTrace', - 'GetAddon', - 'GetAddonCodeTemplate', - 'GetAddonSchema', - 'GetBizTrace', - 'GetIntegrationVersionForCS', - 'GetPrometheusUserSetting', - 'ListAddons', - 'ListBizTraces', - 'ListIntegrationPolicyAddons', - 'ListIntegrationPolicyCollectors', - 'ListIntegrationPolicyServiceMonitors', - 'UpdateBizTrace', - 'UpdatePrometheusUserSetting', + 'CreateBizTrace', 'DeleteBizTrace', 'GetAddonCodeTemplate', 'GetBizTrace', 'GetIntegrationVersionForCS', 'GetPrometheusUserSetting', 'ListAlertRobots', 'ListBizTraces', 'ListContactGroups', 'ListContacts', 'OpenCmsService', 'UpdateBizTrace', 'UpdatePrometheusUserSetting', 'ChangeResourceGroup', 'CreateDataset', 'CreatePipeline', 'DeleteAddonRelease', 'DeleteDataset', 'DeletePipeline', 'DescribeRegions', + 'GetDataset', 'GetPipeline', 'ListAddonReleases', 'ListAddons', 'ListDatasets', 'ListPipelines', 'ListTagResources', 'ManageAlertRules', 'QueryAlertRules', 'SearchMemories', 'TagResources', 'UntagResources', 'UpdateDataset', 'UpdatePipeline', 'UpdateSubscription', 'DescribeMetricMetaList', ], + 'type' => 'directory', + 'title' => '其他', + 'id' => 251981, ], ], 'components' => [ 'schemas' => [ + 'ActionIntegrationConfig' => [ + 'title' => '行动集成配置', + 'type' => 'object', + 'properties' => [ + 'enabled' => ['title' => '是否启用行动集成', 'type' => 'boolean'], + 'actions' => [ + 'title' => '行动集成 ID 列表', + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + ], + ], 'AddonMeta' => [ 'description' => '接入组件信息', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '组件名称', - 'type' => 'string', - 'example' => 'cloud-acs-ecs', - ], - 'version' => [ - 'description' => '版本号', - 'type' => 'string', - 'example' => '0.0.1', - ], - 'language' => [ - 'description' => '语言，取值：'."\n" - ."\n" - .'- zh：中文（默认值）'."\n" - .'- en：英文', - 'type' => 'string', - 'example' => 'zh', - ], - 'description' => [ - 'description' => '描述信息。', - 'type' => 'string', - 'example' => 'The out-of-the-box and comprehensive ECS observe dashboards and alarm rules. Based on AliYun CloudMonitor agentless metrics, exporter agent metrics, host audit logs, host events and other data.', - ], - 'scene' => [ - 'description' => '场景', - 'type' => 'string', - 'example' => 'feature', - ], - 'alias' => [ - 'description' => '组件别名，显示名称', - 'type' => 'string', - 'example' => 'ECS 监控', - ], - 'icon' => [ - 'description' => '组件图标。', - 'type' => 'string', - 'example' => 'assets/logos/ecs.svg', - ], + 'name' => ['description' => '组件名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'cloud-acs-ecs', 'backendName' => 'name'], + 'version' => ['description' => '版本号', 'visibility' => 'Public', 'type' => 'string', 'example' => '0.0.1', 'backendName' => 'version'], + 'language' => ['description' => '语言，取值：'."\n" + ."\n" + .'- zh：中文（默认值）'."\n" + .'- en：英文', 'visibility' => 'Public', 'type' => 'string', 'example' => 'zh', 'backendName' => 'language'], + 'description' => ['description' => '描述信息。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'The out-of-the-box and comprehensive ECS observe dashboards and alarm rules. Based on AliYun CloudMonitor agentless metrics, exporter agent metrics, host audit logs, host events and other data.', 'backendName' => 'description'], + 'scene' => ['description' => '场景', 'visibility' => 'Public', 'type' => 'string', 'example' => 'feature', 'backendName' => 'scene'], + 'alias' => ['description' => '组件别名，显示名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'ECS 监控', 'backendName' => 'alias'], + 'icon' => ['description' => '组件图标。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'assets/logos/ecs.svg', 'backendName' => 'icon'], 'keywords' => [ 'description' => '关键词列表', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '关键词', - 'type' => 'string', - 'example' => 'Monitor', - ], - ], - 'once' => [ - 'description' => 'Policy 下是否只能安装一次', - 'type' => 'boolean', - 'example' => 'true/false', + 'items' => ['description' => '关键词', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Monitor', 'extendType' => 'true'], + 'backendName' => 'keywords', ], + 'once' => ['description' => 'Policy 下是否只能安装一次', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true/false', 'backendName' => 'once'], 'environments' => [ 'description' => '支持的环境类型列表', + 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '接入环境类型描述', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '环境类型名称', - 'type' => 'string', - 'example' => 'CS/ECS/Cloud/Client', - ], - 'enable' => [ - 'description' => '是否启用', - 'type' => 'boolean', - 'example' => 'true/false', - ], - 'label' => [ - 'description' => '环境类型显示名称', - 'type' => 'string', - 'example' => '容器环境', - ], - 'description' => [ - 'description' => '环境类型的描述', - 'type' => 'string', - 'example' => '支持容器集群的工作覆盖监控', - ], + 'name' => ['description' => '环境类型名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'CS/ECS/Cloud/Client', 'backendName' => 'name'], + 'enable' => ['description' => '是否启用', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true/false', 'backendName' => 'enable'], + 'label' => ['description' => '环境类型显示名称', 'visibility' => 'Public', 'type' => 'string', 'example' => '容器环境', 'backendName' => 'label'], + 'description' => ['description' => '环境类型的描述', 'visibility' => 'Public', 'type' => 'string', 'example' => '支持容器集群的工作覆盖监控', 'backendName' => 'description'], 'policies' => [ 'description' => '组件的控制策略组合信息', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'defaultInstall' => [ - 'description' => '是否默认安装', - 'type' => 'boolean', - 'example' => 'true/false', - ], - 'targetAddonName' => [ - 'description' => '跳转的目标组件名称', - 'type' => 'string', - 'example' => 'cloud-acs-ecs', - ], - 'alertDefaultStatus' => [ - 'description' => '告警规则默认安装后是否启用', - 'type' => 'string', - 'example' => 'RUNNING', - ], + 'defaultInstall' => ['description' => '是否默认安装', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true/false', 'backendName' => 'defaultInstall'], + 'targetAddonName' => ['description' => '跳转的目标组件名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'cloud-acs-ecs', 'backendName' => 'targetAddonName'], + 'alertDefaultStatus' => ['description' => '告警规则默认安装后是否启用', 'visibility' => 'Public', 'type' => 'string', 'example' => 'RUNNING', 'backendName' => 'alertDefaultStatus'], 'protocols' => [ 'description' => '支持的客户端协议信息列表', + 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '协议信息', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '协议名称', - 'type' => 'string', - 'example' => 'Prometheus', - ], - 'label' => [ - 'description' => '协议显示名称', - 'type' => 'string', - 'example' => 'Prometheus 协议', - ], - 'description' => [ - 'description' => '协议描述', - 'type' => 'string', - 'example' => '使用 Prometheus 协议写入指标数据', - ], - 'icon' => [ - 'description' => '协议显示icon', - 'type' => 'string', - 'example' => 'assets/logos/ecs.svg'."\n", - ], + 'name' => ['description' => '协议名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Prometheus', 'backendName' => 'name'], + 'label' => ['description' => '协议显示名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Prometheus 协议', 'backendName' => 'label'], + 'description' => ['description' => '协议描述', 'visibility' => 'Public', 'type' => 'string', 'example' => '使用 Prometheus 协议写入指标数据', 'backendName' => 'description'], + 'icon' => ['description' => '协议显示icon', 'visibility' => 'Public', 'type' => 'string', 'example' => 'assets/logos/ecs.svg'."\n", 'backendName' => 'icon'], ], + 'extendType' => 'true', ], + 'backendName' => 'protocols', ], 'metricCheckRule' => [ 'description' => '组件接入后的数据检查规则', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'promQL' => [ 'description' => '检测规则 PromQL', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '检测规则 PromQL', - 'type' => 'string', - 'example' => 'up{job="acs-ecs"}==1', - ], + 'items' => ['description' => '检测规则 PromQL', 'visibility' => 'Public', 'type' => 'string', 'example' => 'up{job="acs-ecs"}==1', 'extendType' => 'true'], + 'backendName' => 'promQL', ], ], + 'backendName' => 'metricCheckRule', ], - 'needRestartAfterIntegration' => [ - 'description' => '是否需要在接入后提示重启工作负载', - 'type' => 'boolean', - 'example' => 'true/false', - ], - 'enableServiceAccount' => [ - 'description' => '是否启用内部授权Token分配', - 'type' => 'boolean', - 'example' => 'true/false', - ], + 'needRestartAfterIntegration' => ['description' => '是否需要在接入后提示重启工作负载', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true/false', 'backendName' => 'needRestartAfterIntegration'], + 'enableServiceAccount' => ['description' => '是否启用内部授权Token分配', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true/false', 'backendName' => 'enableServiceAccount'], 'bindEntity' => [ 'description' => '绑定的目标实体信息', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'entityGroupMode' => [ - 'description' => '是否是组模式', - 'type' => 'boolean', - 'example' => 'true/false', - ], - 'singleEntityMode' => [ - 'description' => '是否是单实体模式', - 'type' => 'boolean', - 'example' => 'true/false'."\n", - ], - 'entityType' => [ - 'description' => '实体类型', - 'type' => 'string', - 'example' => 'acs.ecs.instance', - ], - 'vpcIdFieldKey' => [ - 'description' => '实体中提取VPC ID 信息的字段', - 'type' => 'string', - 'example' => 'vpcId', - ], + 'entityGroupMode' => ['description' => '是否是组模式', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true/false', 'backendName' => 'entityGroupMode'], + 'singleEntityMode' => ['description' => '是否是单实体模式', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true/false'."\n", 'backendName' => 'singleEntityMode'], + 'entityType' => ['description' => '实体类型', 'visibility' => 'Public', 'type' => 'string', 'example' => 'acs.ecs.instance', 'backendName' => 'entityType'], + 'vpcIdFieldKey' => ['description' => '实体中提取VPC ID 信息的字段', 'visibility' => 'Public', 'type' => 'string', 'example' => 'vpcId', 'backendName' => 'vpcIdFieldKey'], ], + 'backendName' => 'bindEntity', ], - 'bindDefaultPolicy' => [ - 'description' => '默认模式，即无需绑定实体的接入模式。', - 'type' => 'boolean', - 'example' => 'true/false', - ], + 'bindDefaultPolicy' => ['description' => '默认模式，即无需绑定实体的接入模式。', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true/false', 'backendName' => 'bindDefaultPolicy'], ], + 'backendName' => 'policies', ], 'dependencies' => [ 'description' => '依赖描述信息', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'features' => [ 'description' => '探针依赖描述，组件名称。新版已由 collectors 字段替换', + 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => '是否依赖', - 'type' => 'boolean', - 'example' => 'true/false', - ], + 'additionalProperties' => ['description' => '是否依赖', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true/false'], + 'backendName' => 'features', ], 'services' => [ 'description' => '依赖的服务列表', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '服务代号名称，由前端完成服务检测', - 'type' => 'string', - 'example' => 'cmee', - ], + 'items' => ['description' => '服务代号名称，由前端完成服务检测', 'visibility' => 'Public', 'type' => 'string', 'example' => 'cmee', 'extendType' => 'true'], + 'backendName' => 'services', ], 'clusterTypes' => [ 'description' => '支持的集群类型', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '集群类型名称', - 'type' => 'string', - 'example' => 'ManagedKubernetes/Default', - ], + 'items' => ['description' => '集群类型名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'ManagedKubernetes/Default', 'extendType' => 'true'], + 'backendName' => 'clusterTypes', ], ], + 'backendName' => 'dependencies', ], - 'policyType' => [ - 'description' => '策略类型', - 'type' => 'string', - 'example' => 'ECS', - ], + 'policyType' => ['description' => '策略类型', 'visibility' => 'Public', 'type' => 'string', 'example' => 'ECS', 'backendName' => 'policyType'], 'commonSchemaRefs' => [ 'description' => '绑定的CommonSchema 列表', + 'visibility' => 'Public', 'type' => 'array', 'items' => [ + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'group' => [ - 'description' => 'CommonSchema 的分组名称', - 'type' => 'string', - 'example' => 'acs-ecs', - ], - 'version' => [ - 'description' => 'CommonSchema 的分组版本', - 'type' => 'string', - 'example' => '0.1.0', - ], + 'group' => ['description' => 'CommonSchema 的分组名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'acs-ecs', 'backendName' => 'group'], + 'version' => ['description' => 'CommonSchema 的分组版本', 'visibility' => 'Public', 'type' => 'string', 'example' => '0.1.0', 'backendName' => 'version'], ], + 'extendType' => 'true', + 'description' => '', ], + 'backendName' => 'commonSchemaRefs', ], ], + 'extendType' => 'true', ], + 'backendName' => 'environments', ], 'categories' => [ 'description' => '组件分类信息', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '分类名称', - 'type' => 'string', - 'example' => 'infrastructure', - ], + 'items' => ['description' => '分类名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'infrastructure', 'extendType' => 'true'], + 'backendName' => 'categories', ], 'dashboards' => [ 'description' => '组件示意图列表', + 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '示意图列表', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '示意图名称', - 'type' => 'string', - 'example' => 'ECS 监控概览大盘', - ], - 'url' => [ - 'description' => '示意图 URL', - 'type' => 'string', - 'example' => 'assets/dashboards/ecs.png'."\n", - ], - 'description' => [ - 'description' => '描述信息', - 'type' => 'string', - 'example' => '描述信息', - ], + 'name' => ['description' => '示意图名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'ECS 监控概览大盘', 'backendName' => 'name'], + 'url' => ['description' => '示意图 URL', 'visibility' => 'Public', 'type' => 'string', 'example' => 'assets/dashboards/ecs.png'."\n", 'backendName' => 'url'], + 'description' => ['description' => '描述信息', 'visibility' => 'Public', 'type' => 'string', 'example' => '描述信息', 'backendName' => 'description'], ], + 'extendType' => 'true', ], + 'backendName' => 'dashboards', ], - 'weight' => [ - 'description' => '组件排序权重', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], - 'latestReleaseCreateTime' => [ - 'description' => '该组件上一次接入时间', - 'type' => 'string', - 'example' => '2025-10-25 09:12:12', - ], + 'weight' => ['description' => '组件排序权重', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'backendName' => 'weight'], + 'latestReleaseCreateTime' => ['description' => '该组件上一次接入时间', 'visibility' => 'Public', 'type' => 'string', 'example' => '2025-10-25 09:12:12', 'backendName' => 'latestReleaseCreateTime'], ], ], 'AlertEventIntegrationPolicyForModify' => [ 'title' => 'A short description of struct', 'description' => '用于查看的实体', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'transformerSetting' => [ 'description' => '转换设置', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '单个转换配置', - '$ref' => '#/components/schemas/TransformAction', - ], - ], - 'description' => [ - 'title' => '描述', - 'description' => '描述', - 'type' => 'string', - 'example' => 'test', - ], - 'filterSetting' => [ - 'description' => '过滤设置', - '$ref' => '#/components/schemas/FilterSetting', - ], - 'integrationSetting' => [ - 'title' => '订阅设置', - 'description' => '订阅设置', - 'type' => 'string', - 'example' => '{"region":"cn-hangzhou"}', - ], - 'type' => [ - 'title' => '类型', - 'description' => '类型', - 'type' => 'string', - 'example' => 'ALERT_CUSTOM', - ], - 'alertEventIntegrationPolicyName' => [ - 'title' => '名称', - 'description' => '名称', - 'type' => 'string', - 'required' => true, - 'example' => 'test integration', + 'items' => ['description' => '单个转换配置', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/TransformAction'], + 'backendName' => 'transformerSetting', ], + 'description' => ['title' => '描述', 'description' => '描述', 'visibility' => 'Public', 'type' => 'string', 'example' => 'test', 'backendName' => 'description'], + 'filterSetting' => ['description' => '过滤设置', 'visibility' => 'Public', 'backendName' => 'filterSetting', '$ref' => '#/components/schemas/FilterSetting'], + 'integrationSetting' => ['title' => '订阅设置', 'description' => '订阅设置', 'visibility' => 'Public', 'type' => 'string', 'example' => '{"region":"cn-hangzhou"}', 'backendName' => 'integrationSetting'], + 'type' => ['title' => '类型', 'description' => '类型', 'visibility' => 'Public', 'type' => 'string', 'example' => 'ALERT_CUSTOM', 'backendName' => 'type'], + 'alertEventIntegrationPolicyName' => ['title' => '名称', 'description' => '名称', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'test integration', 'backendName' => 'alertEventIntegrationPolicyName'], ], ], 'AlertEventIntegrationPolicyForView' => [ 'title' => 'A short description of struct', 'description' => '用于查看的实体', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'workspace' => [ - 'title' => 'workspace', - 'description' => 'workspace', - 'type' => 'string', - 'example' => 'workspace-test', - ], - 'description' => [ - 'title' => '描述', - 'description' => '描述', - 'type' => 'string', - 'example' => 'workspace test', - ], - 'filterSetting' => [ - 'description' => '过滤配置', - '$ref' => '#/components/schemas/FilterSetting', - ], - 'updateTime' => [ - 'title' => '更新时间', - 'description' => '更新时间', - 'type' => 'string', - 'example' => '2024-12-16T02:00:23Z', - ], - 'type' => [ - 'title' => '类型', - 'description' => '类型', - 'type' => 'string', - 'example' => 'ALERT_CUSTOM', - ], - 'userId' => [ - 'title' => '用户id', - 'description' => '用户id', - 'type' => 'string', - 'example' => '123123', - ], - 'alertEventIntegrationPolicyId' => [ - 'title' => 'UUID', - 'description' => 'UUID', - 'type' => 'string', - 'example' => '123123123', - ], - 'token' => [ - 'description' => '集成的上报入口key', - 'type' => 'string', - 'example' => '10-16818f1445e10a1d012922b285bfb334', - ], + 'workspace' => ['title' => 'workspace', 'description' => 'workspace', 'visibility' => 'Public', 'type' => 'string', 'example' => 'workspace-test', 'backendName' => 'workspace'], + 'description' => ['title' => '描述', 'description' => '描述', 'visibility' => 'Public', 'type' => 'string', 'example' => 'workspace test', 'backendName' => 'description'], + 'filterSetting' => ['description' => '过滤配置', 'visibility' => 'Public', 'backendName' => 'filterSetting', '$ref' => '#/components/schemas/FilterSetting'], + 'updateTime' => ['title' => '更新时间', 'description' => '更新时间', 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-12-16T02:00:23Z', 'backendName' => 'updateTime'], + 'type' => ['title' => '类型', 'description' => '类型', 'visibility' => 'Public', 'type' => 'string', 'example' => 'ALERT_CUSTOM', 'backendName' => 'type'], + 'userId' => ['title' => '用户id', 'description' => '用户id', 'visibility' => 'Public', 'type' => 'string', 'example' => '123123', 'backendName' => 'userId'], + 'alertEventIntegrationPolicyId' => ['title' => 'UUID', 'description' => 'UUID', 'visibility' => 'Public', 'type' => 'string', 'example' => '123123123', 'backendName' => 'alertEventIntegrationPolicyId'], + 'token' => ['description' => '集成的上报入口key', 'visibility' => 'Public', 'type' => 'string', 'example' => '10-16818f1445e10a1d012922b285bfb334', 'backendName' => 'token'], 'transformerSetting' => [ 'description' => '转换设置', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '单个转换配置', - '$ref' => '#/components/schemas/TransformAction', - ], - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58Z', - ], - 'enable' => [ - 'title' => '是否启用', - 'description' => '是否启用', - 'type' => 'boolean', - 'example' => 'true', - ], - 'integrationSetting' => [ - 'title' => '订阅设置', - 'description' => '订阅设置', - 'type' => 'string', - 'example' => '{"region":"cn-hangzhou"}', - ], - 'alertEventIntegrationPolicyName' => [ - 'title' => '名称', - 'description' => '名称', - 'type' => 'string', - 'required' => true, - 'example' => '集成名', + 'items' => ['description' => '单个转换配置', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/TransformAction'], + 'backendName' => 'transformerSetting', ], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'visibility' => 'Public', 'type' => 'string', 'example' => '2025-03-11T08:21:58Z', 'backendName' => 'createTime'], + 'enable' => ['title' => '是否启用', 'description' => '是否启用', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'enabled'], + 'integrationSetting' => ['title' => '订阅设置', 'description' => '订阅设置', 'visibility' => 'Public', 'type' => 'string', 'example' => '{"region":"cn-hangzhou"}', 'backendName' => 'integrationSetting'], + 'alertEventIntegrationPolicyName' => ['title' => '名称', 'description' => '名称', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => '集成名', 'backendName' => 'alertEventIntegrationPolicyName'], ], ], 'AlertRuleAction' => [ 'description' => '告警规则的行动集成配置', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'actions' => [ 'description' => '行动集成ID列表', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '行动集成ID', - 'type' => 'string', - 'example' => 'myTestAction', - ], + 'items' => ['description' => '行动集成ID', 'visibility' => 'Public', 'type' => 'string', 'example' => 'myTestAction', 'extendType' => 'true'], + 'backendName' => 'actions', ], ], ], 'AlertRuleAlertMetricFilterDef' => [ 'description' => '告警规则告警指标过滤器定义对象', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'opt' => [ - 'description' => '过滤条件操作符', - 'type' => 'string', - 'example' => '=', - ], - 'hidden' => [ - 'title' => '是否隐藏。 如果隐藏则在前端交互中不显示，但在渲染promQL时可将该过滤条件的值上传上来。 典型的例子是APM场景中的pid这个过滤条件，一般不会通过配置化的方式进行显示，而是前端显为独立的应用搜索列表。', - 'description' => '是否隐藏。 如果隐藏则在前端交互中不显示，但在渲染promQL时可将该过滤条件的值上传上来。 典型的例子是APM场景中的pid这个过滤条件，一般不会通过配置化的方式进行显示，而是前端显为独立的应用搜索列表。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'displayNameCn' => [ - 'description' => '显示名称中文', - 'type' => 'string', - 'example' => '应用状态', - ], - 'dim' => [ - 'description' => 'APM指标中为维度', - 'type' => 'string', - 'example' => 'status', - ], - 'displayNameEn' => [ - 'description' => '显示名称英文', - 'type' => 'string', - 'example' => 'Application Status', - ], - 'labelDisabled' => [ - 'title' => '为true时，过滤项不出现在promQL的label filter中', - 'description' => '为true时，过滤项不出现在promQL的label filter中', - 'type' => 'boolean', - 'example' => 'true', - ], - 'dimDisabled' => [ - 'title' => '为true是，过滤项不出现在promQL的group by中', - 'description' => '为true是，过滤项不出现在promQL的group by中', - 'type' => 'boolean', - 'example' => 'true', - ], + 'opt' => ['description' => '过滤条件操作符', 'visibility' => 'Public', 'type' => 'string', 'example' => '=', 'backendName' => 'opt'], + 'hidden' => ['title' => '是否隐藏。 如果隐藏则在前端交互中不显示，但在渲染promQL时可将该过滤条件的值上传上来。 典型的例子是APM场景中的pid这个过滤条件，一般不会通过配置化的方式进行显示，而是前端显为独立的应用搜索列表。', 'description' => '是否隐藏。 如果隐藏则在前端交互中不显示，但在渲染promQL时可将该过滤条件的值上传上来。 典型的例子是APM场景中的pid这个过滤条件，一般不会通过配置化的方式进行显示，而是前端显为独立的应用搜索列表。', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'hidden'], + 'displayNameCn' => ['description' => '显示名称中文', 'visibility' => 'Public', 'type' => 'string', 'example' => '应用状态', 'backendName' => 'displayNameCn'], + 'dim' => ['description' => 'APM指标中为维度', 'visibility' => 'Public', 'type' => 'string', 'example' => 'status', 'backendName' => 'dim'], + 'displayNameEn' => ['description' => '显示名称英文', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Application Status', 'backendName' => 'displayNameEn'], + 'labelDisabled' => ['title' => '为true时，过滤项不出现在promQL的label filter中', 'description' => '为true时，过滤项不出现在promQL的label filter中', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'labelDisabled'], + 'dimDisabled' => ['title' => '为true是，过滤项不出现在promQL的group by中', 'description' => '为true是，过滤项不出现在promQL的group by中', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'dimDisabled'], 'supportedOpts' => [ 'description' => '支持的选项的列表', + 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '支持的选项', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'displayNameCn' => [ - 'description' => '显示名称中文', - 'type' => 'string', - 'example' => '在线', - ], - 'displayNameEn' => [ - 'description' => '显示名称英文', - 'type' => 'string', - 'example' => 'Online', - ], - 'value' => [ - 'description' => '匹配值', - 'type' => 'string', - 'example' => 'online', - ], + 'displayNameCn' => ['description' => '显示名称中文', 'visibility' => 'Public', 'type' => 'string', 'example' => '在线', 'backendName' => 'displayNameCn'], + 'displayNameEn' => ['description' => '显示名称英文', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Online', 'backendName' => 'displayNameEn'], + 'value' => ['description' => '匹配值', 'visibility' => 'Public', 'type' => 'string', 'example' => 'online', 'backendName' => 'value'], ], + 'extendType' => 'true', ], + 'backendName' => 'supportedOpts', + 'itemName' => 'opt', ], ], ], 'AlertRuleAlertMetricFilterDef_array' => [ 'description' => '告警规则告警指标过滤器定义对象数组', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '告警规则告警指标过滤器定义对象', - '$ref' => '#/components/schemas/AlertRuleAlertMetricFilterDef', - ], + 'items' => ['description' => '告警规则告警指标过滤器定义对象', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/AlertRuleAlertMetricFilterDef'], ], 'AlertRuleAlertMetricInput' => [ 'description' => '预定义指标输入配置。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'filterValues' => [ 'title' => '用户输入的过滤条件列表。指标所支持的参数列表、过滤条件列表可通过ListAlertMetrics进行查询。', 'description' => '用户输入的过滤条件列表。指标所支持的参数列表、过滤条件列表可通过ListAlertMetrics进行查询。', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '过滤项配置', - '$ref' => '#/components/schemas/AlertRuleAlertMetricInputFilterValue', - ], + 'items' => ['description' => '过滤项配置', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/AlertRuleAlertMetricInputFilterValue'], + 'backendName' => 'filterValues', ], 'paramValues' => [ 'title' => '输入的参数列表。 指标所支持的参数列表、过滤条件列表可通过ListAlertMetrics进行查询。', 'description' => '输入的参数列表。 指标所支持的参数列表、过滤条件列表可通过ListAlertMetrics进行查询。', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '预定义指标参数配置', - '$ref' => '#/components/schemas/AlertRuleAlertMetricInputParamValue', - ], - ], - 'metricId' => [ - 'title' => '用户所选预定义指标的key', - 'description' => '用户所选预定义指标的key', - 'type' => 'string', - 'example' => 'appstat.jvm.GcPsMarkSweepCount', - ], - 'groupId' => [ - 'title' => '用户所选指标组的key', - 'description' => '用户所选指标组的key', - 'type' => 'string', - 'example' => 'apm.jvm'."\n", + 'items' => ['description' => '预定义指标参数配置', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/AlertRuleAlertMetricInputParamValue'], + 'backendName' => 'paramValues', ], + 'metricId' => ['title' => '用户所选预定义指标的key', 'description' => '用户所选预定义指标的key', 'visibility' => 'Public', 'type' => 'string', 'example' => 'appstat.jvm.GcPsMarkSweepCount', 'backendName' => 'metricKey'], + 'groupId' => ['title' => '用户所选指标组的key', 'description' => '用户所选指标组的key', 'visibility' => 'Public', 'type' => 'string', 'example' => 'apm.jvm'."\n", 'backendName' => 'groupKey'], ], ], 'AlertRuleAlertMetricInputFilterValue' => [ 'description' => '过滤条件配置对象。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'opt' => [ - 'title' => '过滤条件操作符', - 'description' => '过滤条件操作符。', - 'type' => 'string', - 'required' => true, - 'example' => 'ALL', - ], - 'dim' => [ - 'title' => '过滤条件的维度', - 'description' => '过滤条件的维度。', - 'type' => 'string', - 'required' => true, - 'example' => 'rootIp', - ], - 'value' => [ - 'description' => '过滤条件值。', - 'type' => 'string', - 'example' => '127.0.0.1', - ], + 'opt' => ['title' => '过滤条件操作符', 'description' => '过滤条件操作符。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'ALL', 'backendName' => 'opt'], + 'dim' => ['title' => '过滤条件的维度', 'description' => '过滤条件的维度。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'rootIp', 'backendName' => 'dim'], + 'value' => ['description' => '过滤条件值。', 'visibility' => 'Public', 'type' => 'string', 'example' => '127.0.0.1', 'backendName' => 'value'], ], ], 'AlertRuleAlertMetricInputParamValue' => [ 'description' => '预定义指标参数配置对象', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '预定义指标参数名', - 'type' => 'string', - 'required' => true, - 'example' => 'paramName', - ], - 'value' => [ - 'description' => '预定义指标参数值', - 'type' => 'string', - 'required' => true, - 'example' => 'paramValue', - ], + 'name' => ['description' => '预定义指标参数名', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'paramName', 'backendName' => 'name'], + 'value' => ['description' => '预定义指标参数值', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'paramValue', 'backendName' => 'value'], ], ], 'AlertRuleAlertMetricParamDef' => [ 'description' => '告警规则告警指标参数定义对象', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'placeholderEn' => [ - 'title' => '仅对INPUT_PARAM有效。用于前端展示的英文展位符', - 'description' => '仅对INPUT_PARAM有效。用于前端展示的英文展位符', - 'type' => 'string', - 'example' => 'Enter value', - ], - 'placeholderCn' => [ - 'title' => '仅对INPUT_PARAM有效。用于前端展示的中文展位符', - 'description' => '仅对INPUT_PARAM有效。用于前端展示的中文展位符', - 'type' => 'string', - 'example' => '请输入值', - ], + 'placeholderEn' => ['title' => '仅对INPUT_PARAM有效。用于前端展示的英文展位符', 'description' => '仅对INPUT_PARAM有效。用于前端展示的英文展位符', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Enter value', 'backendName' => 'placeholderEn'], + 'placeholderCn' => ['title' => '仅对INPUT_PARAM有效。用于前端展示的中文展位符', 'description' => '仅对INPUT_PARAM有效。用于前端展示的中文展位符', 'visibility' => 'Public', 'type' => 'string', 'example' => '请输入值', 'backendName' => 'placeholderCn'], 'values' => [ 'title' => '仅对SELECT_PARAM有效。 下拉列表的可选值列表。', 'description' => '仅对SELECT_PARAM有效。 下拉列表的可选值列表。', + 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '对象值', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'labelCn' => [ - 'title' => '选项的中文显示名称', - 'description' => '选项的中文显示名称', - 'type' => 'string', - 'example' => '测试环境', - ], - 'labelEn' => [ - 'title' => '选项的英文显示名称', - 'description' => '选项的英文显示名称', - 'type' => 'string', - 'example' => 'Staging', - ], - 'value' => [ - 'description' => '值', - 'type' => 'string', - 'example' => 'staging', - ], + 'labelCn' => ['title' => '选项的中文显示名称', 'description' => '选项的中文显示名称', 'visibility' => 'Public', 'type' => 'string', 'example' => '测试环境', 'backendName' => 'labelCn'], + 'labelEn' => ['title' => '选项的英文显示名称', 'description' => '选项的英文显示名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Staging', 'backendName' => 'labelEn'], + 'value' => ['description' => '值', 'visibility' => 'Public', 'type' => 'string', 'example' => 'staging', 'backendName' => 'value'], ], + 'extendType' => 'true', ], + 'backendName' => 'values', + 'itemName' => 'value', ], - 'name' => [ - 'description' => '名称', - 'type' => 'string', - 'example' => 'env', - ], - 'minWidth' => [ - 'title' => '输入框的最小宽度，仅对SELECT_PARAM、INPUT_PARAM生效', - 'description' => '输入框的最小宽度，仅对SELECT_PARAM、INPUT_PARAM生效', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'type' => [ - 'title' => '● TEXT_PARAM: 只读文本参数，由后台定义，前端不显示用户输入控件'."\n" - .'● INPUT_PARAM：输入框参数'."\n" - .'● SELECT_PARAM：选择框参数', - 'description' => '● TEXT_PARAM: 只读文本参数，由后台定义，前端不显示用户输入控件'."\n" - .'● INPUT_PARAM：输入框参数'."\n" - .'● SELECT_PARAM：选择框参数', - 'type' => 'string', - 'example' => 'TEXT_PARAM', - ], - 'value' => [ - 'description' => '值', - 'type' => 'string', - 'example' => 'staging', - ], - 'maxWidth' => [ - 'title' => '输入框的最大宽度，仅对SELECT_PARAM、INPUT_PARAM生效', - 'description' => '输入框的最大宽度，仅对SELECT_PARAM、INPUT_PARAM生效', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'name' => ['description' => '名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'env', 'backendName' => 'name'], + 'minWidth' => ['title' => '输入框的最小宽度，仅对SELECT_PARAM、INPUT_PARAM生效', 'description' => '输入框的最小宽度，仅对SELECT_PARAM、INPUT_PARAM生效', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'backendName' => 'minWidth'], + 'type' => ['title' => '● TEXT_PARAM: 只读文本参数，由后台定义，前端不显示用户输入控件'."\n" + .'● INPUT_PARAM：输入框参数'."\n" + .'● SELECT_PARAM：选择框参数', 'description' => '● TEXT_PARAM: 只读文本参数，由后台定义，前端不显示用户输入控件'."\n" + .'● INPUT_PARAM：输入框参数'."\n" + .'● SELECT_PARAM：选择框参数', 'visibility' => 'Public', 'type' => 'string', 'example' => 'TEXT_PARAM', 'backendName' => 'type'], + 'value' => ['description' => '值', 'visibility' => 'Public', 'type' => 'string', 'example' => 'staging', 'backendName' => 'value'], + 'maxWidth' => ['title' => '输入框的最大宽度，仅对SELECT_PARAM、INPUT_PARAM生效', 'description' => '输入框的最大宽度，仅对SELECT_PARAM、INPUT_PARAM生效', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'backendName' => 'maxWidth'], ], ], 'AlertRuleAlertMetricParamDef_array' => [ 'description' => '告警规则告警指标参数定义对象列表', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '告警规则告警指标参数定义对象', - '$ref' => '#/components/schemas/AlertRuleAlertMetricParamDef', - ], + 'items' => ['description' => '告警规则告警指标参数定义对象', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/AlertRuleAlertMetricParamDef'], ], 'AlertRuleCondition' => [ 'description' => '告警规则条件配置。 该配置对象所包含的字段取决于条件类型(type字段)，不同的条件类型适用的字段不同。', 'type' => 'object', 'properties' => [ - 'alertCount' => [ - 'title' => '告警触发次数，满足多少次条件后才告警。仅对SLS_CONDITION有效 ', - 'description' => '适用条件类型：SLS_CONDITION'."\n" - ."\n" - .'满足条件几次后告警，默认为1', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'pattern' => '', - 'default' => '1', - ], + 'alertCount' => ['title' => '告警触发次数，满足多少次条件后才告警。仅对SLS_CONDITION有效 ', 'description' => '适用条件类型：SLS_CONDITION'."\n" + ."\n" + .'满足条件几次后告警，默认为1', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'pattern' => '', 'default' => '1'], 'caseList' => [ 'title' => '告警条件分支列表，仅对SLS_CONDITION生效', 'description' => '适用条件类型： SLS_CONDITION。'."\n" @@ -900,28 +469,13 @@ 'description' => 'SLS告警条件对象', 'type' => 'object', 'properties' => [ - 'condition' => [ - 'title' => '匹配表达式，示例： logLevel: error', - 'description' => '匹配表达式，示例： logLevel: error', - 'type' => 'string', - 'example' => 'logLevel: error', - ], - 'countCondition' => [ - 'title' => '数量匹配表达式，示例：'."\n" - .'区间组合： __count__ >= 3 && __count__ <= 10'."\n" - .'单区间： __count__ >= 3', - 'description' => '数量匹配表达式，示例：'."\n" - .'区间组合： __count__ >= 3 && __count__ <= 10'."\n" - .'单区间： __count__ >= 3', - 'type' => 'string', - 'example' => 'count >= 3', - ], - 'level' => [ - 'title' => '满足条件后的告警级别', - 'description' => '满足条件后的告警级别', - 'type' => 'string', - 'example' => 'INFO', - ], + 'condition' => ['title' => '匹配表达式，示例： logLevel: error', 'description' => '匹配表达式，示例： logLevel: error', 'type' => 'string', 'example' => 'logLevel: error'], + 'countCondition' => ['title' => '数量匹配表达式，示例：'."\n" + .'区间组合： __count__ >= 3 && __count__ <= 10'."\n" + .'单区间： __count__ >= 3', 'description' => '数量匹配表达式，示例：'."\n" + .'区间组合： __count__ >= 3 && __count__ <= 10'."\n" + .'单区间： __count__ >= 3', 'type' => 'string', 'example' => 'count >= 3'], + 'level' => ['title' => '满足条件后的告警级别', 'description' => '满足条件后的告警级别', 'type' => 'string', 'example' => 'INFO'], 'type' => [ 'title' => '匹配类型： 有数据/有特定条数据/有数据匹配/有特定条数匹配。'."\n" .'有数据--HasData: condition和countCondition都是空'."\n" @@ -937,12 +491,7 @@ .'- HasDataMatchCount：有特定条数匹配', 'type' => 'string', 'example' => 'HasData', - 'enum' => [ - 'HasData', - 'HasDataCount', - 'HasDataMatch', - 'HasDataMatchCount', - ], + 'enum' => ['HasData', 'HasDataCount', 'HasDataMatch', 'HasDataMatchCount'], ], ], ], @@ -978,16 +527,7 @@ .'- p95'."\n" .'- p99', 'type' => 'string', - 'enumValueTitles' => [ - 'p99' => 'p99', - 'avg' => 'avg', - 'min' => 'min', - 'max' => 'max', - 'p90' => 'p90', - 'count' => 'count', - 'sum' => 'sum', - 'p95' => 'p95', - ], + 'enumValueTitles' => ['p99' => 'p99', 'avg' => 'avg', 'min' => 'min', 'max' => 'max', 'p90' => 'p90', 'count' => 'count', 'sum' => 'sum', 'p95' => 'p95'], 'example' => 'count', ], 'oper' => [ @@ -1011,25 +551,10 @@ .'- 同比增加 YOY_UP'."\n" .'- 同比减少 YOY_DOWN', 'type' => 'string', - 'enumValueTitles' => [ - 'YOY_DOWN' => 'YOY_DOWN', - 'YOY_UP' => 'YOY_UP', - 'NE' => 'NE', - 'LT' => 'LT', - 'GTE' => 'GTE', - 'LTE' => 'LTE', - 'EQ' => 'EQ', - 'GT' => 'GT', - ], + 'enumValueTitles' => ['YOY_DOWN' => 'YOY_DOWN', 'YOY_UP' => 'YOY_UP', 'NE' => 'NE', 'LT' => 'LT', 'GTE' => 'GTE', 'LTE' => 'LTE', 'EQ' => 'EQ', 'GT' => 'GT'], 'example' => 'GT', ], - 'value' => [ - 'title' => '对比的阈值', - 'description' => '对比的阈值', - 'type' => 'number', - 'format' => 'double', - 'example' => '50', - ], + 'value' => ['title' => '对比的阈值', 'description' => '对比的阈值', 'type' => 'number', 'format' => 'double', 'example' => '50'], 'valueLevelList' => [ 'title' => '不同值的报警级别，在多级level场景使用', 'description' => '不同值的报警级别的列表。', @@ -1038,92 +563,39 @@ 'description' => '不同值的报警级别，在多级level场景使用', 'type' => 'object', 'properties' => [ - 'level' => [ - 'title' => '阈值对应的级别', - 'description' => '阈值对应的级别', - 'type' => 'string', - 'example' => 'INFO', - ], - 'value' => [ - 'title' => '对比的阈值', - 'description' => '对比的阈值', - 'type' => 'number', - 'format' => 'double', - 'example' => '120', - ], + 'level' => ['title' => '阈值对应的级别', 'description' => '阈值对应的级别', 'type' => 'string', 'example' => 'INFO'], + 'value' => ['title' => '对比的阈值', 'description' => '对比的阈值', 'type' => 'number', 'format' => 'double', 'example' => '120'], ], ], ], - 'yoyTimeUnit' => [ - 'title' => '同比时间单位（仅对oper=YOY_UP/YOY_DOWN生效）'."\n" - .' minute、hour、day、week、month', - 'description' => '同比时间单位（仅对oper=YOY_UP/YOY_DOWN生效）'."\n" - .' minute、hour、day、week、month', - 'type' => 'string', - 'example' => 'month', - ], - 'yoyTimeValue' => [ - 'title' => '同比时间的值，与yoyTimeUnit配合使用', - 'description' => '同比时间的值，与yoyTimeUnit配合使用', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'baseUnit' => [ - 'title' => '数据单位', - 'description' => '数据单位', - 'type' => 'string', - 'example' => '%', - ], - 'displayUnit' => [ - 'title' => '展示单位', - 'description' => '展示单位', - 'type' => 'string', - 'example' => '%', - ], + 'yoyTimeUnit' => ['title' => '同比时间单位（仅对oper=YOY_UP/YOY_DOWN生效）'."\n" + .' minute、hour、day、week、month', 'description' => '同比时间单位（仅对oper=YOY_UP/YOY_DOWN生效）'."\n" + .' minute、hour、day、week、month', 'type' => 'string', 'example' => 'month'], + 'yoyTimeValue' => ['title' => '同比时间的值，与yoyTimeUnit配合使用', 'description' => '同比时间的值，与yoyTimeUnit配合使用', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'baseUnit' => ['title' => '数据单位', 'description' => '数据单位', 'type' => 'string', 'example' => '%'], + 'displayUnit' => ['title' => '展示单位', 'description' => '展示单位', 'type' => 'string', 'example' => '%'], ], ], ], - 'noDataAppendValue' => [ - 'title' => '无数据时补偿的值。 仅对APM_CONDITION有效', - 'description' => '适用条件类型：APM_CONDITION。'."\n" - ."\n" - .'无数据时补偿的值。', - 'type' => 'string', - 'example' => '1', - ], - 'noDataAlertLevel' => [ - 'title' => '无数据告警级别。 ', - 'description' => '适用条件类型：APM_CONDITION。'."\n" - ."\n" - .'无数据时的告警级别，不指定则不对无数据报警', - 'type' => 'string', - 'example' => 'INFO', - 'pattern' => '', - 'default' => '', - ], + 'noDataAppendValue' => ['title' => '无数据时补偿的值。 仅对APM_CONDITION有效', 'description' => '适用条件类型：APM_CONDITION。'."\n" + ."\n" + .'无数据时补偿的值。', 'type' => 'string', 'example' => '1'], + 'noDataAlertLevel' => ['title' => '无数据告警级别。 ', 'description' => '适用条件类型：APM_CONDITION。'."\n" + ."\n" + .'无数据时的告警级别，不指定则不对无数据报警', 'type' => 'string', 'example' => 'INFO', 'pattern' => '', 'default' => ''], 'type' => [ - 'title' => '条件类型。 SLS_CONDITION/APM_CONDITION/CMS_BASIC_CONDITION', + 'title' => '条件类型。 SLS_CONDITION/APM_CONDITION/CMS_BASIC_CONDITION/PROMETHEUS_MULTI_CONDITION/BASIC_CONDITION/LOG_SET_CONDITION', 'description' => '规则条件类型，取值范围：'."\n" .'- SLS_CONDITION(SLS告警条件)'."\n" .'- APM_CONDITION(APM告警条件)'."\n" .'- CMS_BASIC_CONDITION(基础云监控告警条件)', 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'SLS_CONDITION' => 'SLS告警条件', - 'CMS_BASIC_CONDITION' => '基础云监控告警条件', - 'APM_CONDITION' => 'APM告警条件', - ], + 'enumValueTitles' => ['SLS_CONDITION' => 'SLS告警条件', 'CMS_BASIC_CONDITION' => '基础云监控告警条件', 'APM_CONDITION' => 'APM告警条件'], 'example' => 'SLS_CONDITION', 'pattern' => '', 'default' => 'SLS_CONDITION', - 'enum' => [ - 'SLS_CONDITION', - 'APM_CONDITION', - 'CMS_BASIC_CONDITION', - 'BASIC_CONDITION', - ], + 'enum' => ['SLS_CONDITION', 'APM_CONDITION', 'CMS_BASIC_CONDITION', 'PROMETHEUS_MULTI_CONDITION', 'BASIC_CONDITION', 'LOG_SET_CONDITION', 'UMODEL_METRICSET_MULTI_CONDITION'], ], 'relation' => [ 'title' => '仅对APM_CONDITION有效，多个条件之间的逻辑关系。'."\n" @@ -1134,28 +606,20 @@ .'- and'."\n" .'- or', 'type' => 'string', - 'enumValueTitles' => [ - 'or' => '或', - 'and' => '且', - ], + 'enumValueTitles' => ['or' => '或', 'and' => '且'], 'example' => 'and', ], - 'escalationType' => [ - 'title' => '仅对CMS_BASIC_CONDITION有效。'."\n" - .'取值范围: '."\n" - .'simple: 简单指标条件'."\n" - .'composite: 组合指标条件'."\n" - .'express: 表达式条件', - 'description' => '适用条件类型：CMS_BASIC_CONDITION'."\n" - ."\n\n" - .'取值范围: '."\n" - ."\n" - .'- simple: 简单指标条件'."\n" - .'- composite: 组合指标条件'."\n" - .'- express: 表达式条件', - 'type' => 'string', - 'example' => 'simple', - ], + 'escalationType' => ['title' => '仅对CMS_BASIC_CONDITION有效。'."\n" + .'取值范围: '."\n" + .'simple: 简单指标条件'."\n" + .'composite: 组合指标条件'."\n" + .'express: 表达式条件', 'description' => '适用条件类型：CMS_BASIC_CONDITION'."\n" + ."\n\n" + .'取值范围: '."\n" + ."\n" + .'- simple: 简单指标条件'."\n" + .'- composite: 组合指标条件'."\n" + .'- express: 表达式条件', 'type' => 'string', 'example' => 'simple'], 'simpleEscalation' => [ 'title' => '仅对CMS_BASIC_CONDITION且escalationType=simple时有效，仅针对单一指标设置告警条件', 'description' => '适用条件类型：CMS_BASIC_CONDITION。'."\n" @@ -1163,21 +627,10 @@ .'仅当escalationType=simple时有效，针对单一指标设置的告警条件', 'type' => 'object', 'properties' => [ - 'metricName' => [ - 'title' => '告警条件关联的指标', - 'description' => '适用条件类型：CMS_BASIC_CONDITION。'."\n" - ."\n" - .'告警条件关联的指标', - 'type' => 'string', - 'example' => 'cpu_total', - ], - 'period' => [ - 'title' => '指标的时间窗口，单位秒', - 'description' => '指标的时间窗口，单位秒', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '60', - ], + 'metricName' => ['title' => '告警条件关联的指标', 'description' => '适用条件类型：CMS_BASIC_CONDITION。'."\n" + ."\n" + .'告警条件关联的指标', 'type' => 'string', 'example' => 'cpu_total'], + 'period' => ['title' => '指标的时间窗口，单位秒', 'description' => '指标的时间窗口，单位秒', 'type' => 'integer', 'format' => 'int64', 'example' => '60'], 'escalations' => [ 'title' => '条件列表，同一个告警规则对应多个级别的，每一个级别会有一个条件对象。', 'description' => '条件列表，同一个告警规则对应多个级别的，每一个级别会有一个条件对象。', @@ -1194,64 +647,38 @@ .'- WARNING'."\n" .'- INFO', 'type' => 'string', - 'enumValueTitles' => [ - 'INFO' => 'INFO', - 'WARNING' => 'WARNING', - 'CRITICAL' => 'CRITICAL', - ], + 'enumValueTitles' => ['INFO' => 'INFO', 'WARNING' => 'WARNING', 'CRITICAL' => 'CRITICAL'], 'example' => 'INFO', ], - 'comparisonOperator' => [ - 'title' => ' 阈值比较符，取值范围：'."\n" - .' ■ GreaterThanOrEqualToThreshold：大于等于。'."\n" - .' ■ GreaterThanThreshold：大于。'."\n" - .' ■ LessThanOrEqualToThreshold：小于等于。'."\n" - .' ■ LessThanThreshold：小于。'."\n" - .' ■ NotEqualToThreshold：不等于。'."\n" - .' ■ EqualToThreshold：等于。'."\n" - .' ■ GreaterThanYesterday：同比昨天时间上涨。'."\n" - .' ■ LessThanYesterday：同比昨天时间下降。'."\n" - .' ■ GreaterThanLastWeek：同比上周同一时间上涨。'."\n" - .' ■ LessThanLastWeek：同比上周同一时间下降。'."\n" - .' ■ GreaterThanLastPeriod：环比上周期上涨。'."\n" - .' ■ LessThanLastPeriod：环比上周期下降。', - 'description' => '阈值比较符，取值范围：'."\n" - ."\n" - .'- GreaterThanOrEqualToThreshold：大于等于。'."\n" - .'- GreaterThanThreshold：大于。'."\n" - .'- LessThanOrEqualToThreshold：小于等于。'."\n" - .'- LessThanThreshold：小于。'."\n" - .'- NotEqualToThreshold：不等于。'."\n" - .'- EqualToThreshold：等于。'."\n" - .'- GreaterThanYesterday：同比昨天时间上涨。'."\n" - .'- LessThanYesterday：同比昨天时间下降。'."\n" - .'- GreaterThanLastWeek：同比上周同一时间上涨。'."\n" - .'- LessThanLastWeek：同比上周同一时间下降。'."\n" - .'- GreaterThanLastPeriod：环比上周期上涨。'."\n" - .'- LessThanLastPeriod：环比上周期下降。', - 'type' => 'string', - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'statistics' => [ - 'title' => '统计方法，该参数的取值由指定云产品的MetricName对应的Statistics列决定，例如：Maximum、Minimum 和 Average', - 'description' => '统计方法，该参数的取值由指定云产品的MetricName对应的Statistics列决定，例如：Maximum、Minimum 和 Average', - 'type' => 'string', - 'example' => 'Average', - ], - 'times' => [ - 'title' => '触发告警需满足条件的次数', - 'description' => '触发告警需满足条件的次数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'threshold' => [ - 'title' => '告警阈值', - 'description' => '告警阈值', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], + 'comparisonOperator' => ['title' => ' 阈值比较符，取值范围：'."\n" + .' ■ GreaterThanOrEqualToThreshold：大于等于。'."\n" + .' ■ GreaterThanThreshold：大于。'."\n" + .' ■ LessThanOrEqualToThreshold：小于等于。'."\n" + .' ■ LessThanThreshold：小于。'."\n" + .' ■ NotEqualToThreshold：不等于。'."\n" + .' ■ EqualToThreshold：等于。'."\n" + .' ■ GreaterThanYesterday：同比昨天时间上涨。'."\n" + .' ■ LessThanYesterday：同比昨天时间下降。'."\n" + .' ■ GreaterThanLastWeek：同比上周同一时间上涨。'."\n" + .' ■ LessThanLastWeek：同比上周同一时间下降。'."\n" + .' ■ GreaterThanLastPeriod：环比上周期上涨。'."\n" + .' ■ LessThanLastPeriod：环比上周期下降。', 'description' => '阈值比较符，取值范围：'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold：大于等于。'."\n" + .'- GreaterThanThreshold：大于。'."\n" + .'- LessThanOrEqualToThreshold：小于等于。'."\n" + .'- LessThanThreshold：小于。'."\n" + .'- NotEqualToThreshold：不等于。'."\n" + .'- EqualToThreshold：等于。'."\n" + .'- GreaterThanYesterday：同比昨天时间上涨。'."\n" + .'- LessThanYesterday：同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek：同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek：同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod：环比上周期上涨。'."\n" + .'- LessThanLastPeriod：环比上周期下降。', 'type' => 'string', 'example' => 'GreaterThanOrEqualToThreshold'], + 'statistics' => ['title' => '统计方法，该参数的取值由指定云产品的MetricName对应的Statistics列决定，例如：Maximum、Minimum 和 Average', 'description' => '统计方法，该参数的取值由指定云产品的MetricName对应的Statistics列决定，例如：Maximum、Minimum 和 Average', 'type' => 'string', 'example' => 'Average'], + 'times' => ['title' => '触发告警需满足条件的次数', 'description' => '触发告警需满足条件的次数', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'threshold' => ['title' => '告警阈值', 'description' => '告警阈值', 'type' => 'number', 'format' => 'double', 'example' => '100'], ], ], ], @@ -1268,25 +695,11 @@ 'title' => '多个指标条件之间的关系，取值为and或or', 'description' => '多个指标条件之间的关系，取值为and或or', 'type' => 'string', - 'enumValueTitles' => [ - 'or' => 'or', - 'and' => 'and', - ], + 'enumValueTitles' => ['or' => 'or', 'and' => 'and'], 'example' => 'and', ], - 'level' => [ - 'title' => '满足条件时触发的告警级别(多指标组合告警仅支持一个级别)', - 'description' => '满足条件时触发的告警级别(多指标组合告警仅支持一个级别)', - 'type' => 'string', - 'example' => 'INFO', - ], - 'times' => [ - 'title' => '触发告警需满足条件的次数', - 'description' => '触发告警需满足条件的次数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], + 'level' => ['title' => '满足条件时触发的告警级别(多指标组合告警仅支持一个级别)', 'description' => '满足条件时触发的告警级别(多指标组合告警仅支持一个级别)', 'type' => 'string', 'example' => 'INFO'], + 'times' => ['title' => '触发告警需满足条件的次数', 'description' => '触发告警需满足条件的次数', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], 'escalations' => [ 'title' => '多指标的组合条件列表', 'description' => '多指标的组合条件列表', @@ -1295,75 +708,48 @@ 'description' => '条件对象', 'type' => 'object', 'properties' => [ - 'comparisonOperator' => [ - 'title' => '阈值比较符，取值范围：'."\n" - .' ■ GreaterThanOrEqualToThreshold：大于等于。'."\n" - .' ■ GreaterThanThreshold：大于。'."\n" - .' ■ LessThanOrEqualToThreshold：小于等于。'."\n" - .' ■ LessThanThreshold：小于。'."\n" - .' ■ NotEqualToThreshold：不等于。'."\n" - .' ■ EqualToThreshold：等于。'."\n" - .' ■ GreaterThanYesterday：同比昨天时间上涨。'."\n" - .' ■ LessThanYesterday：同比昨天时间下降。'."\n" - .' ■ GreaterThanLastWeek：同比上周同一时间上涨。'."\n" - .' ■ LessThanLastWeek：同比上周同一时间下降。'."\n" - .' ■ GreaterThanLastPeriod：环比上周期上涨。'."\n" - .' ■ LessThanLastPeriod：环比上周期下降。', - 'description' => '阈值比较符，取值范围：'."\n" - ."\n" - .'- GreaterThanOrEqualToThreshold：大于等于。'."\n" - .'- GreaterThanThreshold：大于。'."\n" - .'- LessThanOrEqualToThreshold：小于等于。'."\n" - .'- LessThanThreshold：小于。'."\n" - .'- NotEqualToThreshold：不等于。'."\n" - .'- EqualToThreshold：等于。'."\n" - .'- GreaterThanYesterday：同比昨天时间上涨。'."\n" - .'- LessThanYesterday：同比昨天时间下降。'."\n" - .'- GreaterThanLastWeek：同比上周同一时间上涨。'."\n" - .'- LessThanLastWeek：同比上周同一时间下降。'."\n" - .'- GreaterThanLastPeriod：环比上周期上涨。'."\n" - .'- LessThanLastPeriod：环比上周期下降。', - 'type' => 'string', - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'metricName' => [ - 'title' => '指标名称', - 'description' => '指标名称', - 'type' => 'string', - 'example' => 'cpu_total', - ], - 'period' => [ - 'title' => '指标的时间窗口', - 'description' => '指标的时间窗口', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '60', - ], - 'statistics' => [ - 'title' => '统计方法，该参数的取值由指定云产品的MetricName对应的Statistics列决定。 监控项的统计方法。取值示例：'."\n" - .' ■ $Maximum：最大值。'."\n" - .' ■ $Minimum：最小值。'."\n" - .' ■ $Average：平均值。'."\n" - .' ■ $Availability：可用率（通常用于站点监控）'."\n" - .'说明 $为监控项的统一前缀符号。', - 'description' => '统计方法，该参数的取值由指定云产品的MetricName对应的Statistics列决定。 监控项的统计方法。取值示例：'."\n" - ."\n" - .'- $Maximum：最大值。'."\n" - .'- $Minimum：最小值。'."\n" - .'- $Average：平均值。'."\n" - .'- $Availability：可用率（通常用于站点监控）'."\n" - ."\n" - .'说明 $为监控项的统一前缀符号。', - 'type' => 'string', - 'example' => '$Maximum', - ], - 'threshold' => [ - 'title' => '告警阈值', - 'description' => '告警阈值', - 'type' => 'number', - 'format' => 'double', - 'example' => '50', - ], + 'comparisonOperator' => ['title' => '阈值比较符，取值范围：'."\n" + .' ■ GreaterThanOrEqualToThreshold：大于等于。'."\n" + .' ■ GreaterThanThreshold：大于。'."\n" + .' ■ LessThanOrEqualToThreshold：小于等于。'."\n" + .' ■ LessThanThreshold：小于。'."\n" + .' ■ NotEqualToThreshold：不等于。'."\n" + .' ■ EqualToThreshold：等于。'."\n" + .' ■ GreaterThanYesterday：同比昨天时间上涨。'."\n" + .' ■ LessThanYesterday：同比昨天时间下降。'."\n" + .' ■ GreaterThanLastWeek：同比上周同一时间上涨。'."\n" + .' ■ LessThanLastWeek：同比上周同一时间下降。'."\n" + .' ■ GreaterThanLastPeriod：环比上周期上涨。'."\n" + .' ■ LessThanLastPeriod：环比上周期下降。', 'description' => '阈值比较符，取值范围：'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold：大于等于。'."\n" + .'- GreaterThanThreshold：大于。'."\n" + .'- LessThanOrEqualToThreshold：小于等于。'."\n" + .'- LessThanThreshold：小于。'."\n" + .'- NotEqualToThreshold：不等于。'."\n" + .'- EqualToThreshold：等于。'."\n" + .'- GreaterThanYesterday：同比昨天时间上涨。'."\n" + .'- LessThanYesterday：同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek：同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek：同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod：环比上周期上涨。'."\n" + .'- LessThanLastPeriod：环比上周期下降。', 'type' => 'string', 'example' => 'GreaterThanOrEqualToThreshold'], + 'metricName' => ['title' => '指标名称', 'description' => '指标名称', 'type' => 'string', 'example' => 'cpu_total'], + 'period' => ['title' => '指标的时间窗口', 'description' => '指标的时间窗口', 'type' => 'integer', 'format' => 'int64', 'example' => '60'], + 'statistics' => ['title' => '统计方法，该参数的取值由指定云产品的MetricName对应的Statistics列决定。 监控项的统计方法。取值示例：'."\n" + .' ■ $Maximum：最大值。'."\n" + .' ■ $Minimum：最小值。'."\n" + .' ■ $Average：平均值。'."\n" + .' ■ $Availability：可用率（通常用于站点监控）'."\n" + .'说明 $为监控项的统一前缀符号。', 'description' => '统计方法，该参数的取值由指定云产品的MetricName对应的Statistics列决定。 监控项的统计方法。取值示例：'."\n" + ."\n" + .'- $Maximum：最大值。'."\n" + .'- $Minimum：最小值。'."\n" + .'- $Average：平均值。'."\n" + .'- $Availability：可用率（通常用于站点监控）'."\n" + ."\n" + .'说明 $为监控项的统一前缀符号。', 'type' => 'string', 'example' => '$Maximum'], + 'threshold' => ['title' => '告警阈值', 'description' => '告警阈值', 'type' => 'number', 'format' => 'double', 'example' => '50'], ], ], ], @@ -1376,28 +762,13 @@ .'escalationType=composite时有效，多指标组合告警条件。', 'type' => 'object', 'properties' => [ - 'level' => [ - 'title' => '满足条件时触发的告警级别(表达式告警仅支持一个级别)', - 'description' => '满足条件时触发的告警级别(表达式告警仅支持一个级别)'."\n" - ."\n" - .'- CRITICAL'."\n" - .'- WARNING'."\n" - .'- INFO', - 'type' => 'string', - 'example' => 'INFO', - ], - 'times' => [ - 'description' => '触发告警需满足条件的次数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'rawExpression' => [ - 'title' => '告警条件表达式', - 'description' => '告警条件表达式', - 'type' => 'string', - 'example' => '@cpu_total[60].$Average > 60', - ], + 'level' => ['title' => '满足条件时触发的告警级别(表达式告警仅支持一个级别)', 'description' => '满足条件时触发的告警级别(表达式告警仅支持一个级别)'."\n" + ."\n" + .'- CRITICAL'."\n" + .'- WARNING'."\n" + .'- INFO', 'type' => 'string', 'example' => 'INFO'], + 'times' => ['description' => '触发告警需满足条件的次数', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'rawExpression' => ['title' => '告警条件表达式', 'description' => '告警条件表达式', 'type' => 'string', 'example' => '@cpu_total[60].$Average > 60'], ], ], 'noDataPolicy' => [ @@ -1413,33 +784,78 @@ .'- INSUFFICIENT_DATA：报警内容为无数据。'."\n" .'- OK：正常。', 'type' => 'string', - 'enumValueTitles' => [ - 'KEEP_LAST_STATE' => '不做任何处理', - 'INSUFFICIENT_DATA' => '报警内容为无数据', - 'OK' => '视为正常', - ], + 'enumValueTitles' => ['KEEP_LAST_STATE' => '不做任何处理', 'INSUFFICIENT_DATA' => '报警内容为无数据', 'OK' => '视为正常'], 'example' => 'KEEP_LAST_STATE', ], - 'oper' => [ - 'description' => '比较操作，判断是否是同比、环比'."\n" - ."\n" - .'- 大于 GT'."\n" - .'- 大于等于 GTE'."\n" - .'- 小于 LT'."\n" - .'- 小于等于 LTE'."\n" - .'- 等于 EQ'."\n" - .'- 不等于 NE'."\n" - .'- 同比增加 YOY_UP'."\n" - .'- 同比减少 YOY_DOWN', - 'type' => 'string', - 'example' => 'LT', + 'oper' => ['description' => '比较操作，判断是否是同比、环比'."\n" + ."\n" + .'- 大于 GT'."\n" + .'- 大于等于 GTE'."\n" + .'- 小于 LT'."\n" + .'- 小于等于 LTE'."\n" + .'- 等于 EQ'."\n" + .'- 不等于 NE'."\n" + .'- 同比增加 YOY_UP'."\n" + .'- 同比减少 YOY_DOWN', 'type' => 'string', 'example' => 'LT', 'title' => '比较操作符。type=BASIC_CONDITION时使用符号：>/>=/</<=/=/(=)/!=/PRESENT/NOT_PRESENT'], + 'value' => ['description' => '告警触发的阈值', 'type' => 'number', 'format' => 'double', 'example' => '60', 'title' => 'type=BASIC_CONDITION且oper为GT/GE/LT/LE/EQ/NE/PRESENT/NOT_PRESENT时指定的阈值'], + 'min' => ['title' => 'type=BASIC_CONDITION且oper=IN_RANGE/OUT_OF_RANGE时指定的区间下界', 'type' => 'number', 'format' => 'double'], + 'max' => ['title' => 'type=BASIC_CONDITION且oper=IN_RANGE/OUT_OF_RANGE时指定的区间上界', 'type' => 'number', 'format' => 'double'], + 'matchField' => ['title' => 'type=LOG_SET_CONDITION且matchOperator=CONTAINS/EQUALS/REGEX时指定，日志字段名', 'type' => 'string'], + 'matchOperator' => [ + 'title' => 'type=LOG_SET_CONDITION时指定，匹配操作符：PRESENT / NOT_PRESENT / CONTAINS / EQUALS / REGEX', + 'type' => 'string', + 'enum' => ['PRESENT', 'NOT_PRESENT', 'CONTAINS', 'EQUALS', 'REGEX'], + ], + 'matchValue' => ['title' => 'type=LOG_SET_CONDITION且matchOperator=CONTAINS/EQUALS/REGEX时指定，匹配值', 'type' => 'string'], + 'countOperator' => [ + 'title' => 'type=LOG_SET_CONDITION时指定，数量比较操作符：GTE / GT / EQ / LTE / LT', + 'type' => 'string', + 'enum' => ['GTE', 'GT', 'EQ', 'LTE', 'LT'], + ], + 'countThreshold' => ['title' => 'type=LOG_SET_CONDITION时指定，数量阈值', 'type' => 'integer', 'format' => 'int64'], + 'thresholdList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'severity' => ['title' => '严重等级', 'type' => 'string'], + 'threshold' => ['title' => '阈值（非区间算子时必填）', 'type' => 'number', 'format' => 'double'], + 'min' => ['title' => '区间下界（operator=IN_RANGE/OUT_OF_RANGE时必填）', 'type' => 'number', 'format' => 'double'], + 'max' => ['title' => '区间上界（operator=IN_RANGE/OUT_OF_RANGE时必填）', 'type' => 'number', 'format' => 'double'], + ], + ], ], - 'value' => [ - 'description' => '告警触发的阈值', - 'type' => 'number', - 'format' => 'double', - 'example' => '60', + 'triggers' => [ + 'title' => 'type=UMODEL_METRICSET_MULTI_CONDITION 时指定，触发条件列表；每项含 severity、durationSecs 与表达式（SIMPLE 单指标 / COMPOSITE 多指标 AND/OR/UNLESS）', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'severity' => ['type' => 'string'], + 'durationSecs' => ['type' => 'integer', 'format' => 'int32'], + 'expression' => [ + 'type' => 'object', + 'properties' => [ + 'expressionType' => ['type' => 'string'], + 'logicOperator' => ['type' => 'string'], + 'conditions' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'expressionType' => ['type' => 'string'], + 'queryName' => ['type' => 'string'], + 'operator' => ['type' => 'string'], + 'threshold' => ['type' => 'number', 'format' => 'double'], + ], + ], + ], + ], + ], + ], + ], ], + 'enableSeveritySuppression' => ['title' => 'type=UMODEL_METRICSET_MULTI_CONDITION 时使用，是否启用 severity 就高抑制；默认 true，同一实体仅上报最高级别触发', 'type' => 'boolean'], ], ], 'AlertRuleDataSource' => [ @@ -1455,24 +871,9 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'project' => [ - 'title' => 'sls project', - 'description' => 'SLS project。', - 'type' => 'string', - 'example' => 'mySlsProject', - ], - 'regionId' => [ - 'title' => 'sls project所在的region', - 'description' => 'SLS project所在的region', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'store' => [ - 'title' => 'log/metric store名称', - 'description' => 'LogStore/MetricStore名称', - 'type' => 'string', - 'example' => 'mySlsLogStore', - ], + 'project' => ['title' => 'sls project', 'description' => 'SLS project。', 'type' => 'string', 'example' => 'mySlsProject'], + 'regionId' => ['title' => 'sls project所在的region', 'description' => 'SLS project所在的region', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'store' => ['title' => 'log/metric store名称', 'description' => 'LogStore/MetricStore名称', 'type' => 'string', 'example' => 'mySlsLogStore'], 'type' => [ 'title' => 'sls数据子源的类型：'."\n" .'SLS_LOG_DS: log store数据源'."\n" @@ -1483,32 +884,18 @@ 'type' => 'string', 'example' => 'SLS_LOG_DS', 'default' => 'SLS_LOG_DS', - 'enum' => [ - 'SLS_LOG_DS', - 'SLS_METRIC_DS', - ], + 'enum' => ['SLS_LOG_DS', 'SLS_METRIC_DS'], ], ], + 'description' => '', ], ], - 'instanceId' => [ - 'title' => 'type=PROMETHUES_DS时需指定prometheus实例id', - 'description' => '适用数据源类型：PROMETHEUS_DS'."\n" - ."\n" - .'prometheus实例ID', - 'type' => 'string', - 'example' => 'rw-bbe8961b4a59be0', - 'pattern' => '', - 'default' => '', - ], - 'namespace' => [ - 'title' => 'type=ENTERPRISE_DS时需指定，企业云监控指标仓库的名称', - 'description' => '适用数据源类型：ENTERPRISE_DS'."\n" - ."\n" - .'企业云监控指标仓库的名称。', - 'type' => 'string', - 'example' => 'aliyun-default', - ], + 'instanceId' => ['title' => 'type=PROMETHUES_DS时需指定prometheus实例id', 'description' => '适用数据源类型：PROMETHEUS_DS'."\n" + ."\n" + .'prometheus实例ID', 'type' => 'string', 'example' => 'rw-bbe8961b4a59be0', 'pattern' => '', 'default' => ''], + 'namespace' => ['title' => 'type=ENTERPRISE_DS时需指定，企业云监控指标仓库的名称', 'description' => '适用数据源类型：ENTERPRISE_DS'."\n" + ."\n" + .'企业云监控指标仓库的名称。', 'type' => 'string', 'example' => 'aliyun-default'], 'type' => [ 'title' => '数据源类型:'."\n" .'ENTERPRISE_DS： 企业云监控数据源'."\n" @@ -1526,37 +913,18 @@ .'- ENTERPRISE_DS：企业云监控数据源', 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'CMS_BASIC_DS' => '基础云监控数据源', - 'APM_DS' => '应用监控数据源', - 'ENTERPRISE_DS' => '企业云监控数据源', - 'SLS_MULTI_DS' => 'SLS数据源', - 'PROMETHEUS_DS' => 'Prometheus数据源', - ], + 'enumValueTitles' => ['CMS_BASIC_DS' => '基础云监控数据源', 'APM_DS' => '应用监控数据源', 'ENTERPRISE_DS' => '企业云监控数据源', 'SLS_MULTI_DS' => 'SLS数据源', 'PROMETHEUS_DS' => 'Prometheus数据源'], 'example' => 'PROMETHEUS_DS', 'pattern' => '', 'default' => '', - 'enum' => [ - 'ENTERPRISE_DS', - 'PROMETHEUS_DS', - 'SLS_MULTI_DS', - 'APM_DS', - 'CMS_BASIC_DS', - 'ENTITY_DS', - 'VIRTUAL_PROMETHEUS_DS', - ], - ], - 'regionId' => [ - 'title' => '数据源所属的regionId。'."\n" - .'对APM_DS，指应用所属的地域'."\n" - .'对于PROMETHEUS_DS，指prometheus实例所属地域。'."\n" - .'如果未指定，则通过规则的regionId访问数据源。', - 'description' => '适用数据源类型：APM_DS、PROMETHEUS_DS。'."\n" - ."\n" - .'数据源所属的regionId。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], + 'enum' => ['ENTERPRISE_DS', 'PROMETHEUS_DS', 'SLS_MULTI_DS', 'APM_DS', 'CMS_BASIC_DS', 'ENTITY_DS'], + ], + 'regionId' => ['title' => '数据源所属的regionId。'."\n" + .'对APM_DS，指应用所属的地域'."\n" + .'对于PROMETHEUS_DS，指prometheus实例所属地域。'."\n" + .'如果未指定，则通过规则的regionId访问数据源。', 'description' => '适用数据源类型：APM_DS、PROMETHEUS_DS。'."\n" + ."\n" + .'数据源所属的regionId。', 'type' => 'string', 'example' => 'cn-hangzhou'], 'appType' => [ 'title' => '仅对APM_DS有效，应用的类型：'."\n" .'* apm'."\n" @@ -1568,36 +936,33 @@ .'应用的类型：'."\n" .'- apm', 'type' => 'string', - 'enumValueTitles' => [ - 'apm' => 'APM应用', - ], + 'enumValueTitles' => ['apm' => 'APM应用'], 'example' => 'apm', ], + 'tenantId' => ['type' => 'string'], ], ], 'AlertRuleLabelFilter' => [ 'description' => '标签过滤配置', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'opt' => [ 'description' => '多个标签之间的关系操作符', + 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'AND', + 'backendName' => 'opt', 'default' => 'AND', - 'enum' => [ - 'AND', - 'OR', - ], + 'enum' => ['AND', 'OR'], ], 'labels' => [ 'description' => '标签过滤器', + 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => '标签的值', - 'type' => 'string', - 'example' => 'cn-shanghai', - ], + 'additionalProperties' => ['description' => '标签的值', 'visibility' => 'Public', 'type' => 'string', 'example' => 'cn-shanghai'], + 'backendName' => 'labels', ], ], ], @@ -1608,154 +973,107 @@ 'contacts' => [ 'description' => '联系人ID列表。', 'type' => 'array', - 'items' => [ - 'description' => '联系人ID。', - 'type' => 'string', - 'example' => 'myContactId', - ], + 'items' => ['description' => '联系人ID。', 'type' => 'string', 'example' => 'myContactId'], ], 'customWebhooks' => [ 'description' => '自定义webhook通知对象ID列表', 'type' => 'array', - 'items' => [ - 'description' => '自定义webhook通知对象ID', - 'type' => 'string', - 'example' => 'myCustomWebhookId', - ], + 'items' => ['description' => '自定义webhook通知对象ID', 'type' => 'string', 'example' => 'myCustomWebhookId'], ], 'dingWebhooks' => [ 'description' => '钉钉webhook通知对象ID列表', 'type' => 'array', - 'items' => [ - 'description' => '钉钉webhook通知对象ID', - 'type' => 'string', - 'example' => 'myDingWebhookId', - ], + 'items' => ['description' => '钉钉webhook通知对象ID', 'type' => 'string', 'example' => 'myDingWebhookId'], ], 'fsWebhooks' => [ 'description' => '飞书webhook通知对象ID列表', 'type' => 'array', - 'items' => [ - 'description' => '飞书webhook通知对象ID。', - 'type' => 'string', - 'example' => 'myFsWebhookId', - ], + 'items' => ['description' => '飞书webhook通知对象ID。', 'type' => 'string', 'example' => 'myFsWebhookId'], ], 'groups' => [ 'description' => '联系人组ID列表', 'type' => 'array', - 'items' => [ - 'description' => '联系人组ID', - 'type' => 'string', - 'example' => 'myContactGroupId', - ], - ], - 'silenceTime' => [ - 'description' => '通知沉默时间，单位：秒', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '86400', + 'items' => ['description' => '联系人组ID', 'type' => 'string', 'example' => 'myContactGroupId'], ], + 'silenceTime' => ['description' => '通知沉默时间，单位：秒', 'type' => 'integer', 'format' => 'int64', 'example' => '86400'], 'slackWebhooks' => [ 'description' => 'slack webhook通知对象ID列表', 'type' => 'array', - 'items' => [ - 'description' => 'slack webhook通知对象ID', - 'type' => 'string', - 'example' => 'mySlackWebhookId', - ], + 'items' => ['description' => 'slack webhook通知对象ID', 'type' => 'string', 'example' => 'mySlackWebhookId'], ], 'wxWebhooks' => [ 'description' => '微信webhook通知对象ID列表', 'type' => 'array', - 'items' => [ - 'description' => '微信webhook通知对象ID', - 'type' => 'string', - 'example' => 'myWxWebhookId', - ], - ], - 'notifyTime' => [ - 'title' => '通知时段，只有在该时段内，才发送通知', - 'description' => '通知时段，只有在该时段内，才发送通知', - '$ref' => '#/components/schemas/AlertRuleTimeSpan', + 'items' => ['description' => '微信webhook通知对象ID', 'type' => 'string', 'example' => 'myWxWebhookId'], ], + 'notifyTime' => ['title' => '通知时段，只有在该时段内，才发送通知', 'description' => '通知时段，只有在该时段内，才发送通知', '$ref' => '#/components/schemas/AlertRuleTimeSpan'], 'dingCoolAppWebhooks' => [ 'description' => '钉钉酷应用webhook 通知对象 ID 列表', 'type' => 'array', - 'items' => [ - 'description' => '单个钉钉酷应用 webhook ID', - 'type' => 'string', - 'example' => 'myDingCoolAppWebhookId', + 'items' => ['description' => '单个钉钉酷应用 webhook ID', 'type' => 'string', 'example' => 'myDingCoolAppWebhookId'], + ], + 'qwencloudContacts' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'additionalProperties' => ['type' => 'boolean'], ], ], ], ], 'AlertRuleNotificationFilter' => [ 'description' => '通知对象过滤配置', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'slackWebhooks' => [ 'description' => 'slack webhook ID过滤列表', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'webhook ID', - 'type' => 'string', - 'example' => 'myWebhookId', - ], + 'items' => ['description' => 'webhook ID', 'visibility' => 'Public', 'type' => 'string', 'example' => 'myWebhookId', 'extendType' => 'true'], + 'backendName' => 'slackWebhooks', ], 'wxWebhooks' => [ 'description' => '微信webhook ID过滤', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'webhook ID', - 'type' => 'string', - 'example' => 'myWebhookId', - ], + 'items' => ['description' => 'webhook ID', 'visibility' => 'Public', 'type' => 'string', 'example' => 'myWebhookId', 'extendType' => 'true'], + 'backendName' => 'wxWebhooks', ], 'dingWebhooks' => [ 'description' => '钉钉webhook ID过滤', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'webhook ID', - 'type' => 'string', - 'example' => 'myWebhookId', - ], + 'items' => ['description' => 'webhook ID', 'visibility' => 'Public', 'type' => 'string', 'example' => 'myWebhookId', 'extendType' => 'true'], + 'backendName' => 'dingWebhooks', ], 'customWebhooks' => [ 'description' => '自定义webhook ID过滤', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'webhook ID', - 'type' => 'string', - 'example' => 'myWebhookId', - ], + 'items' => ['description' => 'webhook ID', 'visibility' => 'Public', 'type' => 'string', 'example' => 'myWebhookId', 'extendType' => 'true'], + 'backendName' => 'customWebhooks', ], 'groups' => [ 'description' => '联系人组过滤配置', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '联系人组ID', - 'type' => 'string', - 'example' => 'myContactGroup', - ], + 'items' => ['description' => '联系人组ID', 'visibility' => 'Public', 'type' => 'string', 'example' => 'myContactGroup', 'extendType' => 'true'], + 'backendName' => 'groups', ], 'fsWebhooks' => [ 'description' => '飞书webhook ID过滤', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'webhook ID', - 'type' => 'string', - 'example' => 'myWebhookId', - ], + 'items' => ['description' => 'webhook ID', 'visibility' => 'Public', 'type' => 'string', 'example' => 'myWebhookId', 'extendType' => 'true'], + 'backendName' => 'fsWebhooks', ], 'contacts' => [ 'description' => '联系人ID过滤', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '联系人ID', - 'type' => 'string', - 'example' => 'myContactId', - ], + 'items' => ['description' => '联系人ID', 'visibility' => 'Public', 'type' => 'string', 'example' => 'myContactId', 'extendType' => 'true'], + 'backendName' => 'contacts', ], ], ], @@ -1763,34 +1081,19 @@ 'description' => '告警规则的查询配置。 该配置对象所包含的字段取决于查询类型(type字段)，不同的数据查询类型适用的字段不同。', 'type' => 'object', 'properties' => [ - 'duration' => [ - 'title' => 'type=PROMQL_QUERY时需指定\\n告警(数据)持续时间，单位：秒。 默认60。', - 'description' => '适用查询类型：PROMQL_QUERY。'."\n" - ."\n" - .'告警数据持续时间，单位：秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '60', - ], - 'expr' => [ - 'title' => '查询表达式 PROMQL_QUERY时需指定', - 'description' => '适用查询类型：PROMQL_QUERY。'."\n" - ."\n" - .'查询表达式(promQL)', - 'type' => 'string', - 'example' => 'sum(sum(max_over_time(kube_pod_status_phase{phase=~\\"Pending\\",job=\\"_kube-state-metrics\\"}[5m])) by (pod)) > 1000', - ], + 'duration' => ['title' => 'type=PROMQL_QUERY时需指定\\n告警(数据)持续时间，单位：秒。 默认60。', 'description' => '适用查询类型：PROMQL_QUERY。'."\n" + ."\n" + .'告警数据持续时间，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '60'], + 'expr' => ['title' => '查询表达式 / SPL 语句。type=PROMQL_QUERY 时需指定；type=METRIC_SET_QUERY 时可选，用于自定义 SPL；type=LOG_SET_QUERY 时必填，必须提供 SPL 查询语句（业务层会执行必填校验）', 'description' => '适用查询类型：PROMQL_QUERY。'."\n" + ."\n" + .'查询表达式(promQL)', 'type' => 'string', 'example' => 'sum(sum(max_over_time(kube_pod_status_phase{phase=~\\"Pending\\",job=\\"_kube-state-metrics\\"}[5m])) by (pod)) > 1000'], 'groupFieldList' => [ 'title' => '分组字段名', 'description' => '适用查询类型：SLS_MULTI_QUERY。'."\n" ."\n" .'分组字段名列表', 'type' => 'array', - 'items' => [ - 'description' => '分组字段名', - 'type' => 'string', - 'example' => 'host_name', - ], + 'items' => ['description' => '分组字段名', 'type' => 'string', 'example' => 'host_name'], ], 'groupType' => [ 'title' => '分组类型：'."\n" @@ -1805,14 +1108,10 @@ .'- custom: 标签自定义', 'type' => 'string', 'example' => 'label', - 'enum' => [ - 'none', - 'label', - 'custom', - ], + 'enum' => ['none', 'label', 'custom'], ], 'queries' => [ - 'title' => '子查询列表, type=SLS_MULTI_QUERY或APM_MULTI_QUERY时指定', + 'title' => '子查询列表, type=SLS_MULTI_QUERY 或 APM_MULTI_QUERY 时指定子 SLS/APM 查询；type=METRIC_SET_MULTI_QUERY 时指定多个命名 MetricSet 查询条目（每项包含 name/metricSet/metric/labelFilters）', 'description' => '适用查询类型：SLS_MULTI_QUERY、APM_MULTI_QUERY。'."\n" ."\n" .'子查询列表'."\n" @@ -1824,54 +1123,25 @@ 'description' => '子查询。', 'type' => 'object', 'properties' => [ - 'duration' => [ - 'title' => '仅对ARMS_MULTI_QUERY有效。 告警(数据)持续时间。', - 'description' => '适用查询类型：ARMS_MULTI_QUERY。'."\n" - ."\n" - .'告警(数据)持续时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '120', - ], - 'end' => [ - 'title' => '仅对SLS_MULTI_QUERY有效。时间偏移结束时间(相对)', - 'description' => '适用查询类型： SLS_MULTI_QUERY。'."\n" - ."\n" - .'时间偏移结束时间(相对)。'."\n" - ."\n" - .'如果指定了start、end，则不指定window。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - 'pattern' => '', - 'default' => '', - ], - 'expr' => [ - 'title' => '查询表达式。 sls sql/spl或promQL，取决与query.type', - 'description' => '适用查询类型： APM_MULTI_QUERY、SLS_MULTI_QUERY。'."\n" - ."\n" - .'查询表达式'."\n" - ."\n" - .'- 对于APM_MULTI_QUERY，该字段非必须，为预定义指标生成的promQL(用于预览数据)。'."\n" - .'- 对于SLS_MULTI_QUERY，该字段为SQL查询语句。', - 'type' => 'string', - 'example' => 'sum by (rpc,acs_arms_service_id,pid,rpcType) (sum_over_time_lorc(arms_app_requests_count_ign_destid_endpoint_parent_ppid_prpc{callKind=~\\"http|rpc|custom_entry|server|consumer\\",pid=\\"gaddp9ap8q@cb005ffdf44b8ac\\",source=\\"apm\\"}[1m]))', - 'pattern' => '', - 'default' => '', - ], - 'start' => [ - 'title' => '仅对SLS_MULTI_QUERY有效。时间偏移开始时间(相对)', - 'description' => '适用查询类型： SLS_MULTI_QUERY。'."\n" - ."\n" - .'SLS查询的时间偏移开始时间(相对)。'."\n" - ."\n" - .'如果指定了start、end，则不指定window。 例如：start=15， timeUnit=minute，表示15分钟前', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - 'pattern' => '', - 'default' => '', - ], + 'duration' => ['title' => '仅对ARMS_MULTI_QUERY有效。 告警(数据)持续时间。', 'description' => '适用查询类型：ARMS_MULTI_QUERY。'."\n" + ."\n" + .'告警(数据)持续时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '120'], + 'end' => ['title' => '仅对SLS_MULTI_QUERY有效。时间偏移结束时间(相对)', 'description' => '适用查询类型： SLS_MULTI_QUERY。'."\n" + ."\n" + .'时间偏移结束时间(相对)。'."\n" + ."\n" + .'如果指定了start、end，则不指定window。', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'pattern' => '', 'default' => ''], + 'expr' => ['title' => '查询表达式。 sls sql/spl或promQL，取决与query.type', 'description' => '适用查询类型： APM_MULTI_QUERY、SLS_MULTI_QUERY。'."\n" + ."\n" + .'查询表达式'."\n" + ."\n" + .'- 对于APM_MULTI_QUERY，该字段非必须，为预定义指标生成的promQL(用于预览数据)。'."\n" + .'- 对于SLS_MULTI_QUERY，该字段为SQL查询语句。', 'type' => 'string', 'example' => 'sum by (rpc,acs_arms_service_id,pid,rpcType) (sum_over_time_lorc(arms_app_requests_count_ign_destid_endpoint_parent_ppid_prpc{callKind=~\\"http|rpc|custom_entry|server|consumer\\",pid=\\"gaddp9ap8q@cb005ffdf44b8ac\\",source=\\"apm\\"}[1m]))', 'pattern' => '', 'default' => ''], + 'start' => ['title' => '仅对SLS_MULTI_QUERY有效。时间偏移开始时间(相对)', 'description' => '适用查询类型： SLS_MULTI_QUERY。'."\n" + ."\n" + .'SLS查询的时间偏移开始时间(相对)。'."\n" + ."\n" + .'如果指定了start、end，则不指定window。 例如：start=15， timeUnit=minute，表示15分钟前', 'type' => 'integer', 'format' => 'int64', 'example' => '15', 'pattern' => '', 'default' => ''], 'timeUnit' => [ 'title' => '仅对SLS_MULTI_QUERY有效。start、end、window的时间单位。', 'description' => '适用查询类型： SLS_MULTI_QUERY。'."\n" @@ -1881,34 +1151,16 @@ 'example' => 'hour', 'pattern' => '', 'default' => 'minute', - 'enum' => [ - 'second', - 'minute', - 'hour', - 'day', - ], - ], - 'window' => [ - 'title' => '仅对SLS_MULTI_QUERY有效。整点时间查询区间。 ', - 'description' => '适用查询类型： SLS_MULTI_QUERY。'."\n" - ."\n" - .'整点时间查询区间。 如果指定了window则不应指定start、end。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'pattern' => '', - 'default' => '', - ], - 'apmAlertMetricId' => [ - 'title' => ' 仅对APM_MULTI_QUERY有效。'."\n" - .'APM指标的alertMetricId，与Apm Datasource配合使用，如果指定，则忽略expr，即不依赖promQL，而是直接通过alertMetricId进程查询。'."\n" - .'当指定apmAlertMetricId时，指标查询的过滤项、聚合维度(group by)通过apmFilters、apmGroupBy字段指定。', - 'description' => '适用查询类型：APM_MULTI_QUERY。'."\n" - ."\n" - .'APM预定义指标的ID。', - 'type' => 'string', - 'example' => 'appstat.jvm.ThreadNewCount', + 'enum' => ['second', 'minute', 'hour', 'day'], ], + 'window' => ['title' => '仅对SLS_MULTI_QUERY有效。整点时间查询区间。 ', 'description' => '适用查询类型： SLS_MULTI_QUERY。'."\n" + ."\n" + .'整点时间查询区间。 如果指定了window则不应指定start、end。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'pattern' => '', 'default' => ''], + 'apmAlertMetricId' => ['title' => ' 仅对APM_MULTI_QUERY有效。'."\n" + .'APM指标的alertMetricId，与Apm Datasource配合使用，如果指定，则忽略expr，即不依赖promQL，而是直接通过alertMetricId进程查询。'."\n" + .'当指定apmAlertMetricId时，指标查询的过滤项、聚合维度(group by)通过apmFilters、apmGroupBy字段指定。', 'description' => '适用查询类型：APM_MULTI_QUERY。'."\n" + ."\n" + .'APM预定义指标的ID。', 'type' => 'string', 'example' => 'appstat.jvm.ThreadNewCount'], 'apmFilters' => [ 'title' => 'APM指标的维度过滤项配置。 必须与apmAlertMetricId配合使用。', 'description' => '适用查询类型：ARMS_MULTI_QUERY。'."\n" @@ -1918,33 +1170,19 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'dim' => [ - 'title' => 'APM指标中为维度', - 'description' => 'APM指标中为维度', - 'type' => 'string', - 'example' => 'rpcType', - ], - 'type' => [ - 'title' => '过滤操作类型：'."\n" - .'* eq： 等于'."\n" - .'* neq：不等于'."\n" - .'* match：正则匹配'."\n" - .'* nmatch：正则不匹配', - 'description' => '过滤操作类型：'."\n" - .'* eq： 等于'."\n" - .'* neq：不等于'."\n" - .'* match：正则匹配'."\n" - .'* nmatch：正则不匹配', - 'type' => 'string', - 'example' => 'eq', - ], - 'value' => [ - 'title' => '与过滤操作对应的取值。', - 'description' => '与过滤操作对应的取值。', - 'type' => 'string', - 'example' => 'h3ji7a0y9i@2ac80e27fdfd0a2', - ], - ], + 'dim' => ['title' => 'APM指标中为维度', 'description' => 'APM指标中为维度', 'type' => 'string', 'example' => 'rpcType'], + 'type' => ['title' => '过滤操作类型：'."\n" + .'* eq： 等于'."\n" + .'* neq：不等于'."\n" + .'* match：正则匹配'."\n" + .'* nmatch：正则不匹配', 'description' => '过滤操作类型：'."\n" + .'* eq： 等于'."\n" + .'* neq：不等于'."\n" + .'* match：正则匹配'."\n" + .'* nmatch：正则不匹配', 'type' => 'string', 'example' => 'eq'], + 'value' => ['title' => '与过滤操作对应的取值。', 'description' => '与过滤操作对应的取值。', 'type' => 'string', 'example' => 'h3ji7a0y9i@2ac80e27fdfd0a2'], + ], + 'description' => '', ], ], 'apmGroupBy' => [ @@ -1953,26 +1191,39 @@ ."\n" .'查询的聚合维度列表，即按指标的哪些维度进行聚合。', 'type' => 'array', + 'items' => ['description' => '指标的聚合维度', 'type' => 'string', 'example' => 'rpcType'], + ], + 'name' => ['type' => 'string'], + 'promQl' => ['type' => 'string'], + 'metricSet' => ['title' => '仅对 METRIC_SET_MULTI_QUERY 有效。指标集名称', 'type' => 'string'], + 'metric' => ['title' => '仅对 METRIC_SET_MULTI_QUERY 有效。指标名称', 'type' => 'string'], + 'labelFilters' => [ + 'title' => '仅对 METRIC_SET_MULTI_QUERY 有效。标签过滤条件（可选，每查询独立）', + 'type' => 'array', 'items' => [ - 'description' => '指标的聚合维度', - 'type' => 'string', - 'example' => 'rpcType', + 'type' => 'object', + 'properties' => [ + 'name' => ['type' => 'string'], + 'value' => ['type' => 'string'], + 'operator' => ['type' => 'string'], + ], ], ], ], ], ], - 'firstJoin' => [ - 'description' => '适用查询类型： SLS_MULTI_QUERY。'."\n" - ."\n" - .'子查询1(queries[0])和子查询2(queries[1])结果的集合连接操作配置。', - '$ref' => '#/components/schemas/AlertRuleSlsQueryJoin', - ], + 'firstJoin' => ['description' => '适用查询类型： SLS_MULTI_QUERY。'."\n" + ."\n" + .'子查询1(queries[0])和子查询2(queries[1])结果的集合连接操作配置。', '$ref' => '#/components/schemas/AlertRuleSlsQueryJoin'], 'type' => [ 'title' => '查询类型，PROMQL_QUERY--prometheus查询；'."\n" .' APM_MULTI_QUERY -- APM查询；'."\n" - .' SLS_MULTI_QUERY -- SLS查询'."\n" - .'CMS_BASIC_QUERY-- 基础云监控查询', + .' SLS_MULTI_QUERY -- SLS查询；'."\n" + .' CMS_BASIC_QUERY-- 基础云监控查询；'."\n" + .' METRIC_SET_QUERY -- UModel 指标集查询；'."\n" + .' LOG_SET_QUERY -- UModel 日志集查询；'."\n" + .' PROMETHEUS_MULTI_QUERY -- Prometheus 复合查询；'."\n" + .' METRIC_SET_MULTI_QUERY -- UModel 多指标联合查询（多指标 AND/OR 检测）', 'description' => '查询类型。 '."\n" ."\n" .'取值范围：'."\n" @@ -1990,37 +1241,18 @@ .'- 基础云监控数据源(CMS_BASIC_DS)：CMS_BASIC_QUERY', 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'PROMQL_QUERY' => 'PROMQL_QUERY', - 'CMS_BASIC_QUERY' => 'CMS_BASIC_QUERY', - 'APM_MULTI_QUERY' => 'APM_MULTI_QUERY', - 'SLS_MULTI_QUERY' => 'SLS_MULTI_QUERY', - ], + 'enumValueTitles' => ['PROMQL_QUERY' => 'PROMQL_QUERY', 'CMS_BASIC_QUERY' => 'CMS_BASIC_QUERY', 'APM_MULTI_QUERY' => 'APM_MULTI_QUERY', 'SLS_MULTI_QUERY' => 'SLS_MULTI_QUERY'], 'example' => 'PROMQL_QUERY', 'pattern' => '', 'default' => 'PROMQL_QUERY', - 'enum' => [ - 'PROMQL_QUERY', - 'SLS_MULTI_QUERY', - 'APM_MULTI_QUERY', - 'CMS_BASIC_QUERY', - 'METRIC_SET_QUERY', - ], - ], - 'secondJoin' => [ - 'description' => '适用查询类型：SLS_MULTI_QUERY。'."\n" - ."\n" - .'子查询2(queries[2])和子查询3(queries[3])结果的集合连接操作配置。', - '$ref' => '#/components/schemas/AlertRuleSlsQueryJoin', - ], - 'checkAfterDataComplete' => [ - 'title' => '仅对PROMQL_QUERY有效，是否数据完整后再执行告警检测', - 'description' => '适用查询类型： PROMQL_QUERY。'."\n" - ."\n" - .'是否数据完整后再执行告警检测。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'enum' => ['PROMQL_QUERY', 'SLS_MULTI_QUERY', 'APM_MULTI_QUERY', 'CMS_BASIC_QUERY', 'METRIC_SET_QUERY', 'LOG_SET_QUERY', 'PROMETHEUS_MULTI_QUERY', 'METRIC_SET_MULTI_QUERY'], + ], + 'secondJoin' => ['description' => '适用查询类型：SLS_MULTI_QUERY。'."\n" + ."\n" + .'子查询2(queries[2])和子查询3(queries[3])结果的集合连接操作配置。', '$ref' => '#/components/schemas/AlertRuleSlsQueryJoin'], + 'checkAfterDataComplete' => ['title' => '仅对PROMQL_QUERY有效，是否数据完整后再执行告警检测', 'description' => '适用查询类型： PROMQL_QUERY。'."\n" + ."\n" + .'是否数据完整后再执行告警检测。', 'type' => 'boolean', 'example' => 'true'], 'relationType' => [ 'title' => 'CMS_BASIC_QUERY时必须。'."\n" .'● USER：用户uid下全部资源'."\n" @@ -2033,43 +1265,21 @@ .'- GROUP： 应用分组'."\n" .'- INSTANCE：指定实例列表', 'type' => 'string', - 'enumValueTitles' => [ - 'GROUP' => 'GROUP', - 'INSTANCE' => 'INSTANCE', - 'USER' => 'USER', - ], + 'enumValueTitles' => ['GROUP' => 'GROUP', 'INSTANCE' => 'INSTANCE', 'USER' => 'USER'], 'example' => 'USER', ], - 'groupId' => [ - 'title' => '仅对type=CMS_BASIC_QUERY且relationType=GROUP有效。 关联应用分组id。', - 'description' => '适用查询类型：CMS_BASIC_QUERY。'."\n" - ."\n" - .'关联应用分组id，仅在relationType=GROUP时有效。', - 'type' => 'string', - 'example' => '23423', - ], - 'namespace' => [ - 'title' => '仅对type=CMS_BASIC_QUERY有效，规则关联的指标数据命名空间', - 'description' => '适用查询类型：CMS_BASIC_QUERY。'."\n" - ."\n" - .'指标的命名空间', - 'type' => 'string', - 'example' => 'acs_ecs_dashboard', - ], + 'groupId' => ['title' => '仅对type=CMS_BASIC_QUERY且relationType=GROUP有效。 关联应用分组id。', 'description' => '适用查询类型：CMS_BASIC_QUERY。'."\n" + ."\n" + .'关联应用分组id，仅在relationType=GROUP时有效。', 'type' => 'string', 'example' => '23423'], + 'namespace' => ['title' => '仅对type=CMS_BASIC_QUERY有效，规则关联的指标数据命名空间', 'description' => '适用查询类型：CMS_BASIC_QUERY。'."\n" + ."\n" + .'指标的命名空间', 'type' => 'string', 'example' => 'acs_ecs_dashboard'], 'entityFilter' => [ 'description' => '资源过滤器，用于筛选目标资源。', 'type' => 'object', 'properties' => [ - 'domain' => [ - 'description' => '资源类型域。', - 'type' => 'string', - 'example' => 'rum', - ], - 'type' => [ - 'description' => '资源类型。', - 'type' => 'string', - 'example' => 'apm', - ], + 'domain' => ['description' => '资源类型域。', 'type' => 'string', 'example' => 'rum'], + 'type' => ['description' => '资源类型。', 'type' => 'string', 'example' => 'apm'], 'filters' => [ 'description' => '过滤条件列表，用于进一步筛选资源。', 'type' => 'array', @@ -2077,40 +1287,24 @@ 'description' => '过滤条件对象。', 'type' => 'object', 'properties' => [ - 'field' => [ - 'description' => '字段', - 'type' => 'string', - 'example' => 'instanceId', - ], - 'operator' => [ - 'description' => '比较运算符。', - 'type' => 'string', - 'example' => '=', - ], - 'value' => [ - 'description' => '匹配的值。', - 'type' => 'string', - 'example' => 'wait_throw', - ], + 'field' => ['description' => '字段', 'type' => 'string', 'example' => 'instanceId'], + 'operator' => ['description' => '比较运算符。', 'type' => 'string', 'example' => '='], + 'value' => ['description' => '匹配的值。', 'type' => 'string', 'example' => 'wait_throw'], ], ], ], ], ], - 'domain' => [ - 'description' => '资源所属的领域。', - 'type' => 'string', - 'example' => 'rum', - ], - 'metricSet' => [ - 'description' => '监控指标集合。', - 'type' => 'string', - 'example' => 'cpu_usage', - ], - 'metric' => [ - 'description' => '指标名。', + 'domain' => ['description' => '资源所属的领域。', 'type' => 'string', 'example' => 'rum'], + 'metricSet' => ['description' => '监控指标集合。', 'type' => 'string', 'example' => 'cpu_usage'], + 'metric' => ['description' => '指标名。', 'type' => 'string', 'example' => 'memory'], + 'logSet' => ['title' => 'type=LOG_SET_QUERY时指定，日志集名称', 'type' => 'string'], + 'windowSecs' => ['title' => 'type=METRIC_SET_QUERY / LOG_SET_QUERY时指定，聚合时间窗口（秒），有效范围[60, 86400]', 'type' => 'integer', 'format' => 'int64'], + 'offsetSecs' => ['title' => 'type=METRIC_SET_QUERY / LOG_SET_QUERY时指定，查询时间偏移（秒）；与 windowSecs 配合实现 [T - windowSecs - offsetSecs, T - offsetSecs] 的偏移查询；有效范围[0, 86400]', 'type' => 'integer', 'format' => 'int64'], + 'aggregate' => [ + 'title' => 'type=METRIC_SET_QUERY / LOG_SET_QUERY时指定，聚合函数：AVG / MAX / MIN / SUM / LAST', 'type' => 'string', - 'example' => 'memory', + 'enum' => ['AVG', 'MAX', 'MIN', 'SUM', 'LAST'], ], 'dimensions' => [ 'title' => '仅对CMS_BASIC_QUERY有效。 资源的过滤维度信息。', @@ -2121,21 +1315,13 @@ 'items' => [ 'description' => '基础云监控的资源过滤维度', 'type' => 'object', - 'additionalProperties' => [ - 'description' => '维度取值', - 'type' => 'string', - 'example' => 'i-f8zbbutcvfpx7gn457pi', - ], + 'additionalProperties' => ['description' => '维度取值', 'type' => 'string', 'example' => 'i-f8zbbutcvfpx7gn457pi'], ], ], 'serviceIds' => [ 'description' => '服务id列表。', 'type' => 'array', - 'items' => [ - 'description' => '服务id。', - 'type' => 'string', - 'example' => 'i-bp1234567890abcdef', - ], + 'items' => ['description' => '服务id。', 'type' => 'string', 'example' => 'i-bp1234567890abcdef'], ], 'labelFilters' => [ 'description' => '标签过滤器数组。', @@ -2144,21 +1330,9 @@ 'description' => '标签过滤器对象', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '标签名称', - 'type' => 'string', - 'example' => 'app', - ], - 'value' => [ - 'description' => '标签值', - 'type' => 'string', - 'example' => 'web', - ], - 'operator' => [ - 'description' => '比较运算符，决定如何匹配标签值。', - 'type' => 'string', - 'example' => '=', - ], + 'name' => ['description' => '标签名称', 'type' => 'string', 'example' => 'app'], + 'value' => ['description' => '标签值', 'type' => 'string', 'example' => 'web'], + 'operator' => ['description' => '比较运算符，决定如何匹配标签值。', 'type' => 'string', 'example' => '='], ], ], ], @@ -2169,16 +1343,18 @@ 'description' => '实体字段过滤器对象', 'type' => 'object', 'properties' => [ - 'field' => [ - 'description' => '实体字段名', - 'type' => 'string', - 'example' => 'instanceId', - ], - 'value' => [ - 'description' => '字段值', - 'type' => 'string', - 'example' => 'i-abc123', - ], + 'field' => ['description' => '实体字段名', 'type' => 'string', 'example' => 'instanceId'], + 'value' => ['description' => '字段值', 'type' => 'string', 'example' => 'i-abc123'], + ], + ], + ], + 'markTags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'key' => ['type' => 'string'], + 'value' => ['type' => 'string'], ], ], ], @@ -2187,92 +1363,63 @@ 'AlertRuleRcaConfig' => [ 'type' => 'object', 'properties' => [ - 'enableRca' => [ - 'type' => 'boolean', - ], - 'digitalEmployeeName' => [ - 'type' => 'string', - ], + 'enableRca' => ['type' => 'boolean'], + 'digitalEmployeeName' => ['type' => 'string'], ], ], 'AlertRuleSend' => [ 'description' => '告警发送配置对象', 'type' => 'object', 'properties' => [ - 'notification' => [ - 'description' => '告警通知配置', - '$ref' => '#/components/schemas/AlertRuleNotification', - ], - 'action' => [ - 'description' => '告警行动集成配置', - '$ref' => '#/components/schemas/AlertRuleAction', - ], - 'sendToArms' => [ - 'title' => '是否将告警事件投递至ARMS告警管理', - 'description' => '是否将告警事件投递至ARMS告警管理', - 'type' => 'boolean', - 'example' => 'true', - ], + 'notification' => ['description' => '告警通知配置', '$ref' => '#/components/schemas/AlertRuleNotification'], + 'action' => ['description' => '告警行动集成配置', '$ref' => '#/components/schemas/AlertRuleAction'], + 'sendToArms' => ['title' => '是否将告警事件投递至ARMS告警管理', 'description' => '是否将告警事件投递至ARMS告警管理', 'type' => 'boolean', 'example' => 'true'], 'notifyStrategies' => [ 'description' => '通知策略列表，定义在不同告警状态（如触发、恢复）下应采取的通知方式或策略名称', 'type' => 'array', - 'items' => [ - 'description' => '通知策略', - 'type' => 'string', - 'example' => '["trigger", "recovery"]', - ], - ], - 'rcaConfig' => [ - '$ref' => '#/components/schemas/AlertRuleRcaConfig', + 'items' => ['description' => '通知策略', 'type' => 'string', 'example' => '["trigger", "recovery"]'], ], + 'rcaConfig' => ['$ref' => '#/components/schemas/AlertRuleRcaConfig'], ], ], 'AlertRuleSlsQueryJoin' => [ 'description' => 'SLS查询连接配置。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'conditions' => [ 'description' => '连接条件列表。', + 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'title' => '集合操作条件', 'description' => '集合操作条件。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'oper' => [ - 'title' => '集合联接条件操作符', - 'description' => '比较操作符，取值范围：<, >, ==, !=, <=, >=', - 'type' => 'string', - 'deprecated' => false, - 'example' => '==', - 'pattern' => '', - 'readOnly' => false, - 'default' => '', + 'title' => '集合联接条件操作符', 'description' => '比较操作符，取值范围：<, >, ==, !=, <=, >=', 'visibility' => 'Public', 'type' => 'string', 'deprecated' => false, 'hasServerDefaultValue' => false, 'example' => '==', 'pattern' => '', 'readOnly' => false, 'backendName' => 'oper', + 'sensitive' => false, 'extMonitorInfo' => false, 'descriptionEn' => 'join operator', 'default' => '', ], 'secondField' => [ - 'title' => '条件的右操作参数', - 'description' => '条件的右操作参数，格式为$<query_idx>.<结果集字段名>', - 'type' => 'string', - 'deprecated' => false, - 'example' => '$0.__topic__', - 'pattern' => '', - 'readOnly' => false, - 'default' => '', + 'title' => '条件的右操作参数', 'description' => '条件的右操作参数，格式为$<query_idx>.<结果集字段名>', 'visibility' => 'Public', 'type' => 'string', 'deprecated' => false, 'hasServerDefaultValue' => false, 'example' => '$0.__topic__', 'pattern' => '', 'readOnly' => false, 'backendName' => 'secondField', + 'sensitive' => false, 'extMonitorInfo' => false, 'descriptionEn' => 'right parameter of join condition', 'default' => '', ], 'firstField' => [ - 'title' => '条件的左操作参数', - 'description' => '条件的左操作参数，格式为$<query_idx>.<结果集字段名>', - 'type' => 'string', - 'deprecated' => false, - 'example' => '$0.__topic__', - 'pattern' => '', - 'readOnly' => false, - 'default' => '', + 'title' => '条件的左操作参数', 'description' => '条件的左操作参数，格式为$<query_idx>.<结果集字段名>', 'visibility' => 'Public', 'type' => 'string', 'deprecated' => false, 'hasServerDefaultValue' => false, 'example' => '$0.__topic__', 'pattern' => '', 'readOnly' => false, 'backendName' => 'firstField', + 'sensitive' => false, 'extMonitorInfo' => false, 'descriptionEn' => 'left parameter of join condition', 'default' => '', ], ], 'deprecated' => false, + 'hasServerDefaultValue' => false, 'readOnly' => false, + 'sensitive' => false, + 'extMonitorInfo' => false, + 'descriptionEn' => 'join condition', + 'extendType' => 'true', + 'unordered' => false, ], + 'backendName' => 'conditions', ], 'type' => [ 'title' => '查询结果集合操作类型', @@ -2290,276 +1437,468 @@ ."\n" .'参见：'."\n" .' https://help.aliyun.com/zh/sls/user-guide/set-query-statistics-statement', + 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'CrossJoin', 'pattern' => '', + 'backendName' => 'type', + 'sensitive' => false, 'default' => '', - 'enum' => [ - 'CrossJoin', - 'FullJoin', - 'InnerJoin', - 'LeftExclude', - 'RightExclude', - 'LeftJoin', - 'RightJoin', - 'NoJoin', - 'Concat', - ], + 'enum' => ['CrossJoin', 'FullJoin', 'InnerJoin', 'LeftExclude', 'RightExclude', 'LeftJoin', 'RightJoin', 'NoJoin', 'Concat'], ], ], ], + 'AlertRuleTemplate' => [ + 'type' => 'object', + 'properties' => [ + 'id' => ['type' => 'integer', 'format' => 'int64'], + 'uuid' => ['type' => 'string'], + 'gmtCreate' => ['type' => 'integer', 'format' => 'int64'], + 'gmtModified' => ['type' => 'integer', 'format' => 'int64'], + 'userId' => ['type' => 'string'], + 'templateName' => ['type' => 'string'], + 'description' => ['type' => 'string'], + 'isSystem' => ['type' => 'integer', 'format' => 'int32'], + 'alertType' => ['type' => 'string'], + 'subType' => ['type' => 'string'], + 'status' => ['type' => 'integer', 'format' => 'int32'], + 'applyCount' => ['type' => 'integer', 'format' => 'int64'], + 'ruleConfigs' => ['type' => 'string'], + 'labels' => ['type' => 'string'], + 'datasource' => ['type' => 'string'], + 'scenes' => ['type' => 'string'], + 'sourceType' => ['type' => 'string'], + 'bizType' => ['type' => 'string'], + 'schemaVersion' => ['type' => 'string'], + ], + ], 'AlertRuleTimeSpan' => [ 'description' => '时段配置对象。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'dayOfWeek' => [ 'title' => '每周的星期几', 'description' => '每周的星期几。', + 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '每周的星期几。', + 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1', - 'enum' => [ - '1', - '2', - '3', - '4', - '5', - '6', - '7', - ], + 'extendType' => 'true', + 'enum' => ['1', '2', '3', '4', '5', '6', '7'], ], + 'backendName' => 'dayOfWeek', ], - 'gmtOffset' => [ - 'title' => '默认北京时间： +0800', - 'description' => '默认北京时间： +0800', - 'type' => 'string', - 'example' => '+0800', + 'gmtOffset' => ['title' => '默认北京时间： +0800', 'description' => '默认北京时间： +0800', 'visibility' => 'Public', 'type' => 'string', 'example' => '+0800', 'backendName' => 'gmtOffset'], + 'startTime' => ['title' => '开始时间，格式HH:mm', 'description' => '开始时间，格式HH:mm', 'visibility' => 'Public', 'type' => 'string', 'example' => '09:00', 'backendName' => 'startTime'], + 'endTime' => ['title' => '结束时间，格式HH:mm', 'description' => '结束时间，格式HH:mm', 'visibility' => 'Public', 'type' => 'string', 'example' => '23:00', 'backendName' => 'endTime'], + ], + ], + 'AlertRuleV2' => [ + 'title' => '告警规则（V2 OpenAPI 资源模型）', + 'type' => 'object', + 'properties' => [ + 'uuid' => ['title' => '规则 UUID（系统生成，只读）', 'type' => 'string', 'readOnly' => true], + 'createdAt' => ['title' => '创建时间（只读），ISO 8601', 'type' => 'string', 'readOnly' => true], + 'updatedAt' => ['title' => '更新时间（只读），ISO 8601', 'type' => 'string', 'readOnly' => true], + 'status' => [ + 'title' => '告警状态（只读）', + 'type' => 'string', + 'readOnly' => true, + 'enum' => ['Alarm', 'Ok'], + ], + 'workspace' => ['title' => '工作空间', 'type' => 'string', 'required' => false], + 'displayName' => ['title' => '显示名称', 'type' => 'string'], + 'contentTemplate' => ['title' => '内容模板', 'type' => 'string'], + 'enabled' => ['title' => '是否启用', 'type' => 'boolean'], + 'datasourceConfig' => ['$ref' => '#/components/schemas/DatasourceConfigUnified'], + 'queryConfig' => ['$ref' => '#/components/schemas/QueryConfigUnified'], + 'conditionConfig' => ['$ref' => '#/components/schemas/ConditionConfigUnified'], + 'scheduleConfig' => ['$ref' => '#/components/schemas/ScheduleConfigUnified'], + 'notifyConfig' => ['$ref' => '#/components/schemas/NotifyConfigUnified'], + 'actionIntegrationConfig' => ['$ref' => '#/components/schemas/ActionIntegrationConfig'], + 'armsIntegrationConfig' => ['$ref' => '#/components/schemas/ArmsIntegrationConfig'], + 'labels' => [ + 'title' => '标签', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string'], ], - 'startTime' => [ - 'title' => '开始时间，格式HH:mm', - 'description' => '开始时间，格式HH:mm', - 'type' => 'string', - 'example' => '09:00', + 'annotations' => [ + 'title' => '注解', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string'], ], - 'endTime' => [ - 'title' => '结束时间，格式HH:mm', - 'description' => '结束时间，格式HH:mm', - 'type' => 'string', - 'example' => '23:00', + 'datasourceType' => ['title' => '数据源类型（只读派生）', 'type' => 'string'], + 'observeResourceType' => ['title' => '可观测资源类型（只读派生）', 'type' => 'string'], + 'observeResourceGlobalScope' => ['title' => '是否对该资源类型全量生效（只读派生）', 'type' => 'boolean'], + 'observeResourceList' => [ + 'title' => '可观测资源 ID 列表（只读派生）', + 'type' => 'array', + 'items' => ['type' => 'string'], ], + 'severityLevels' => ['title' => '本规则覆盖的严重等级，逗号分隔（只读派生；与查询参数 filter.severityLevels 形式一致）', 'type' => 'string'], + 'notifyStrategyId' => ['title' => '通知策略 ID（只读派生，取通知策略列表首个）', 'type' => 'string'], + 'partitionKey' => ['title' => '分区键（只读，由系统维护用于规则路由分片）', 'type' => 'string'], ], ], - 'BizTraceConfig' => [ - 'description' => '业务链路追踪的配置', + 'ApmCompositeCompareConfig' => [ + 'title' => 'APM 复合条件中的单条比较', 'type' => 'object', 'properties' => [ - 'workspace' => [ - 'title' => '工作空间。', - 'description' => '工作空间。', - 'type' => 'string', - 'example' => 'default-cms-xxxxxxx-cn-hangzhou', - ], - 'bizTraceId' => [ - 'title' => '业务链路id', - 'description' => '业务链路id', + 'aggregate' => [ + 'title' => '聚合函数', 'type' => 'string', - 'example' => 'e339260ed64c95d', - ], - 'bizTraceName' => [ - 'title' => '业务链路名称', - 'description' => '业务链路名称', - 'type' => 'string', - 'example' => 'just test', + 'required' => true, + 'enum' => ['AVG', 'SUM', 'COUNT', 'CONTINUES', 'MAX', 'MIN', 'P50', 'P75', 'P90', 'P99'], ], - 'bizTraceCode' => [ - 'title' => '业务链路标识', - 'description' => '业务链路标识', + 'operator' => [ + 'title' => '比较操作符（GTE/LTE 为大于等于/小于等于；YOY_UP/YOY_DOWN 为同比上升/下降，需同时填 yoyTimeUnit/yoyTimeValue）', 'type' => 'string', - 'example' => 'label_env', + 'required' => true, + 'enum' => ['GT', 'GTE', 'LT', 'LTE', 'EQ', 'NE', 'YOY_UP', 'YOY_DOWN'], ], - 'ruleConfig' => [ - 'title' => '配置规则列表', - 'description' => '配置规则列表', + 'threshold' => ['title' => '单阈值', 'type' => 'number', 'format' => 'float', 'required' => true], + 'yoyTimeUnit' => [ + 'title' => '同比时间单位（仅 operator=YOY_UP/YOY_DOWN 生效）', 'type' => 'string', - 'example' => '[{"entrancePid":"xxxxx@b57c44xx6e86","rpcMatcher":{"matchType":"EQUALS","pattern":"/createApp"},"characteristics":{"operation":"AND","rules":[{"target":"CUSTOM_EXTRACT","matcher":{"matchType":"CONTAINS","pattern":[]}}]}}]', + 'enum' => ['minute', 'hour', 'day', 'week', 'month'], ], - 'advancedConfig' => [ - 'title' => '高级配置', - 'description' => '高级配置', + 'yoyTimeValue' => ['title' => '同比时间值（仅 operator=YOY_UP/YOY_DOWN 生效）', 'type' => 'integer', 'format' => 'int32'], + ], + ], + 'ApmFilterConfig' => [ + 'title' => 'APM 查询过滤条件', + 'type' => 'object', + 'properties' => [ + 'key' => ['title' => '维度键', 'type' => 'string', 'required' => true], + 'type' => [ + 'title' => '过滤类型', 'type' => 'string', - 'example' => '{"sample":{"strategy":"BY_APP"}}', + 'required' => true, + 'enum' => ['ALL', 'EQ', 'NE', 'DISABLED'], ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2025-12-12 00:00:00', + 'value' => ['title' => '过滤值（type 为 ALL/DISABLED 时可为空）', 'type' => 'string'], + ], + ], + 'ApmMeasureConfig' => [ + 'title' => 'APM 度量配置', + 'type' => 'object', + 'properties' => [ + 'measureCode' => ['title' => '指标代码', 'type' => 'string', 'required' => true], + 'windowSecs' => ['title' => '查询时间窗口（秒）', 'type' => 'integer', 'format' => 'int32', 'required' => true], + 'groupBy' => [ + 'title' => '分组维度', + 'type' => 'array', + 'items' => ['type' => 'string'], ], - 'regionId' => [ - 'title' => '地域id', - 'description' => '地域id', + ], + ], + 'ApmThresholdConfig' => [ + 'title' => 'APM 简单条件下单等级阈值', + 'type' => 'object', + 'properties' => [ + 'severity' => [ + 'title' => '告警等级', 'type' => 'string', - 'example' => 'cn-beijing', + 'required' => true, + 'enum' => ['INFO', 'WARN', 'WARNING', 'ERROR', 'CRITICAL'], ], + 'threshold' => ['title' => '阈值（APM_SIMPLE_CONDITION 必填）', 'type' => 'number', 'format' => 'float'], + 'min' => ['title' => '区间下界', 'type' => 'number', 'format' => 'double'], + 'max' => ['title' => '区间上界', 'type' => 'number', 'format' => 'double'], ], ], - 'CmsEventForView' => [ - 'description' => '事件展示对象，包含事件的核心信息和上下文', + 'ArmsIntegrationConfig' => [ + 'title' => 'ARMS 集成配置', + 'type' => 'object', + 'properties' => [ + 'enabled' => ['title' => '是否启用 ARMS 集成', 'type' => 'boolean'], + ], + ], + 'BizTraceConfig' => [ + 'description' => '业务链路追踪的配置', + 'type' => 'object', + 'properties' => [ + 'workspace' => ['title' => '工作空间。', 'description' => '工作空间。', 'type' => 'string', 'example' => 'default-cms-xxxxxxx-cn-hangzhou'], + 'bizTraceId' => ['title' => '业务链路id', 'description' => '业务链路id', 'type' => 'string', 'example' => 'e339260ed64c95d'], + 'bizTraceName' => ['title' => '业务链路名称', 'description' => '业务链路名称', 'type' => 'string', 'example' => 'just test'], + 'bizTraceCode' => ['title' => '业务链路标识', 'description' => '业务链路标识', 'type' => 'string', 'example' => 'label_env'], + 'ruleConfig' => ['title' => '配置规则列表', 'description' => '配置规则列表', 'type' => 'string', 'example' => '[{"entrancePid":"xxxxx@b57c44xx6e86","rpcMatcher":{"matchType":"EQUALS","pattern":"/createApp"},"characteristics":{"operation":"AND","rules":[{"target":"CUSTOM_EXTRACT","matcher":{"matchType":"CONTAINS","pattern":[]}}]}}]'], + 'advancedConfig' => ['title' => '高级配置', 'description' => '高级配置', 'type' => 'string', 'example' => '{"sample":{"strategy":"BY_APP"}}'], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-12-12 00:00:00'], + 'regionId' => ['title' => '地域id', 'description' => '地域id', 'type' => 'string', 'example' => 'cn-beijing'], + ], + ], + 'CloudMonitoringCompositeEscalation' => [ + 'title' => '云产品监控 composite 触发', 'type' => 'object', 'properties' => [ - 'id' => [ - 'description' => '事件唯一标识符（全局唯一 ID），由系统生成', + 'relation' => ['title' => '条件间逻辑关系（AND/OR）', 'type' => 'string'], + 'severity' => [ + 'title' => '严重等级', 'type' => 'string', - 'example' => '"event-1234567890"', + 'enum' => ['CRITICAL', 'ERROR', 'WARNING', 'INFO'], ], - 'dedupId' => [ - 'description' => '去重 ID，用于识别同一事件的不同实例（如重复上报）', - 'type' => 'string', - 'example' => '"dedup-abc123"', + 'times' => ['title' => '连续触发次数', 'type' => 'integer', 'format' => 'int32'], + 'escalations' => [ + 'title' => '多条件配置列表', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/CloudMonitoringCompositeEscalationEntry'], ], - 'type' => [ - 'description' => '事件类型', + ], + ], + 'CloudMonitoringCompositeEscalationEntry' => [ + 'title' => '云产品监控 composite 触发的单条配置', + 'type' => 'object', + 'properties' => [ + 'comparisonOperator' => ['title' => '比较操作符', 'type' => 'string'], + 'metricName' => ['title' => '指标名', 'type' => 'string'], + 'period' => ['title' => '采集周期（秒）', 'type' => 'integer', 'format' => 'int32'], + 'statistics' => ['title' => '统计方法', 'type' => 'string'], + 'threshold' => ['title' => '阈值', 'type' => 'string'], + 'preCondition' => ['title' => '前置条件', 'type' => 'string'], + ], + ], + 'CloudMonitoringExpressEscalation' => [ + 'title' => '云产品监控 express 触发（表达式）', + 'type' => 'object', + 'properties' => [ + 'times' => ['title' => '连续触发次数', 'type' => 'integer', 'format' => 'int32'], + 'severity' => [ + 'title' => '严重等级', 'type' => 'string', - 'example' => '"Alert"', + 'enum' => ['CRITICAL', 'ERROR', 'WARNING', 'INFO'], ], - 'subtype' => [ - 'description' => '事件子类型', + 'rawExpression' => ['title' => '原始表达式', 'type' => 'string'], + ], + ], + 'CloudMonitoringPrometheusEscalation' => [ + 'title' => '云产品监控 prometheus 触发（PromQL）', + 'type' => 'object', + 'properties' => [ + 'severity' => [ + 'title' => '严重等级', 'type' => 'string', - 'example' => '"HighCPUUsage"', + 'enum' => ['CRITICAL', 'ERROR', 'WARNING', 'INFO'], ], - 'source' => [ - 'description' => '事件来源系统或服务名称（如 ECS、RDS、VPC 等）', - 'type' => 'string', - 'example' => '"ECS"', + 'promQl' => ['title' => 'PromQL 查询语句', 'type' => 'string'], + 'times' => ['title' => '连续触发次数', 'type' => 'integer', 'format' => 'int32'], + ], + ], + 'CloudMonitoringSimpleEscalation' => [ + 'title' => '云产品监控 simple 触发', + 'type' => 'object', + 'properties' => [ + 'metricName' => ['title' => '指标名', 'type' => 'string'], + 'period' => ['title' => '采集周期（秒）', 'type' => 'integer', 'format' => 'int32'], + 'escalations' => [ + 'title' => '多档触发列表', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/CloudMonitoringSimpleEscalationEntry'], ], - 'time' => [ - 'description' => '事件发生时间', + ], + ], + 'CloudMonitoringSimpleEscalationEntry' => [ + 'title' => '云产品监控 simple 触发的单档配置', + 'type' => 'object', + 'properties' => [ + 'comparisonOperator' => ['title' => '比较操作符', 'type' => 'string'], + 'statistics' => ['title' => '统计方法', 'type' => 'string'], + 'threshold' => ['title' => '阈值', 'type' => 'string'], + 'severity' => [ + 'title' => '严重等级', 'type' => 'string', - 'example' => '"2025-04-05T10:30:00Z"', + 'enum' => ['CRITICAL', 'ERROR', 'WARNING', 'INFO'], ], - 'timestamp' => [ - 'description' => '事件发生时间的时间戳', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1743846600000', - ], - 'subject' => [ - 'description' => '事件主题或标题，简要描述事件内容', + 'times' => ['title' => '连续触发次数', 'type' => 'integer', 'format' => 'int32'], + 'preCondition' => ['title' => '前置条件', 'type' => 'string'], + ], + ], + 'CmsEventForView' => [ + 'description' => '事件展示对象，包含事件的核心信息和上下文', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => '事件唯一标识符（全局唯一 ID），由系统生成', 'type' => 'string', 'example' => '"event-1234567890"'], + 'dedupId' => ['description' => '去重 ID，用于识别同一事件的不同实例（如重复上报）', 'type' => 'string', 'example' => '"dedup-abc123"'], + 'type' => ['description' => '事件类型', 'type' => 'string', 'example' => '"Alert"'], + 'subtype' => ['description' => '事件子类型', 'type' => 'string', 'example' => '"HighCPUUsage"'], + 'source' => ['description' => '事件来源系统或服务名称（如 ECS、RDS、VPC 等）', 'type' => 'string', 'example' => '"ECS"'], + 'time' => ['description' => '事件发生时间', 'type' => 'string', 'example' => '"2025-04-05T10:30:00Z"'], + 'timestamp' => ['description' => '事件发生时间的时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1743846600000'], + 'subject' => ['description' => '事件主题或标题，简要描述事件内容', 'type' => 'string', 'example' => '"Instance cpu usage exceeds threshold"'], + 'severity' => ['description' => '事件严重级别', 'type' => 'string', 'example' => '"CRITICAL"'], + 'status' => ['description' => '事件当前状态', 'type' => 'string', 'example' => 'Running'], + 'resource' => ['description' => '事件关联的资源信息，例如实例 ID、IP、地域等', '$ref' => '#/components/schemas/EventResourceForEventView'], + 'labels' => ['description' => '事件标签键值对', 'type' => 'object', 'example' => '{\'source\': \'system\'}'], + 'annotations' => ['description' => '事件附加注解信息，非结构化描述字段', 'type' => 'object', 'example' => '{ "description": "High load detected on server", "operator": "auto" }'], + 'dataschema' => ['description' => '数据模式定义，用于描述 data 字段的结构', 'type' => 'string', 'example' => '"https://schema.alibabacloud.com/cms/alert/v1"'], + 'datacontenttype' => ['description' => 'data 字段的内容类型', 'type' => 'string', 'example' => '"application/json"'], + 'data' => ['description' => '事件携带的原始数据，具体格式取决于事件类型和 dataschema', 'type' => 'any', 'example' => '{ "metricName": "cpu_usage", "value": 95.2, "threshold": 80 }'], + 'receiveTime' => ['description' => '事件被接收处理的时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1743846610000'], + 'workspace' => ['description' => '所属工作空间（Workspace）ID 或名称，用于多租户或组织隔离', 'type' => 'string', 'example' => '"ws-abc123"'], + 'workspaceTags' => ['description' => '工作空间标签，便于按标签维度管理事件', 'type' => 'object', 'example' => '{ "department": "finance", "project": "payment-gateway" }'], + 'sysId' => ['description' => '系统内部事件 ID，用于内部追踪和日志关联', 'type' => 'string', 'example' => '"sys-event-987654321"'], + 'integrationUuid' => ['description' => '集成唯一标识，用于跨系统集成时的身份识别', 'type' => 'string', 'example' => '"integration-xyz"'], + 'sourcetype' => ['description' => '事件源类型，区分是来自监控系统、日志服务、应用观测等', 'type' => 'string', 'example' => '"CloudMonitor"'], + ], + ], + 'ConditionConfigUnified' => [ + 'title' => '检测条件配置聚合（PROMETHEUS_SIMPLE_CONDITION / UMODEL_METRICSET_CONDITION / UMODEL_LOGSET_CONDITION / UMODEL_METRICSET_MULTI_CONDITION / APM_SIMPLE_CONDITION / APM_COMPOSITE_CONDITION / CLOUD_MONITORING_CONDITION / UNKNOWN_CONDITION）', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'title' => '检测条件类型', 'type' => 'string', - 'example' => '"Instance cpu usage exceeds threshold"', + 'required' => true, + 'enum' => ['PROMETHEUS_SIMPLE_CONDITION', 'UMODEL_METRICSET_CONDITION', 'UMODEL_LOGSET_CONDITION', 'UMODEL_METRICSET_MULTI_CONDITION', 'APM_SIMPLE_CONDITION', 'APM_COMPOSITE_CONDITION', 'CLOUD_MONITORING_CONDITION', 'UNKNOWN_CONDITION'], ], + 'durationSecs' => ['title' => '持续时间（秒）；PROMETHEUS_SIMPLE / UMODEL_METRICSET_CONDITION / UMODEL_LOGSET_CONDITION 直接使用；UMODEL_METRICSET_MULTI_CONDITION 作全局默认值，各 trigger 可通过自身 durationSecs 覆盖', 'type' => 'integer', 'format' => 'int32'], 'severity' => [ - 'description' => '事件严重级别', + 'title' => '严重等级（UMODEL_METRICSET_CONDITION / UMODEL_LOGSET_CONDITION / PROMETHEUS_SIMPLE / APM_COMPOSITE）', 'type' => 'string', - 'example' => '"CRITICAL"', + 'enum' => ['INFO', 'WARN', 'WARNING', 'ERROR', 'CRITICAL'], ], - 'status' => [ - 'description' => '事件当前状态', + 'operator' => [ + 'title' => '比较操作符。UMODEL_METRICSET_CONDITION 用 GT（大于）/ GE（大于等于）/ LT（小于）/ LE（小于等于）/ EQ（等于）/ NE（不等于）/ IN_RANGE（在区间内，需同时填 min/max）/ OUT_OF_RANGE（在区间外，需同时填 min/max）/ PRESENT（字段存在）/ NOT_PRESENT（字段不存在）；UMODEL_LOGSET_CONDITION 不使用本字段；APM_SIMPLE_CONDITION 用 GT/GTE/LT/LTE/EQ/NE/YOY_UP/YOY_DOWN（YOY_* 需同时填 yoyTimeUnit/yoyTimeValue）', 'type' => 'string', - 'example' => 'Running', - ], - 'resource' => [ - 'description' => '事件关联的资源信息，例如实例 ID、IP、地域等', - '$ref' => '#/components/schemas/EventResourceForEventView', + 'enum' => ['GT', 'GE', 'GTE', 'LT', 'LE', 'LTE', 'EQ', 'NE', 'IN_RANGE', 'OUT_OF_RANGE', 'PRESENT', 'NOT_PRESENT', 'YOY_UP', 'YOY_DOWN'], ], - 'labels' => [ - 'description' => '事件标签键值对', - 'type' => 'object', - 'example' => '{\'source\': \'system\'}', - ], - 'annotations' => [ - 'description' => '事件附加注解信息，非结构化描述字段', - 'type' => 'object', - 'example' => '{ "description": "High load detected on server", "operator": "auto" }', + 'threshold' => ['title' => '阈值（UMODEL_METRICSET_CONDITION 非区间算子时使用）', 'type' => 'number', 'format' => 'double'], + 'min' => ['title' => '区间下界（UMODEL_METRICSET_CONDITION 且 operator=IN_RANGE/OUT_OF_RANGE 时使用）', 'type' => 'number', 'format' => 'double'], + 'max' => ['title' => '区间上界（UMODEL_METRICSET_CONDITION 且 operator=IN_RANGE/OUT_OF_RANGE 时使用）', 'type' => 'number', 'format' => 'double'], + 'aggregate' => [ + 'title' => '聚合函数（APM_SIMPLE_CONDITION 使用；UMODEL 条件已将该语义迁移至 QueryConfigUnified，本字段对 UModel 条件不再生效）', + 'type' => 'string', + 'enum' => ['AVG', 'SUM', 'COUNT', 'CONTINUES', 'MAX', 'MIN', 'P50', 'P75', 'P90', 'P99'], ], - 'dataschema' => [ - 'description' => '数据模式定义，用于描述 data 字段的结构', + 'matchField' => ['title' => '日志字段名（type=UMODEL_LOGSET_CONDITION 且 matchOperator=CONTAINS/EQUALS/REGEX 时使用）', 'type' => 'string'], + 'matchOperator' => [ + 'title' => '日志匹配操作符（type=UMODEL_LOGSET_CONDITION）', 'type' => 'string', - 'example' => '"https://schema.alibabacloud.com/cms/alert/v1"', + 'enum' => ['PRESENT', 'NOT_PRESENT', 'CONTAINS', 'EQUALS', 'REGEX'], ], - 'datacontenttype' => [ - 'description' => 'data 字段的内容类型', + 'matchValue' => ['title' => '日志匹配值（type=UMODEL_LOGSET_CONDITION 且 matchOperator=CONTAINS/EQUALS/REGEX 时使用）', 'type' => 'string'], + 'countOperator' => [ + 'title' => '数量比较操作符（type=UMODEL_LOGSET_CONDITION）', 'type' => 'string', - 'example' => '"application/json"', + 'enum' => ['GTE', 'GT', 'EQ', 'LTE', 'LT'], ], - 'data' => [ - 'description' => '事件携带的原始数据，具体格式取决于事件类型和 dataschema', - 'type' => 'any', - 'example' => '{ "metricName": "cpu_usage", "value": 95.2, "threshold": 80 }', + 'countThreshold' => ['title' => '数量阈值（type=UMODEL_LOGSET_CONDITION）', 'type' => 'integer', 'format' => 'int64'], + 'thresholdList' => [ + 'title' => '多阈值列表（APM_SIMPLE_CONDITION）', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/ApmThresholdConfig'], ], - 'receiveTime' => [ - 'description' => '事件被接收处理的时间戳', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1743846610000', + 'compareList' => [ + 'title' => '多条比较（APM_COMPOSITE_CONDITION）', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/ApmCompositeCompareConfig'], ], - 'workspace' => [ - 'description' => '所属工作空间（Workspace）ID 或名称，用于多租户或组织隔离', + 'relation' => [ + 'title' => '条件间逻辑关系（APM_COMPOSITE_CONDITION）', 'type' => 'string', - 'example' => '"ws-abc123"', - ], - 'workspaceTags' => [ - 'description' => '工作空间标签，便于按标签维度管理事件', - 'type' => 'object', - 'example' => '{ "department": "finance", "project": "payment-gateway" }', + 'enum' => ['OR', 'AND'], ], - 'sysId' => [ - 'description' => '系统内部事件 ID，用于内部追踪和日志关联', + 'escalationType' => [ + 'title' => '上报策略类型（CLOUD_MONITORING_CONDITION）', 'type' => 'string', - 'example' => '"sys-event-987654321"', + 'enum' => ['simple', 'composite', 'express', 'prometheus'], ], - 'integrationUuid' => [ - 'description' => '集成唯一标识，用于跨系统集成时的身份识别', + 'simpleEscalation' => ['title' => '单度量触发（CLOUD_MONITORING_CONDITION，escalationType=simple 时非空）', '$ref' => '#/components/schemas/CloudMonitoringSimpleEscalation'], + 'compositeEscalation' => ['title' => '多度量复合触发（CLOUD_MONITORING_CONDITION，escalationType=composite 时非空）', '$ref' => '#/components/schemas/CloudMonitoringCompositeEscalation'], + 'expressEscalation' => ['title' => '表达式触发（CLOUD_MONITORING_CONDITION，escalationType=express 时非空）', '$ref' => '#/components/schemas/CloudMonitoringExpressEscalation'], + 'prometheus' => ['title' => 'PromQL 触发（CLOUD_MONITORING_CONDITION，escalationType=prometheus 时非空）', '$ref' => '#/components/schemas/CloudMonitoringPrometheusEscalation'], + 'noDataPolicy' => ['title' => '无数据处理策略（CLOUD_MONITORING_CONDITION）', 'type' => 'string'], + 'legacyType' => ['title' => '当 type=UNKNOWN_CONDITION 时返回，用于标识本规则当前不可在新 API 上编辑；请提服务工单联系云监控产品团队', 'type' => 'string'], + 'yoyTimeUnit' => [ + 'title' => '同比时间单位（APM_SIMPLE_CONDITION，仅 operator=YOY_UP/YOY_DOWN 生效）', 'type' => 'string', - 'example' => '"integration-xyz"', + 'enum' => ['minute', 'hour', 'day', 'week', 'month'], ], - 'sourcetype' => [ - 'description' => '事件源类型，区分是来自监控系统、日志服务、应用观测等', - 'type' => 'string', - 'example' => '"CloudMonitor"', + 'yoyTimeValue' => ['title' => '同比时间值（APM_SIMPLE_CONDITION，仅 operator=YOY_UP/YOY_DOWN 生效）', 'type' => 'integer', 'format' => 'int32'], + 'triggers' => [ + 'title' => '触发条件列表（type=UMODEL_METRICSET_MULTI_CONDITION），每个 trigger 含 severity、durationSecs 与表达式（SIMPLE/COMPOSITE）；SIMPLE 类型的 queryName/operator/threshold 直接平铺在 trigger 中，COMPOSITE 类型的 logicOperator/conditions 直接平铺在 trigger 中；按 severity 优先级排序，首个匹配触发', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/MetricSetMultiTrigger'], ], + 'enableSeveritySuppression' => ['title' => '是否启用 severity 就高抑制（type=UMODEL_METRICSET_MULTI_CONDITION），默认 true；启用时同一实体仅上报最高级别触发', 'type' => 'boolean'], + 'legacyRaw' => ['title' => '当 type=UNKNOWN_CONDITION 且为读路径解析失败兜底时返回的原始 V1 condition JSON 字符串。前端见此字段非空时仅做只读展示。', 'type' => 'string'], ], ], 'ContactForIncidentView' => [ 'description' => '联系人展示对象', 'type' => 'object', 'properties' => [ - 'contactId' => [ - 'description' => '联系人id', - 'type' => 'string', - 'example' => '"contact-123456"', - ], - 'name' => [ - 'description' => '联系人名称', - 'type' => 'string', - 'example' => '"张三"', - ], + 'contactId' => ['description' => '联系人id', 'type' => 'string', 'example' => '"contact-123456"'], + 'name' => ['description' => '联系人名称', 'type' => 'string', 'example' => '"张三"'], ], ], - 'DataStorageItem' => [ + 'CustomExtractionStrategy' => [ + 'description' => '自定义提取策略', 'type' => 'object', 'properties' => [ - 'storeType' => [ - 'type' => 'string', - ], - 'regionId' => [ - 'type' => 'string', - ], - 'dataType' => [ + 'strategyName' => ['description' => '策略名称', 'type' => 'string', 'example' => 'test1'], + 'strategyType' => ['description' => '策略类型，支持 "Episodic", "Summary", "Fact"。', 'type' => 'string', 'example' => 'Fact'], + 'extractionPrompt' => ['description' => '提取提示', 'type' => 'string', 'example' => 'test'], + 'updatePrompt' => ['description' => '更新提示', 'type' => 'string', 'example' => 'test'], + 'description' => ['description' => '描述', 'type' => 'string', 'example' => 'test'], + ], + ], + 'DatasourceConfigUnified' => [ + 'title' => '数据源配置聚合（PROMETHEUS / UMODEL / APM / CLOUD_MONITORING / UNKNOWN 共用一对象，按 type 选用字段）', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'title' => '数据源类型', 'type' => 'string', + 'required' => true, + 'enum' => ['PROMETHEUS', 'UMODEL', 'APM', 'CLOUD_MONITORING', 'UNKNOWN'], ], - 'project' => [ + 'instanceId' => ['title' => 'Prometheus 实例 ID（type=PROMETHEUS 时使用）', 'type' => 'string'], + 'regionId' => ['title' => '地域 ID（各类型可选，缺省与规则/网关一致）', 'type' => 'string'], + 'productCategory' => ['title' => '云产品分类（type=CLOUD_MONITORING）；当来源缺失该信息时输出 unknown', 'type' => 'string'], + 'legacyType' => ['title' => '当 type=UNKNOWN 时返回，用于标识本规则当前不可在新 API 上编辑；请提服务工单联系云监控产品团队', 'type' => 'string'], + 'legacyRaw' => ['title' => '当 type=UNKNOWN 且为读路径解析失败兜底时返回的原始 V1 datasource JSON 字符串。前端见此字段非空时仅做只读展示。', 'type' => 'string'], + ], + ], + 'DatasourceTypeFilter' => [ + 'title' => '数据源类型过滤（精确匹配，如 APM_DS）', + 'type' => 'object', + 'properties' => [ + 'eq' => ['title' => '精确匹配', 'type' => 'string'], + ], + ], + 'DirectNotifyChannel' => [ + 'title' => '直接通知渠道', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'title' => '通知渠道类型', 'type' => 'string', + 'required' => true, + 'enum' => ['CONTACT', 'GROUP', 'DINGTALK', 'FEISHU', 'SLACK', 'WEIXIN', 'WEBHOOK'], ], - 'storeName' => [ - 'type' => 'string', + 'identifiers' => [ + 'title' => '通知对象标识列表', + 'type' => 'array', + 'items' => ['type' => 'string'], + 'required' => true, ], ], ], + 'DisplayNameFilter' => [ + 'title' => '显示名称过滤', + 'type' => 'object', + 'properties' => [ + 'contains' => ['type' => 'string'], + 'notContains' => ['type' => 'string'], + ], + ], 'EffectTimeRange' => [ 'description' => '生效时间范围配置对象', 'type' => 'object', @@ -2567,235 +1906,139 @@ 'dayInWeek' => [ 'description' => '0-6 标志周日到周六', 'type' => 'array', - 'items' => [ - 'description' => '0-6 标志周日到周六', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '[1, 2, 3]', - ], - ], - 'startTimeInMinute' => [ - 'description' => '开始时间(分钟数)', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '360', - ], - 'endTimeInMinute' => [ - 'description' => '结束时间(分钟数)', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1080', - ], - 'timeZone' => [ - 'description' => '时区', - 'type' => 'string', - 'example' => '"Asia/Shanghai"', + 'items' => ['description' => '0-6 标志周日到周六', 'type' => 'integer', 'format' => 'int32', 'example' => '[1, 2, 3]'], ], + 'startTimeInMinute' => ['description' => '开始时间(分钟数)', 'type' => 'integer', 'format' => 'int32', 'example' => '360'], + 'endTimeInMinute' => ['description' => '结束时间(分钟数)', 'type' => 'integer', 'format' => 'int32', 'example' => '1080'], + 'timeZone' => ['description' => '时区', 'type' => 'string', 'example' => '"Asia/Shanghai"'], + ], + ], + 'EnabledFilter' => [ + 'title' => '启用状态过滤', + 'type' => 'object', + 'properties' => [ + 'eq' => ['title' => '精确匹配', 'type' => 'boolean'], ], ], 'EntityDiscoverRule' => [ 'description' => '实体发现规则模型', 'type' => 'object', 'properties' => [ + 'resourceGroupId' => ['title' => '资源组ID。', 'description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-acfm2m7atreujs1'], 'ipMatchRule' => [ - 'title' => 'IP匹配规则集合。', + 'title' => 'IP 匹配规则', 'description' => 'IP匹配规则集合。', - 'type' => 'array', + 'type' => 'object', 'items' => [ 'title' => 'IP匹配规则。', 'description' => 'IP匹配规则。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'ipFieldKey' => [ - 'title' => 'IP字段的Key。', - 'description' => 'IP字段的Key。', - 'type' => 'string', - 'example' => 'hostIp', - ], - 'ipCIDR' => [ - 'title' => 'IP的CIDR。', - 'description' => 'IP的CIDR。', - 'type' => 'string', - 'example' => '192.168.0.1/10', - ], + 'ipFieldKey' => ['title' => 'IP字段的Key。', 'description' => 'IP字段的Key。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'hostIp', 'backendName' => 'ipFieldKey'], + 'ipCIDR' => ['title' => 'IP的CIDR。', 'description' => 'IP的CIDR。', 'visibility' => 'Public', 'type' => 'string', 'example' => '192.168.0.1/10', 'backendName' => 'ipCIDR'], ], + 'extendType' => 'true', ], - ], - 'instanceIds' => [ - 'title' => '实例ID集合。', - 'description' => '实例ID集合。', - 'type' => 'array', - 'items' => [ - 'title' => '实例ID。', - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'i-bp1gj8wyq4fxk28k6iy2', - ], - ], - 'fieldRules' => [ - 'title' => '属性匹配规则。', - 'description' => '属性匹配规则。', - 'type' => 'array', - 'items' => [ - 'title' => '属性详情。', - 'description' => '属性详情。', - 'type' => 'object', - 'properties' => [ - 'op' => [ - 'title' => '操作。', - 'description' => '操作。', - 'type' => 'string', - 'example' => 'in', - ], - 'fieldKey' => [ - 'title' => '属性的Key。', - 'description' => '属性的Key。', - 'type' => 'string', - 'example' => 'instanceId', - ], - 'fieldValues' => [ - 'title' => '属性的值集合。', - 'description' => '属性的值集合。', - 'type' => 'array', - 'items' => [ - 'title' => '属性的值。', - 'description' => '属性的值。', - 'type' => 'string', - 'example' => 'i-bp1gj8wyq4fxk28k6iy2', - ], - ], - ], + 'properties' => [ + 'ipFieldKey' => ['title' => 'IP 的属性 Key', 'type' => 'string'], + 'ipCIDR' => ['title' => 'IP 的网段 CIDR', 'type' => 'string'], ], ], - 'annotations' => [ - 'title' => '注解匹配集合。', - 'description' => '注解匹配集合。', + 'tags' => [ + 'title' => '通过Tag进行服务发现。', + 'description' => '通过Tag进行服务发现。', 'type' => 'array', 'items' => [ - 'title' => '注解详情。', - 'description' => '注解详情。', + 'title' => '使用Tag的发现信息。', + 'description' => '使用Tag的发现信息。', 'type' => 'object', 'properties' => [ - 'op' => [ - 'title' => '操作。', - 'description' => '操作。', - 'type' => 'string', - 'example' => 'in', - ], - 'tagKey' => [ - 'title' => '注解的Key。', - 'description' => '注解的Key。', - 'type' => 'string', - 'example' => 'instanceId', - ], + 'tagKey' => ['title' => 'Tag的Key。', 'description' => 'Tag的Key。', 'type' => 'string', 'example' => 'project'], + 'op' => ['title' => '操作。', 'description' => '操作。', 'type' => 'string', 'example' => 'in'], 'tagValues' => [ - 'title' => '注解的值集合。', - 'description' => '注解的值集合。', + 'title' => 'Tag的值集合。', + 'description' => 'Tag的值集合。', 'type' => 'array', - 'items' => [ - 'title' => '注解的值。', - 'description' => '注解的值。', - 'type' => 'string', - 'example' => 'i-bp1gj8wyq4fxk28k6iy2'."\n", - ], + 'items' => ['title' => 'Tag的值。', 'description' => 'Tag的值。', 'type' => 'string', 'example' => 'demo'], ], ], ], ], - 'resourceGroupId' => [ - 'title' => '资源组ID。', - 'description' => '资源组ID。', - 'type' => 'string', - 'example' => 'rg-acfm2m7atreujs1', + 'instanceIds' => [ + 'title' => '实例ID集合。', + 'description' => '实例ID集合。', + 'type' => 'array', + 'items' => ['title' => '实例ID。', 'description' => '实例ID。', 'type' => 'string', 'example' => 'i-bp1gj8wyq4fxk28k6iy2'], ], 'entityTypes' => [ 'title' => '实体类型集合。', 'description' => '实体类型集合。', 'type' => 'array', - 'items' => [ - 'title' => '实体类型。', - 'description' => '实体类型。', - 'type' => 'string', - 'example' => 'acs.ecs.instance', - ], + 'items' => ['title' => '实体类型。', 'description' => '实体类型。', 'type' => 'string', 'example' => 'acs.ecs.instance'], ], 'regionIds' => [ 'title' => '地域ID集合。', 'description' => '地域ID集合。', 'type' => 'array', + 'items' => ['title' => '地域ID。', 'description' => '地域ID。', 'type' => 'string', 'example' => 'cn-shanghai'], + ], + 'labels' => [ + 'title' => '标签匹配集合。', + 'description' => '标签匹配集合。', + 'type' => 'array', 'items' => [ - 'title' => '地域ID。', - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-shanghai', + 'title' => '标签详情。', + 'description' => '标签详情。', + 'type' => 'object', + 'properties' => [ + 'tagKey' => ['title' => '标签的Key。', 'description' => '标签的Key。', 'type' => 'string', 'example' => 'project'], + 'op' => ['title' => '操作。', 'description' => '操作。', 'type' => 'string', 'example' => 'in'], + 'tagValues' => [ + 'title' => '标签的值集合。', + 'description' => '标签的值集合。', + 'type' => 'array', + 'items' => ['title' => '标签的值。', 'description' => '标签的值。', 'type' => 'string', 'example' => 'demo'], + ], + ], ], ], - 'tags' => [ - 'title' => '通过Tag进行服务发现。', - 'description' => '通过Tag进行服务发现。', + 'annotations' => [ + 'title' => '注解匹配集合。', + 'description' => '注解匹配集合。', 'type' => 'array', 'items' => [ - 'title' => '使用Tag的发现信息。', - 'description' => '使用Tag的发现信息。', + 'title' => '注解详情。', + 'description' => '注解详情。', 'type' => 'object', 'properties' => [ - 'op' => [ - 'title' => '操作。', - 'description' => '操作。', - 'type' => 'string', - 'example' => 'in', - ], - 'tagKey' => [ - 'title' => 'Tag的Key。', - 'description' => 'Tag的Key。', - 'type' => 'string', - 'example' => 'project', - ], + 'tagKey' => ['title' => '注解的Key。', 'description' => '注解的Key。', 'type' => 'string', 'example' => 'instanceId'], + 'op' => ['title' => '操作。', 'description' => '操作。', 'type' => 'string', 'example' => 'in'], 'tagValues' => [ - 'title' => 'Tag的值集合。', - 'description' => 'Tag的值集合。', + 'title' => '注解的值集合。', + 'description' => '注解的值集合。', 'type' => 'array', - 'items' => [ - 'title' => 'Tag的值。', - 'description' => 'Tag的值。', - 'type' => 'string', - 'example' => 'demo', - ], + 'items' => ['title' => '注解的值。', 'description' => '注解的值。', 'type' => 'string', 'example' => 'i-bp1gj8wyq4fxk28k6iy2'."\n"], ], ], ], ], - 'labels' => [ - 'title' => '标签匹配集合。', - 'description' => '标签匹配集合。', + 'fieldRules' => [ + 'title' => '属性匹配规则。', + 'description' => '属性匹配规则。', 'type' => 'array', 'items' => [ - 'title' => '标签详情。', - 'description' => '标签详情。', + 'title' => '属性详情。', + 'description' => '属性详情。', 'type' => 'object', 'properties' => [ - 'op' => [ - 'title' => '操作。', - 'description' => '操作。', - 'type' => 'string', - 'example' => 'in', - ], - 'tagKey' => [ - 'title' => '标签的Key。', - 'description' => '标签的Key。', - 'type' => 'string', - 'example' => 'project', - ], - 'tagValues' => [ - 'title' => '标签的值集合。', - 'description' => '标签的值集合。', + 'fieldKey' => ['title' => '属性的Key。', 'description' => '属性的Key。', 'type' => 'string', 'example' => 'instanceId'], + 'op' => ['title' => '操作。', 'description' => '操作。', 'type' => 'string', 'example' => 'in'], + 'fieldValues' => [ + 'title' => '属性的值集合。', + 'description' => '属性的值集合。', 'type' => 'array', - 'items' => [ - 'title' => '标签的值。', - 'description' => '标签的值。', - 'type' => 'string', - 'example' => 'demo', - ], + 'items' => ['title' => '属性的值。', 'description' => '属性的值。', 'type' => 'string', 'example' => 'i-bp1gj8wyq4fxk28k6iy2'], ], ], ], @@ -2805,104 +2048,50 @@ 'EntityGroupBase' => [ 'title' => '实体的基础结构。', 'description' => '实体的基础结构。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'workspace' => [ - 'title' => '工作空间。', - 'description' => '工作空间。', - 'type' => 'string', - 'example' => 'default-cms-1654218***343050-cn-hangzhou', - ], - 'regionId' => [ - 'title' => '地域ID。', - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-heyuan', - ], + 'workspace' => ['title' => '工作空间。', 'description' => '工作空间。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'default-cms-1654218***343050-cn-hangzhou', 'backendName' => 'workspace'], + 'regionId' => ['title' => '地域ID。', 'description' => '地域ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'cn-heyuan', 'backendName' => 'regionId'], 'entityQueries' => [ 'title' => '实体查询规则集合。', 'description' => '实体查询规则集合。', + 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'title' => '实体查询规则。', 'description' => '实体查询规则。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'entityType' => [ - 'title' => '实体类型。', - 'description' => '实体类型。', - 'type' => 'string', - 'example' => 'acs.ecs.instance', - ], - 'spl' => [ - 'title' => 'SPL查询语句。', - 'description' => 'SPL查询语句。', - 'type' => 'string', - 'example' => '.entity with(type=\'acs.ecs.instance\') | where region_id in (\'cn-beijing\')', - ], + 'entityType' => ['title' => '实体类型。', 'description' => '实体类型。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'acs.ecs.instance', 'backendName' => 'entityType'], + 'spl' => ['title' => 'SPL查询语句。', 'description' => 'SPL查询语句。', 'visibility' => 'Public', 'type' => 'string', 'example' => '.entity with(type=\'acs.ecs.instance\') | where region_id in (\'cn-beijing\')', 'backendName' => 'spl'], ], + 'extendType' => 'true', ], + 'backendName' => 'entityQueries', ], - 'description' => [ - 'title' => '实体描述。', - 'description' => '实体描述。', - 'type' => 'string', - 'example' => 'ECS 实例', - ], - 'entityGroupId' => [ - 'title' => '实体ID。', - 'description' => '实体ID。', - 'type' => 'string', - 'example' => 'eg-1234567890', - ], - 'entityRules' => [ - 'title' => '用于实体发现的规则。', - 'description' => '用于实体发现的规则。', - '$ref' => '#/components/schemas/EntityDiscoverRule', - ], - 'entityGroupName' => [ - 'title' => '实体名称。', - 'description' => '实体名称。', - 'type' => 'string', - 'example' => 'ECS 全部实体', - ], - 'userId' => [ - 'title' => '用户ID。', - 'description' => '用户ID。', - 'type' => 'string', - 'example' => '1654218***343050', - ], + 'description' => ['title' => '实体描述。', 'description' => '实体描述。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'ECS 实例', 'backendName' => 'description'], + 'entityGroupId' => ['title' => '实体ID。', 'description' => '实体ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'eg-1234567890', 'backendName' => 'entityGroupId'], + 'entityRules' => ['title' => '用于实体发现的规则。', 'description' => '用于实体发现的规则。', 'visibility' => 'Public', 'backendName' => 'entityRules', '$ref' => '#/components/schemas/EntityDiscoverRule'], + 'entityGroupName' => ['title' => '实体名称。', 'description' => '实体名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'ECS 全部实体', 'backendName' => 'entityGroupName'], + 'userId' => ['title' => '用户ID。', 'description' => '用户ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => '1654218***343050', 'backendName' => 'userId'], ], ], 'Evaluator' => [ 'type' => 'object', 'properties' => [ - 'name' => [ - 'type' => 'string', - ], - 'resultName' => [ - 'type' => 'string', - ], - 'dataScope' => [ - 'type' => 'string', - ], - 'resultType' => [ - 'type' => 'string', - ], - 'config' => [ - 'type' => 'object', - ], + 'name' => ['type' => 'string'], + 'resultName' => ['type' => 'string'], + 'resultType' => ['type' => 'string'], + 'config' => ['type' => 'object'], 'filters' => [ 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - ], + 'additionalProperties' => ['type' => 'string'], ], 'variableMapping' => [ 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - ], + 'additionalProperties' => ['type' => 'string'], ], ], ], @@ -2914,137 +2103,152 @@ 'description' => '资源实体信息', 'type' => 'object', 'properties' => [ - 'domain' => [ - 'description' => '资源所属的产品域（Product Domain）', - 'type' => 'string', - 'example' => '"ECS"', - ], - 'entityType' => [ - 'description' => '资源的具体类型', - 'type' => 'string', - 'example' => '"Instance"', - ], - 'entityId' => [ - 'description' => '实例ID', - 'type' => 'string', - 'example' => '"i-bp123456"', - ], - 'prop' => [ - 'description' => '资源的额外属性字段', - 'type' => 'object', - 'example' => '{ "name": "web-server-01", "ip": "10.0.0.1" }', - ], + 'domain' => ['description' => '资源所属的产品域（Product Domain）', 'type' => 'string', 'example' => '"ECS"'], + 'entityType' => ['description' => '资源的具体类型', 'type' => 'string', 'example' => '"Instance"'], + 'entityId' => ['description' => '实例ID', 'type' => 'string', 'example' => '"i-bp123456"'], + 'prop' => ['description' => '资源的额外属性字段', 'type' => 'object', 'example' => '{ "name": "web-server-01", "ip": "10.0.0.1" }'], ], ], - 'tags' => [ - 'description' => '标签信息。', - 'type' => 'object', - 'example' => '{ "env": "prod", "project": "payment-gateway" }', - ], + 'tags' => ['description' => '标签信息。', 'type' => 'object', 'example' => '{ "env": "prod", "project": "payment-gateway" }'], ], ], 'EventResourceForIncidentView' => [ 'description' => '事件关联资源展示对象', 'type' => 'object', 'properties' => [ - 'tags' => [ - 'description' => '标签。', - 'type' => 'string', - 'example' => '[{\\"value\\":\\"测试\\",\\"key\\":\\"环境\\"}]', - ], - 'probs' => [ - 'description' => '资源的属性描述字符串', - 'type' => 'string', - 'example' => '"{"name":"web-server-01","ip":"10.0.0.1"}"', + 'tags' => ['description' => '标签。', 'type' => 'string', 'example' => '[{\\"value\\":\\"测试\\",\\"key\\":\\"环境\\"}]'], + 'probs' => ['description' => '资源的属性描述字符串', 'type' => 'string', 'example' => '"{"name":"web-server-01","ip":"10.0.0.1"}"'], + 'entityType' => ['description' => '实体类型。', 'type' => 'string', 'example' => '"Instance"'], + 'entityId' => ['description' => '实体id', 'type' => 'string', 'example' => 'default'], + 'domain' => ['description' => '资源类型域。', 'type' => 'string', 'example' => 'rum'], + ], + ], + 'ExperimentConfig' => [ + 'type' => 'object', + 'properties' => [ + 'label' => ['type' => 'string'], + 'name' => ['type' => 'string'], + 'modelName' => ['type' => 'string'], + 'modelProvider' => ['type' => 'string'], + 'modelParameters' => ['$ref' => '#/components/schemas/ModelParameters'], + 'endpointConnectorId' => ['type' => 'string'], + 'promptTemplate' => [ + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/PromptTemplateItem'], ], - 'entityType' => [ - 'description' => '实体类型。', - 'type' => 'string', - 'example' => '"Instance"', + ], + ], + 'ExperimentPlanData' => [ + 'type' => 'object', + 'properties' => [ + 'planId' => ['type' => 'string'], + 'planName' => ['type' => 'string'], + 'description' => ['type' => 'string'], + 'status' => ['type' => 'string'], + 'datasetId' => ['type' => 'string'], + 'experimentCount' => ['type' => 'integer', 'format' => 'int32'], + 'createdAt' => ['type' => 'integer', 'format' => 'int64'], + 'updatedAt' => ['type' => 'integer', 'format' => 'int64'], + ], + ], + 'ExperimentRecord' => [ + 'type' => 'object', + 'properties' => [ + 'planId' => ['type' => 'string'], + 'experimentName' => ['type' => 'string'], + 'status' => ['type' => 'string'], + 'totalTasks' => ['type' => 'integer', 'format' => 'int32'], + 'failedTasks' => ['type' => 'integer', 'format' => 'int32'], + 'completedTasks' => ['type' => 'integer', 'format' => 'int32'], + 'progress' => ['type' => 'number', 'format' => 'float'], + 'executedAt' => ['type' => 'integer', 'format' => 'int64'], + 'completedAt' => ['type' => 'integer', 'format' => 'int64'], + 'datasetId' => ['type' => 'string'], + 'planName' => ['type' => 'string'], + 'recordId' => ['type' => 'string'], + 'experimentConfig' => ['$ref' => '#/components/schemas/ExperimentConfig'], + 'dataSourceType' => ['type' => 'string'], + 'modelName' => ['type' => 'string'], + 'errorMessage' => ['type' => 'string'], + 'datasetProject' => ['type' => 'string'], + 'evaluators' => [ + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/Evaluator'], ], - 'entityId' => [ - 'description' => '实体id', - 'type' => 'string', - 'example' => 'default', + 'input' => ['type' => 'object'], + 'selectedItemIds' => [ + 'type' => 'array', + 'items' => ['type' => 'string'], ], - 'domain' => [ - 'description' => '资源类型域。', + ], + ], + 'Filter' => [ + 'description' => '过滤条件（同级字段 AND）', + 'type' => 'object', + 'properties' => [ + 'uuid' => ['$ref' => '#/components/schemas/UuidFilter'], + 'displayName' => ['$ref' => '#/components/schemas/DisplayNameFilter'], + 'labels' => ['$ref' => '#/components/schemas/LabelsFilter'], + 'status' => ['$ref' => '#/components/schemas/StatusFilter'], + 'enabled' => ['$ref' => '#/components/schemas/EnabledFilter'], + ], + ], + 'FilterCondition' => [ + 'title' => '过滤条件', + 'description' => '事件过滤的单条 field/op/value 三元组', + 'type' => 'object', + 'properties' => [ + 'field' => ['title' => '字段名', 'type' => 'string'], + 'op' => [ + 'title' => '操作符', 'type' => 'string', - 'example' => 'rum', + 'enum' => ['EQ', 'EQI', 'START_WITH', 'END_WITH', 'CONTAIN', 'NOT_CONTAIN', 'IN', 'NOT_IN', 'KEYWORD', 'KEYWORD_ALL_MATCH', 'KEYWORD_NOT_MATCH', 'INTERSECT', 'NOT_INTERSECT', 'PATTERN', 'PATTERN_ALL_MATCH', 'PATTERN_NOT_IN', 'EXIST'], ], + 'value' => ['title' => '比较值', 'type' => 'string'], ], ], 'FilterSetting' => [ 'description' => '过滤配置', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'expression' => [ - 'title' => '表达式', - 'description' => '表达式', - 'type' => 'string', - 'example' => '1 and 2 or 3', - ], + 'expression' => ['title' => '表达式', 'description' => '表达式', 'visibility' => 'Public', 'type' => 'string', 'example' => '1 and 2 or 3', 'backendName' => 'expression'], 'conditions' => [ 'title' => '订阅条件', 'description' => '订阅条件', + 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '单个条件', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'op' => [ - 'title' => '比较符', - 'description' => '比较符', - 'type' => 'string', - 'example' => 'EQ', - ], - 'field' => [ - 'title' => '字段', - 'description' => '字段', - 'type' => 'string', - 'example' => 'severity', - ], - 'value' => [ - 'title' => '值', - 'description' => '值', - 'type' => 'string', - 'example' => 'CRITICAL', - ], + 'op' => ['title' => '比较符', 'description' => '比较符', 'visibility' => 'Public', 'type' => 'string', 'example' => 'EQ', 'backendName' => 'op'], + 'field' => ['title' => '字段', 'description' => '字段', 'visibility' => 'Public', 'type' => 'string', 'example' => 'severity', 'backendName' => 'field'], + 'value' => ['title' => '值', 'description' => '值', 'visibility' => 'Public', 'type' => 'string', 'example' => 'CRITICAL', 'backendName' => 'value'], ], + 'extendType' => 'true', ], 'maxItems' => 10, + 'backendName' => 'conditions', ], - 'relation' => [ - 'title' => '条件间关系', - 'description' => '条件间关系', - 'type' => 'string', - 'example' => 'AND', - ], + 'relation' => ['title' => '条件间关系', 'description' => '条件间关系', 'visibility' => 'Public', 'type' => 'string', 'example' => 'AND', 'backendName' => 'relation'], ], ], 'IncidentContactStruct' => [ 'description' => '事件联系人结构', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'contactId' => [ - 'description' => '联系人id', - 'type' => 'string', - 'example' => '627415', - ], + 'contactId' => ['description' => '联系人id', 'visibility' => 'Public', 'type' => 'string', 'example' => '627415', 'backendName' => 'contactId'], 'channel' => [ 'description' => '通道列表', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '通道名', - 'type' => 'string', - 'example' => 'ecs', - ], - ], - 'contactType' => [ - 'description' => '联系类型', - 'type' => 'string', - 'example' => 'GROUP', + 'items' => ['description' => '通道名', 'visibility' => 'Public', 'type' => 'string', 'example' => 'ecs', 'extendType' => 'true'], + 'backendName' => 'channel', ], + 'contactType' => ['description' => '联系类型', 'visibility' => 'Public', 'type' => 'string', 'example' => 'GROUP', 'backendName' => 'contactType'], ], ], 'IncidentEscalationPolicyForModify' => [ @@ -3052,32 +2256,13 @@ 'description' => '用于查看的实体', 'type' => 'object', 'properties' => [ - 'description' => [ - 'title' => '描述', - 'description' => '描述', - 'type' => 'string', - 'example' => 'workspace api monitor create test', - ], - 'enable' => [ - 'title' => '是否启用', - 'description' => '是否启用', - 'type' => 'boolean', - 'example' => 'false', - ], - 'name' => [ - 'title' => '名称', - 'description' => '名称', - 'type' => 'string', - 'required' => true, - 'example' => '"Critical-Alert-Escalation"', - ], + 'description' => ['title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'workspace api monitor create test'], + 'enable' => ['title' => '是否启用', 'description' => '是否启用', 'type' => 'boolean', 'example' => 'false'], + 'name' => ['title' => '名称', 'description' => '名称', 'type' => 'string', 'required' => true, 'example' => '"Critical-Alert-Escalation"'], 'escalationStageList' => [ 'description' => '升级阶段列表，定义多个逐级升级的步骤，每个阶段包含触发条件和通知目标', 'type' => 'array', - 'items' => [ - 'description' => '升级阶段列表，定义多个逐级升级的步骤，每个阶段包含触发条件和通知目标', - '$ref' => '#/components/schemas/IncidentEscalationStageForView', - ], + 'items' => ['description' => '升级阶段列表，定义多个逐级升级的步骤，每个阶段包含触发条件和通知目标', '$ref' => '#/components/schemas/IncidentEscalationStageForView'], ], ], ], @@ -3086,85 +2271,26 @@ 'description' => '用于查看的实体', 'type' => 'object', 'properties' => [ - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58Z', - ], - 'description' => [ - 'title' => '描述', - 'description' => '描述', - 'type' => 'string', - 'example' => 'workspace api monitor update test', - ], - 'enable' => [ - 'title' => '是否启用', - 'description' => '是否启用', - 'type' => 'boolean', - 'example' => 'true', - ], - 'name' => [ - 'title' => '名称', - 'description' => '名称', - 'type' => 'string', - 'required' => true, - 'example' => '"Critical-Alert-Escalation"', - ], - 'updateTime' => [ - 'title' => '更新时间', - 'description' => '更新时间', - 'type' => 'string', - 'example' => '2025-04-15T02:02:50Z', - ], - 'userId' => [ - 'title' => '用户id', - 'description' => '用户id', - 'type' => 'string', - 'example' => '"user-abc123"', - ], - 'workspace' => [ - 'title' => 'workspace', - 'description' => '所属工作空间', - 'type' => 'string', - 'example' => '"ws-xyz789"', - ], - 'ownerType' => [ - 'description' => 'owner类型。'."\n" - ."\n" - .'- **USER**：用户类型，默认值'."\n" - ."\n" - .'- **APP**：App类型', - 'type' => 'string', - 'example' => '"USER"', - ], - 'source' => [ - 'description' => '来源', - 'type' => 'string', - 'example' => '"MANUAL"', - ], - 'syncFromType' => [ - 'description' => '同步策略，表示其来源类型', - 'type' => 'string', - 'example' => '"ARMS"', - ], - 'uuid' => [ - 'description' => '全局唯一标识符', - 'type' => 'string', - 'example' => '"a1b2c3d4-e5f6-7890-1234-567890abcdef"', - ], - 'regionId' => [ - 'description' => '所属地域 ID', - 'type' => 'string', - 'example' => '"cn-hangzhou"', - ], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-03-11T08:21:58Z'], + 'description' => ['title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'workspace api monitor update test'], + 'enable' => ['title' => '是否启用', 'description' => '是否启用', 'type' => 'boolean', 'example' => 'true'], + 'name' => ['title' => '名称', 'description' => '名称', 'type' => 'string', 'required' => true, 'example' => '"Critical-Alert-Escalation"'], + 'updateTime' => ['title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2025-04-15T02:02:50Z'], + 'userId' => ['title' => '用户id', 'description' => '用户id', 'type' => 'string', 'example' => '"user-abc123"'], + 'workspace' => ['title' => 'workspace', 'description' => '所属工作空间', 'type' => 'string', 'example' => '"ws-xyz789"'], + 'ownerType' => ['description' => 'owner类型。'."\n" + ."\n" + .'- **USER**：用户类型，默认值'."\n" + ."\n" + .'- **APP**：App类型', 'type' => 'string', 'example' => '"USER"'], + 'source' => ['description' => '来源', 'type' => 'string', 'example' => '"MANUAL"'], + 'syncFromType' => ['description' => '同步策略，表示其来源类型', 'type' => 'string', 'example' => '"ARMS"'], + 'uuid' => ['description' => '全局唯一标识符', 'type' => 'string', 'example' => '"a1b2c3d4-e5f6-7890-1234-567890abcdef"'], + 'regionId' => ['description' => '所属地域 ID', 'type' => 'string', 'example' => '"cn-hangzhou"'], 'escalationStageList' => [ 'description' => '升级阶段列表', 'type' => 'array', - 'items' => [ - 'description' => '升级阶段列表', - '$ref' => '#/components/schemas/IncidentEscalationStageForView', - ], + 'items' => ['description' => '升级阶段列表', '$ref' => '#/components/schemas/IncidentEscalationStageForView'], ], ], ], @@ -3172,1579 +2298,945 @@ 'description' => '升级阶段展示对象', 'type' => 'object', 'properties' => [ - 'cycleNotifyInterval' => [ - 'description' => '循环通知间隔', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'cycleNotifyCount' => [ - 'description' => '循环通知次数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'triggerDelay' => [ - 'description' => '触发延迟时间', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'effectTimeRange' => [ - 'description' => '生效时间范围', - '$ref' => '#/components/schemas/EffectTimeRange', - ], - 'targetIncidentState' => [ - 'description' => '目标事件状态', - 'type' => 'string', - 'example' => '"Open"', - ], - 'index' => [ - 'description' => '阶段索引', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'cycleNotifyInterval' => ['description' => '循环通知间隔', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'cycleNotifyCount' => ['description' => '循环通知次数', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'triggerDelay' => ['description' => '触发延迟时间', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'effectTimeRange' => ['description' => '生效时间范围', '$ref' => '#/components/schemas/EffectTimeRange'], + 'targetIncidentState' => ['description' => '目标事件状态', 'type' => 'string', 'example' => '"Open"'], + 'index' => ['description' => '阶段索引', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], 'notifyChannels' => [ 'description' => '通知渠道列表', 'type' => 'array', - 'items' => [ - 'description' => '通知渠道', - '$ref' => '#/components/schemas/NotifyChannel', - ], + 'items' => ['description' => '通知渠道', '$ref' => '#/components/schemas/NotifyChannel'], ], ], ], 'IncidentEscalationStageStruct' => [ 'description' => '事件升级阶段结构', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'stageIndex' => [ - 'description' => '阶段指数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'cycleNotifyTime' => [ - 'description' => '周期通知时间', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '300', - ], + 'stageIndex' => ['description' => '阶段指数', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'backendName' => 'index'], + 'cycleNotifyTime' => ['description' => '周期通知时间', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '300', 'backendName' => 'cycleNotifyTime'], 'contact' => [ 'description' => '联系人列表', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '事件联系人结构体', - '$ref' => '#/components/schemas/IncidentContactStruct', - ], - ], - 'name' => [ - 'description' => '名称', - 'type' => 'string', - 'example' => '运维团队', - ], - 'description' => [ - 'description' => '描述', - 'type' => 'string', - 'example' => '负责处理生产环境告警的主负责人', - ], - 'timeZone' => [ - 'description' => '时区', - 'type' => 'string', - 'example' => 'Asia/Shanghai', - ], - 'effectTime' => [ - 'description' => '有效时间', - 'type' => 'string', - 'example' => '2025-04-05T00:00:00Z', - ], - 'waitToNextStageTime' => [ - 'description' => '等待进入下一阶段的时间', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '600', - ], - 'cycleNotifyCount' => [ - 'description' => '周期通知统计次数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', + 'items' => ['description' => '事件联系人结构体', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/IncidentContactStruct'], + 'backendName' => 'contactList', ], + 'name' => ['description' => '名称', 'visibility' => 'Public', 'type' => 'string', 'example' => '运维团队', 'backendName' => 'name'], + 'description' => ['description' => '描述', 'visibility' => 'Public', 'type' => 'string', 'example' => '负责处理生产环境告警的主负责人', 'backendName' => 'description'], + 'timeZone' => ['description' => '时区', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Asia/Shanghai', 'backendName' => 'timeZone'], + 'effectTime' => ['description' => '有效时间', 'visibility' => 'Public', 'type' => 'string', 'example' => '2025-04-05T00:00:00Z', 'backendName' => 'effectTime'], + 'waitToNextStageTime' => ['description' => '等待进入下一阶段的时间', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '600', 'backendName' => 'waitToNextStageTime'], + 'cycleNotifyCount' => ['description' => '周期通知统计次数。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'backendName' => 'cycleNotifyCount'], ], ], 'IncidentEscalationStruct' => [ 'description' => '事件升级结构', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'incidentEscalationId' => [ - 'description' => '事件升级ID', - 'type' => 'string', - 'example' => '52631388567', - ], - 'workspace' => [ - 'description' => '工作空间', - 'type' => 'string', - 'example' => 'workspace-test', - ], - 'modifyTime' => [ - 'description' => '修改时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2025-03-11T08:21:58Z', - ], + 'incidentEscalationId' => ['description' => '事件升级ID', 'visibility' => 'Public', 'type' => 'string', 'example' => '52631388567', 'backendName' => 'uuid'], + 'workspace' => ['description' => '工作空间', 'visibility' => 'Public', 'type' => 'string', 'example' => 'workspace-test', 'backendName' => 'workspace'], + 'modifyTime' => ['description' => '修改时间', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '2025-03-11T08:21:58Z', 'backendName' => 'gmtModified'], 'stage' => [ 'description' => '阶段', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '事件升级阶段结构体', - '$ref' => '#/components/schemas/IncidentEscalationStageStruct', - ], - ], - 'createTime' => [ - 'description' => '创建时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2025-03-11T08:21:58Z', - ], - 'regionId' => [ - 'description' => '地域 ID', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'name' => [ - 'description' => '名称', - 'type' => 'string', - 'example' => '生产环境告警升级策略', - ], - 'description' => [ - 'description' => '描述', - 'type' => 'string', - 'example' => '当告警未响应时，依次通知运维团队、值班经理、CTO', + 'items' => ['description' => '事件升级阶段结构体', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/IncidentEscalationStageStruct'], + 'backendName' => 'stageList', ], + 'createTime' => ['description' => '创建时间', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '2025-03-11T08:21:58Z', 'backendName' => 'gmtCreate'], + 'regionId' => ['description' => '地域 ID', 'visibility' => 'Public', 'type' => 'string', 'example' => 'cn-hangzhou', 'backendName' => 'regionId'], + 'name' => ['description' => '名称', 'visibility' => 'Public', 'type' => 'string', 'example' => '生产环境告警升级策略', 'backendName' => 'name'], + 'description' => ['description' => '描述', 'visibility' => 'Public', 'type' => 'string', 'example' => '当告警未响应时，依次通知运维团队、值班经理、CTO', 'backendName' => 'description'], ], ], 'IncidentEventForView' => [ 'description' => '事件展示对象', 'type' => 'object', 'properties' => [ - 'incidentUuid' => [ - 'description' => '事件所属的故障单唯一标识符', - 'type' => 'string', - 'example' => '"a1b2c3d4-e5f6-7890-1234-567890abcdef"', - ], - 'userId' => [ - 'description' => '创建或触发该事件的用户 ID', - 'type' => 'string', - 'example' => '"user-abc123"', - ], - 'time' => [ - 'description' => '事件发生时间戳', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1743876000000', - ], - 'incidentEventUuid' => [ - 'description' => '事件本身的唯一标识符', - 'type' => 'string', - 'example' => '"x1y2z3a4-b5c6-d7e8-f9g0-h1i2j3k4l5m6"', - ], - 'title' => [ - 'description' => '事件标题', - 'type' => 'string', - 'example' => '"ECS 实例 i-bp123456 CPU 使用率超过 90%"', - ], - 'workspace' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'example' => '"ws-xyz789"', - ], - 'dimension' => [ - 'description' => '事件维度信息', - 'type' => 'object', - 'example' => '{ "env": "prod", "module": "payment" }', - ], - 'labels' => [ - 'description' => '自定义标签键值对', - 'type' => 'object', - 'example' => '{ "project": "payment-gateway", "owner": "ops-team" }', - ], - 'groupBy' => [ - 'description' => '分组依据', - 'type' => 'object', - 'example' => '{ "resourceId": "i-bp123456", "severity": "Critical" }', - ], - 'eventResource' => [ - 'description' => '关联的资源信息', - '$ref' => '#/components/schemas/EventResourceForIncidentView', - ], - 'content' => [ - 'description' => '事件详细内容', - '$ref' => '#/components/schemas/CmsEventForView', - ], - 'severity' => [ - 'description' => '事件严重等级', - 'type' => 'string', - 'example' => '"Critical"', - ], - 'count' => [ - 'description' => '该事件的触发次数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'severityCountMap' => [ - 'description' => '各严重级别事件的数量统计', - 'type' => 'object', - 'example' => '{ "Critical": 2, "High": 1 }', - ], - 'lastTime' => [ - 'description' => '最后一次触发时间戳', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1743876000000', - ], - 'recoverTime' => [ - 'description' => '恢复时间戳', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1743876600000', - ], - 'autoRecoverTime' => [ - 'description' => '自动恢复时间戳', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1743876600000', - ], - 'state' => [ - 'description' => '事件当前状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'incidentUuid' => ['description' => '事件所属的故障单唯一标识符', 'type' => 'string', 'example' => '"a1b2c3d4-e5f6-7890-1234-567890abcdef"'], + 'userId' => ['description' => '创建或触发该事件的用户 ID', 'type' => 'string', 'example' => '"user-abc123"'], + 'time' => ['description' => '事件发生时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1743876000000'], + 'incidentEventUuid' => ['description' => '事件本身的唯一标识符', 'type' => 'string', 'example' => '"x1y2z3a4-b5c6-d7e8-f9g0-h1i2j3k4l5m6"'], + 'title' => ['description' => '事件标题', 'type' => 'string', 'example' => '"ECS 实例 i-bp123456 CPU 使用率超过 90%"'], + 'workspace' => ['description' => '工作空间名称', 'type' => 'string', 'example' => '"ws-xyz789"'], + 'dimension' => ['description' => '事件维度信息', 'type' => 'object', 'example' => '{ "env": "prod", "module": "payment" }'], + 'labels' => ['description' => '自定义标签键值对', 'type' => 'object', 'example' => '{ "project": "payment-gateway", "owner": "ops-team" }'], + 'groupBy' => ['description' => '分组依据', 'type' => 'object', 'example' => '{ "resourceId": "i-bp123456", "severity": "Critical" }'], + 'eventResource' => ['description' => '关联的资源信息', '$ref' => '#/components/schemas/EventResourceForIncidentView'], + 'content' => ['description' => '事件详细内容', '$ref' => '#/components/schemas/CmsEventForView'], + 'severity' => ['description' => '事件严重等级', 'type' => 'string', 'example' => '"Critical"'], + 'count' => ['description' => '该事件的触发次数', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'severityCountMap' => ['description' => '各严重级别事件的数量统计', 'type' => 'object', 'example' => '{ "Critical": 2, "High": 1 }'], + 'lastTime' => ['description' => '最后一次触发时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1743876000000'], + 'recoverTime' => ['description' => '恢复时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1743876600000'], + 'autoRecoverTime' => ['description' => '自动恢复时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1743876600000'], + 'state' => ['description' => '事件当前状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'searchIndex' => [ 'description' => '搜索索引字段列表', 'type' => 'array', - 'items' => [ - 'description' => '搜索索引字段', - 'type' => 'string', - 'example' => '["ECS", "CPU", "high"]', - ], - ], - 'textIndex' => [ - 'description' => '文本索引字段', - 'type' => 'string', - 'example' => '"ECS 实例 CPU 使用率过高"', + 'items' => ['description' => '搜索索引字段', 'type' => 'string', 'example' => '["ECS", "CPU", "high"]'], ], + 'textIndex' => ['description' => '文本索引字段', 'type' => 'string', 'example' => '"ECS 实例 CPU 使用率过高"'], ], ], 'IncidentEventStruct' => [ 'description' => '事件事件结构。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'lastTime' => [ - 'description' => '最后时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1741234567890', - ], - 'recoverTime' => [ - 'description' => '手动恢复时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1741234567890', - ], - 'autoRecoverTime' => [ - 'description' => '自动恢复时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1741234567890', - ], + 'lastTime' => ['description' => '最后时间。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1741234567890', 'backendName' => 'lastTime'], + 'recoverTime' => ['description' => '手动恢复时间。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1741234567890', 'backendName' => 'recoverTime'], + 'autoRecoverTime' => ['description' => '自动恢复时间。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1741234567890', 'backendName' => 'autoRecoverTime'], 'resource' => [ 'description' => '描述事件关联的资源信息。', + 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'map', - 'type' => 'string', - 'example' => 'map', - ], - ], - 'count' => [ - 'description' => '统计数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', + 'additionalProperties' => ['description' => 'map', 'visibility' => 'Public', 'type' => 'string', 'example' => 'map'], + 'backendName' => 'resource', ], + 'count' => ['description' => '统计数量。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'backendName' => 'count'], 'groupBy' => [ 'description' => '用于分组维度。', + 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'map。', - 'type' => 'string', - 'example' => 'map', - ], - ], - 'title' => [ - 'description' => '标题。', - 'type' => 'string', - 'example' => '用户服务 CPU 使用率过高', - ], - 'userId' => [ - 'description' => '用户ID。', - 'type' => 'string', - 'example' => 'user-12345', - ], - 'content' => [ - 'description' => '内容。', - 'type' => 'string', - 'example' => '检测到 user-service 实例 i-abc123 的 CPU 使用率达到 95%，已触发告警。', - ], - 'time' => [ - 'description' => '时间。', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58Z', - ], - 'incidentId' => [ - 'description' => '事件ID。', - 'type' => 'string', - 'example' => 'incident-001', - ], - 'incidentEventId' => [ - 'description' => '事件事件ID。', - 'type' => 'string', - 'example' => 'event-001', - ], + 'additionalProperties' => ['description' => 'map。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'map'], + 'backendName' => 'groupBy', + ], + 'title' => ['description' => '标题。', 'visibility' => 'Public', 'type' => 'string', 'example' => '用户服务 CPU 使用率过高', 'backendName' => 'title'], + 'userId' => ['description' => '用户ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'user-12345', 'backendName' => 'userId'], + 'content' => ['description' => '内容。', 'visibility' => 'Public', 'type' => 'string', 'example' => '检测到 user-service 实例 i-abc123 的 CPU 使用率达到 95%，已触发告警。', 'backendName' => 'content'], + 'time' => ['description' => '时间。', 'visibility' => 'Public', 'type' => 'string', 'example' => '2025-03-11T08:21:58Z', 'backendName' => 'time'], + 'incidentId' => ['description' => '事件ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'incident-001', 'backendName' => 'incidentId'], + 'incidentEventId' => ['description' => '事件事件ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'event-001', 'backendName' => 'incidentEventUuid'], 'dimension' => [ 'description' => '维度。', + 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'map', - 'type' => 'string', - 'example' => 'map', - ], - ], - 'status' => [ - 'description' => '状态。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'Running', + 'additionalProperties' => ['description' => 'map', 'visibility' => 'Public', 'type' => 'string', 'example' => 'map'], + 'backendName' => 'dimension', ], + 'status' => ['description' => '状态。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => 'Running', 'backendName' => 'status'], ], ], 'IncidentForView' => [ 'description' => '故障单展示对象', 'type' => 'object', 'properties' => [ - 'content' => [ - 'description' => '故障单的详细内容', - 'type' => 'string', - 'example' => '"{"description":"ECS实例CPU过高","impact":"支付服务延迟"}"', - ], - 'incidentId' => [ - 'description' => '故障单唯一标识符', - 'type' => 'string', - 'example' => '"incident-abc123"', - ], - 'plan' => [ - 'description' => '响应计划', - '$ref' => '#/components/schemas/IncidentResponsePlanForView', - ], - 'severity' => [ - 'description' => '故障严重等级', - 'type' => 'string', - 'example' => '"Critical"', - ], - 'time' => [ - 'description' => '故障创建时间戳', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1743876000000', - ], - 'title' => [ - 'description' => '故障标题', - 'type' => 'string', - 'example' => '"支付服务不可用"', - ], - 'userId' => [ - 'description' => '创建该故障单的用户 ID', - 'type' => 'string', - 'example' => '"user-abc123"', - ], - 'workspace' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'example' => '"ws-xyz789"', - ], - 'groupUuid' => [ - 'description' => '分组标识。', - 'type' => 'string', - 'example' => '"group-123456"', - ], - 'state' => [ - 'description' => '故障当前状态', - 'type' => 'string', - 'example' => '"Open"', - ], - 'notifyStrategyUuid' => [ - 'description' => '关联的通知策略 UUID，用于触发通知', - 'type' => 'string', - 'example' => '"notify-strategy-789"', - ], - 'subscriptionUuid' => [ - 'description' => '订阅策略 UUID', - 'type' => 'string', - 'example' => '"subscription-abc"', - ], - 'operator' => [ - 'description' => '操作人信息', - '$ref' => '#/components/schemas/ContactForIncidentView', - ], - 'notifyStrategyName' => [ - 'description' => '通知策略名称', - 'type' => 'string', - 'example' => '{ "contactId": "contact-123", "name": "张三" }', - ], - 'subscriptionName' => [ - 'description' => '订阅策略名称', - 'type' => 'string', - 'example' => '"P1-Alert-Notification"', - ], + 'content' => ['description' => '故障单的详细内容', 'type' => 'string', 'example' => '"{"description":"ECS实例CPU过高","impact":"支付服务延迟"}"'], + 'incidentId' => ['description' => '故障单唯一标识符', 'type' => 'string', 'example' => '"incident-abc123"'], + 'plan' => ['description' => '响应计划', '$ref' => '#/components/schemas/IncidentResponsePlanForView'], + 'severity' => ['description' => '故障严重等级', 'type' => 'string', 'example' => '"Critical"'], + 'time' => ['description' => '故障创建时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1743876000000'], + 'title' => ['description' => '故障标题', 'type' => 'string', 'example' => '"支付服务不可用"'], + 'userId' => ['description' => '创建该故障单的用户 ID', 'type' => 'string', 'example' => '"user-abc123"'], + 'workspace' => ['description' => '工作空间名称', 'type' => 'string', 'example' => '"ws-xyz789"'], + 'groupUuid' => ['description' => '分组标识。', 'type' => 'string', 'example' => '"group-123456"'], + 'state' => ['description' => '故障当前状态', 'type' => 'string', 'example' => '"Open"'], + 'notifyStrategyUuid' => ['description' => '关联的通知策略 UUID，用于触发通知', 'type' => 'string', 'example' => '"notify-strategy-789"'], + 'subscriptionUuid' => ['description' => '订阅策略 UUID', 'type' => 'string', 'example' => '"subscription-abc"'], + 'operator' => ['description' => '操作人信息', '$ref' => '#/components/schemas/ContactForIncidentView'], + 'notifyStrategyName' => ['description' => '通知策略名称', 'type' => 'string', 'example' => '{ "contactId": "contact-123", "name": "张三" }'], + 'subscriptionName' => ['description' => '订阅策略名称', 'type' => 'string', 'example' => '"P1-Alert-Notification"'], 'escalations' => [ 'description' => '升级策略列表', 'type' => 'array', - 'items' => [ - 'description' => '升级策略', - '$ref' => '#/components/schemas/IncidentEscalationPolicyForView', - ], + 'items' => ['description' => '升级策略', '$ref' => '#/components/schemas/IncidentEscalationPolicyForView'], ], 'owners' => [ 'description' => '责任人列表', 'type' => 'array', - 'items' => [ - 'description' => '责任人', - '$ref' => '#/components/schemas/ContactForIncidentView', - ], + 'items' => ['description' => '责任人', '$ref' => '#/components/schemas/ContactForIncidentView'], ], 'participants' => [ 'description' => '参与者列表', 'type' => 'array', - 'items' => [ - 'description' => '参与者', - '$ref' => '#/components/schemas/ContactForIncidentView', - ], + 'items' => ['description' => '参与者', '$ref' => '#/components/schemas/ContactForIncidentView'], ], 'groupingKeys' => [ 'description' => '分组键值对', 'type' => 'object', - 'additionalProperties' => [ - 'description' => '分组键值对', - 'type' => 'string', - 'example' => '{ "resourceId": "i-bp123456", "severity": "Critical" }', - ], + 'additionalProperties' => ['description' => '分组键值对', 'type' => 'string', 'example' => '{ "resourceId": "i-bp123456", "severity": "Critical" }'], ], 'relatedResources' => [ 'description' => '关联资源列表', 'type' => 'array', - 'items' => [ - 'description' => '关联资源', - '$ref' => '#/components/schemas/EventResourceForIncidentView', - ], - ], - 'solution' => [ - 'description' => '解决方案描述', - 'type' => 'string', - 'example' => '"重启ECS实例后恢复正常"', - ], - 'rootCauseCategory' => [ - 'description' => '根本原因分类', - 'type' => 'string', - 'example' => '"Network"', + 'items' => ['description' => '关联资源', '$ref' => '#/components/schemas/EventResourceForIncidentView'], ], + 'solution' => ['description' => '解决方案描述', 'type' => 'string', 'example' => '"重启ECS实例后恢复正常"'], + 'rootCauseCategory' => ['description' => '根本原因分类', 'type' => 'string', 'example' => '"Network"'], ], ], 'IncidentMemberStruct' => [ 'description' => '事件成员结构。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'acknowledge' => [ 'description' => '确认信息结构体。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'breakLevel' => [ - 'description' => '确认级别。', - 'type' => 'string', - 'example' => '2', - ], - 'verifyTime' => [ - 'description' => '验证时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1741234567890', - ], + 'breakLevel' => ['description' => '确认级别。', 'visibility' => 'Public', 'type' => 'string', 'example' => '2', 'backendName' => 'breakLevel'], + 'verifyTime' => ['description' => '验证时间。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1741234567890', 'backendName' => 'verifyTime'], ], + 'backendName' => 'acknowledge', ], - 'incidentMemberId' => [ - 'description' => '事件成员ID。', - 'type' => 'string', - 'example' => 'member-001', - ], - 'contactId' => [ - 'description' => '联系人ID。', - 'type' => 'string', - 'example' => 'user-12345', - ], + 'incidentMemberId' => ['description' => '事件成员ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'member-001', 'backendName' => 'incidentItemToken'], + 'contactId' => ['description' => '联系人ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'user-12345', 'backendName' => 'contactId'], 'escalation' => [ 'description' => '升级阶段信息。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'stageIndex' => [ - 'description' => '升级阶段索引。', - 'type' => 'string', - 'example' => '1', - ], - 'incidentEscalationId' => [ - 'description' => '事件升级ID。', - 'type' => 'string', - 'example' => 'escalation-001', - ], - 'name' => [ - 'description' => '名称。', - 'type' => 'string', - 'example' => '第一阶段', - ], - 'description' => [ - 'description' => '描述。', - 'type' => 'string', - 'example' => '通知运维团队', - ], - 'title' => [ - 'description' => '标题。', - 'type' => 'string', - 'example' => '告警升级至运维团队', - ], + 'stageIndex' => ['description' => '升级阶段索引。', 'visibility' => 'Public', 'type' => 'string', 'example' => '1', 'backendName' => 'stageIndex'], + 'incidentEscalationId' => ['description' => '事件升级ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'escalation-001', 'backendName' => 'escalationId'], + 'name' => ['description' => '名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => '第一阶段', 'backendName' => 'name'], + 'description' => ['description' => '描述。', 'visibility' => 'Public', 'type' => 'string', 'example' => '通知运维团队', 'backendName' => 'description'], + 'title' => ['description' => '标题。', 'visibility' => 'Public', 'type' => 'string', 'example' => '告警升级至运维团队', 'backendName' => 'title'], ], + 'backendName' => 'escalation', ], 'scheduleGroup' => [ 'description' => '调度组。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'contactId' => [ - 'description' => '联系人ID。', - 'type' => 'string', - 'example' => 'group-001', - ], - 'name' => [ - 'description' => '名称。', - 'type' => 'string', - 'example' => '夜间值班组', - ], + 'contactId' => ['description' => '联系人ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'group-001', 'backendName' => 'contactId'], + 'name' => ['description' => '名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => '夜间值班组', 'backendName' => 'name'], ], + 'backendName' => 'schedule', ], - 'time' => [ - 'description' => '时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2025-10-08 10:18:58', - ], - 'incidentId' => [ - 'description' => '事件ID。', - 'type' => 'string', - 'example' => 'incident-001', - ], - 'userId' => [ - 'description' => '用户ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4123456', - ], + 'time' => ['description' => '时间。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '2025-10-08 10:18:58', 'backendName' => 'time'], + 'incidentId' => ['description' => '事件ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'incident-001', 'backendName' => 'incidentUuid'], + 'userId' => ['description' => '用户ID。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '4123456', 'backendName' => 'userId'], 'contacts' => [ 'description' => '联系人列表。', + 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '联系人详情。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'contactMask' => [ - 'description' => '联系人 ID（脱敏）。', - 'type' => 'string', - 'example' => 'user-12345', - ], - 'channel' => [ - 'description' => '通道。', - 'type' => 'string', - 'example' => 'dingtalk', - ], + 'contactMask' => ['description' => '联系人 ID（脱敏）。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'user-12345', 'backendName' => 'contactMask'], + 'channel' => ['description' => '通道。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'dingtalk', 'backendName' => 'channel'], ], + 'extendType' => 'true', ], + 'backendName' => 'contacts', ], ], ], 'IncidentNoteStruct' => [ 'description' => '事件记录结构', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'format' => [ - 'description' => '内容格式。', - 'type' => 'string', - 'example' => 'markdown', - ], - 'noteId' => [ - 'description' => '记录ID。', - 'type' => 'string', - 'example' => 'note-001', - ], - 'time' => [ - 'description' => '时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1741234567890', - ], - 'incidentId' => [ - 'description' => '事件ID。', - 'type' => 'string', - 'example' => 'incident-001', - ], - 'type' => [ - 'description' => '类型。', - 'type' => 'string', - 'example' => 'apm', - ], - 'content' => [ - 'description' => '内容。', - 'type' => 'string', - 'example' => '已联系运维团队，正在排查问题。', - ], + 'format' => ['description' => '内容格式。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'markdown', 'backendName' => 'format'], + 'noteId' => ['description' => '记录ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'note-001', 'backendName' => 'noteId'], + 'time' => ['description' => '时间。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1741234567890', 'backendName' => 'time'], + 'incidentId' => ['description' => '事件ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'incident-001', 'backendName' => 'incidentUuid'], + 'type' => ['description' => '类型。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'apm', 'backendName' => 'type'], + 'content' => ['description' => '内容。', 'visibility' => 'Public', 'type' => 'string', 'example' => '已联系运维团队，正在排查问题。', 'backendName' => 'content'], 'operator' => [ 'description' => '操作符。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'contactId' => [ - 'description' => '联系人id。', - 'type' => 'string', - 'example' => 'user-12345', - ], - 'contact' => [ - 'description' => '联系人。', - 'type' => 'string', - 'example' => '{\\"mobile_phone_num\\":\\"153xxxx8040\\",\\"mobile_country_code\\":\\"86\\",\\"email\\":\\"flightxxg@dida.com\\"}', - ], - 'name' => [ - 'description' => '名称。', - 'type' => 'string', - 'example' => '张三', - ], - 'userId' => [ - 'description' => '用户ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4123456', - ], + 'contactId' => ['description' => '联系人id。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'user-12345', 'backendName' => 'contactId'], + 'contact' => ['description' => '联系人。', 'visibility' => 'Public', 'type' => 'string', 'example' => '{\\"mobile_phone_num\\":\\"153xxxx8040\\",\\"mobile_country_code\\":\\"86\\",\\"email\\":\\"flightxxg@dida.com\\"}', 'backendName' => 'contact'], + 'name' => ['description' => '名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => '张三', 'backendName' => 'name'], + 'userId' => ['description' => '用户ID。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '4123456', 'backendName' => 'userId'], ], + 'backendName' => 'opera', ], ], ], 'IncidentPlanCorporationStruct' => [ 'description' => '事件预案协作结构。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'channel' => [ - 'description' => '通道名。', - 'type' => 'string', - 'example' => 'ecs', - ], - 'robotId' => [ - 'description' => '机器人唯一ID。', - 'type' => 'string', - 'example' => 'robotId-cs-api-test', - ], + 'channel' => ['description' => '通道名。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'ecs', 'backendName' => 'channel'], + 'robotId' => ['description' => '机器人唯一ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'robotId-cs-api-test', 'backendName' => 'robotId'], ], ], 'IncidentPlanFieldPath' => [ 'description' => '用于定义事件预案中字段映射路径的结构体。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'fieldAlias' => [ - 'description' => '字段别名。', - 'type' => 'string', - 'example' => '服务名称', - ], + 'fieldAlias' => ['description' => '字段别名。', 'visibility' => 'Public', 'type' => 'string', 'example' => '服务名称', 'backendName' => 'alias'], 'fieldPath' => [ 'description' => '字段路径的列表。', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '字段路径。', - 'type' => 'string', - 'example' => 'service.name', - ], + 'items' => ['description' => '字段路径。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'service.name', 'extendType' => 'true'], + 'backendName' => 'name', ], ], ], 'IncidentPlanStruct' => [ 'description' => '事件预案结构体。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'escalationId' => [ 'description' => '升级策略 ID的列表。', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '升级策略 ID。', - 'type' => 'string', - 'example' => 'escalation-001', - ], - ], - 'gmtModified' => [ - 'description' => '最后修改时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1741234567890', - ], - 'workspace' => [ - 'description' => '工作空间名称。', - 'type' => 'string', - 'example' => 'workspace-test', + 'items' => ['description' => '升级策略 ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'escalation-001', 'extendType' => 'true'], + 'backendName' => 'escalationId', ], + 'gmtModified' => ['description' => '最后修改时间。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1741234567890', 'backendName' => 'gmtModified'], + 'workspace' => ['description' => '工作空间名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'workspace-test', 'backendName' => 'workspace'], 'resourceFiled' => [ 'description' => '资源字段映射路径的列表。', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '资源字段映射路径。', - '$ref' => '#/components/schemas/IncidentPlanFieldPath', - ], + 'items' => ['description' => '资源字段映射路径。', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/IncidentPlanFieldPath'], + 'backendName' => 'resourceField', ], 'corporation' => [ 'description' => '参与协作的团队或角色列表。', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '事件预案结构体。', - '$ref' => '#/components/schemas/IncidentPlanCorporationStruct', - ], - ], - 'description' => [ - 'description' => '预案描述。', - 'type' => 'string', - 'example' => '针对数据库连接数过高的应急处理方案', - ], - 'autoRecoverSeconds' => [ - 'description' => '自动恢复等待时间。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3600', + 'items' => ['description' => '事件预案结构体。', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/IncidentPlanCorporationStruct'], + 'backendName' => 'corporation', ], + 'description' => ['description' => '预案描述。', 'visibility' => 'Public', 'type' => 'string', 'example' => '针对数据库连接数过高的应急处理方案', 'backendName' => 'description'], + 'autoRecoverSeconds' => ['description' => '自动恢复等待时间。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '3600', 'backendName' => 'autoRecoverSeconds'], 'groupBy' => [ 'description' => '分组字段路径', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '事件预案中字段映射路径的结构体。', - '$ref' => '#/components/schemas/IncidentPlanFieldPath', - ], - ], - 'gmtCreate' => [ - 'description' => '创建时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1741234567890', - ], - 'userId' => [ - 'description' => '用户 ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'uesr-12345', - ], - 'closeExpire' => [ - 'description' => '事件关闭超时时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '86400000', - ], - 'name' => [ - 'description' => '预案名称。', - 'type' => 'string', - 'example' => '数据库连接数告警预案', - ], - 'incidentPlanId' => [ - 'description' => '事件预案 ID。', - 'type' => 'string', - 'example' => 'plan-001', - ], - 'status' => [ - 'description' => '状态。', - 'type' => 'string', - 'example' => 'Running', + 'items' => ['description' => '事件预案中字段映射路径的结构体。', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/IncidentPlanFieldPath'], + 'backendName' => 'groupBy', ], + 'gmtCreate' => ['description' => '创建时间。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1741234567890', 'backendName' => 'gmtCreate'], + 'userId' => ['description' => '用户 ID。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => 'uesr-12345', 'backendName' => 'userId'], + 'closeExpire' => ['description' => '事件关闭超时时间。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '86400000', 'backendName' => 'closeExpire'], + 'name' => ['description' => '预案名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => '数据库连接数告警预案', 'backendName' => 'name'], + 'incidentPlanId' => ['description' => '事件预案 ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'plan-001', 'backendName' => 'uuid'], + 'status' => ['description' => '状态。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Running', 'backendName' => 'status'], ], ], 'IncidentResourceDetail' => [ 'description' => '用于描述 事件关联资源详情 的结构体。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'resourceId' => [ - 'description' => '资源 ID 对象。', - 'type' => 'object', - 'example' => '{ "type": "ecs", "id": "i-bp1234567890abcdef" }', - ], - 'extraId' => [ - 'description' => '额外的资源标识符。', - 'type' => 'string', - 'example' => 'app-prod-web-01', - ], - 'type' => [ - 'description' => '资源类型，表示该资源属于哪种云产品。', - 'type' => 'string', - 'example' => 'ecs', - ], + 'resourceId' => ['description' => '资源 ID 对象。', 'visibility' => 'Public', 'type' => 'object', 'example' => '{ "type": "ecs", "id": "i-bp1234567890abcdef" }', 'backendName' => 'resourceId'], + 'extraId' => ['description' => '额外的资源标识符。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'app-prod-web-01', 'backendName' => 'extraId'], + 'type' => ['description' => '资源类型，表示该资源属于哪种云产品。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'ecs', 'backendName' => 'type'], ], ], 'IncidentResourceStruct' => [ 'description' => '用于描述 事件关联资源 的结构体。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'resource' => [ - 'description' => '事件资源详情对象。', - '$ref' => '#/components/schemas/IncidentResourceDetail', + 'resource' => ['description' => '事件资源详情对象。', 'visibility' => 'Public', 'backendName' => 'resource', '$ref' => '#/components/schemas/IncidentResourceDetail'], + 'description' => ['description' => '描述信息。', 'visibility' => 'Public', 'type' => 'string', 'example' => '生产环境 Web 服务器', 'backendName' => 'description'], + 'incidentResourceId' => ['description' => '事件中该资源的唯一 ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'res-001', 'backendName' => 'incidentItemToken'], + 'source' => ['description' => '来源。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'cloudmonitor', 'backendName' => 'source'], + 'time' => ['description' => '时间戳。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1741234567890', 'backendName' => 'time'], + 'incidentId' => ['description' => '事件ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'incident-001', 'backendName' => 'incidentUuid'], + 'userId' => ['description' => '用户 ID。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => 'user-12345', 'backendName' => 'userId'], + ], + ], + 'IncidentResponsePlanForModify' => [ + 'title' => 'Incident 响应计划修改入参', + 'description' => 'Incident Management 响应计划写入载荷，用于 Create/Update。'."\n" + .'与 IncidentResponsePlanForView 字段一致，剔除只读字段（createTime/updateTime/workspace）。'."\n", + 'type' => 'object', + 'properties' => [ + 'uuid' => ['title' => '响应计划 uuid', 'description' => 'Update 必填；Create 可省略由后端生成；与 NotifyStrategy 共享 uuid', 'type' => 'string'], + 'name' => ['title' => '名称', 'type' => 'string'], + 'description' => ['title' => '描述', 'type' => 'string'], + 'enabled' => ['title' => '是否启用', 'type' => 'boolean'], + 'type' => ['title' => '类型', 'type' => 'string'], + 'source' => ['title' => '来源', 'type' => 'string'], + 'mode' => ['title' => '生命周期模式', 'type' => 'string'], + 'syncFromType' => ['title' => '同步来源类型', 'type' => 'string'], + 'autoRecoverSeconds' => ['title' => '无事件自动恢复时间（秒）', 'type' => 'integer', 'format' => 'int64'], + 'escalationId' => [ + 'title' => '升级规划 ID 列表', + 'type' => 'array', + 'items' => ['type' => 'string'], ], - 'description' => [ - 'description' => '描述信息。', - 'type' => 'string', - 'example' => '生产环境 Web 服务器', + 'repeatNotifySetting' => ['title' => '重复通知配置', '$ref' => '#/components/schemas/RepeatNotifySetting'], + 'pushingSetting' => ['title' => '推送设置', '$ref' => '#/components/schemas/PushingSetting'], + ], + ], + 'IncidentResponsePlanForSNSModify' => [ + 'title' => 'SNS 内嵌的响应计划入参', + 'description' => '用于 SubscriptionAndNotifyStrategy 聚合接口的 responsePlan 子实体入参。'."\n" + .'后端 readonly 字段（uuid / name / type / source / mode / syncFromType / enabled）不暴露：'."\n" + .'- uuid 与 notifyStrategy 共享 snsUuid (D8)'."\n" + .'- type 强制 NOTIFY_STRATEGY_DEFINED；source 强制 CUSTOM'."\n" + .'- mode 强制 BundleStrategy；syncFromType 强制 OBS'."\n", + 'type' => 'object', + 'properties' => [ + 'escalationId' => [ + 'title' => '升级规划 id 列表', + 'type' => 'array', + 'items' => ['type' => 'string'], ], - 'incidentResourceId' => [ - 'description' => '事件中该资源的唯一 ID。', - 'type' => 'string', - 'example' => 'res-001', + 'repeatNotifySetting' => [ + 'title' => '重复通知配置', + 'type' => 'object', + 'properties' => [ + 'endIncidentState' => ['type' => 'string'], + 'repeatInterval' => ['type' => 'integer', 'format' => 'int32'], + ], ], - 'source' => [ - 'description' => '来源。', - 'type' => 'string', - 'example' => 'cloudmonitor', + 'autoRecoverSeconds' => ['title' => '自动恢复秒数（无事件持续时长）', 'type' => 'integer', 'format' => 'int64'], + 'pushingSetting' => [ + 'title' => '推送设置', + 'type' => 'object', + 'properties' => [ + 'templateUuid' => ['type' => 'string'], + 'alertActionIds' => [ + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + 'restoreActionIds' => [ + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + ], ], - 'time' => [ - 'description' => '时间戳。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1741234567890', + ], + ], + 'IncidentResponsePlanForSNSView' => [ + 'title' => 'SNS 内嵌的响应计划查看视图', + 'type' => 'object', + 'properties' => [ + 'uuid' => ['title' => 'uuid（D8：= notifyStrategyUuid = SNS uuid）', 'type' => 'string'], + 'name' => ['type' => 'string'], + 'enable' => ['type' => 'boolean'], + 'syncFromType' => ['type' => 'string'], + 'mode' => ['type' => 'string'], + 'type' => ['title' => '响应计划类型（SNS 内必为 NOTIFY_STRATEGY_DEFINED）', 'type' => 'string'], + 'source' => ['title' => '来源（SNS 内必为 CUSTOM）', 'type' => 'string'], + 'escalationId' => [ + 'title' => '升级规划 id 列表', + 'type' => 'array', + 'items' => ['type' => 'string'], ], - 'incidentId' => [ - 'description' => '事件ID。', - 'type' => 'string', - 'example' => 'incident-001', + 'repeatNotifySetting' => [ + 'type' => 'object', + 'properties' => [ + 'endIncidentState' => ['type' => 'string'], + 'repeatInterval' => ['type' => 'integer', 'format' => 'int32'], + ], ], - 'userId' => [ - 'description' => '用户 ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'user-12345', + 'autoRecoverSeconds' => ['type' => 'integer', 'format' => 'int64'], + 'pushingSetting' => [ + 'type' => 'object', + 'properties' => [ + 'templateUuid' => ['type' => 'string'], + 'alertActionIds' => [ + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + 'restoreActionIds' => [ + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + ], ], + 'createTime' => ['type' => 'string'], + 'updateTime' => ['type' => 'string'], ], ], 'IncidentResponsePlanForView' => [ 'description' => '响应计划展示对象', 'type' => 'object', 'properties' => [ - 'type' => [ - 'description' => '响应计划类型', - 'type' => 'string', - 'example' => '"Standard"', - ], - 'source' => [ - 'description' => '来源', - 'type' => 'string', - 'example' => '"MANUAL"', - ], + 'type' => ['description' => '响应计划类型', 'type' => 'string', 'example' => '"Standard"'], + 'source' => ['description' => '来源', 'type' => 'string', 'example' => '"MANUAL"'], 'escalationId' => [ 'description' => '关联的升级策略 ID 列表', 'type' => 'array', - 'items' => [ - 'description' => '升级策略 ID', - 'type' => 'string', - 'example' => '"escalation-123"', - ], - ], - 'repeatNotifySetting' => [ - 'description' => '循环通知设置', - '$ref' => '#/components/schemas/RepeatNotifySetting', - ], - 'mode' => [ - 'description' => '响应模式', - 'type' => 'string', - 'example' => '"Manual"', - ], - 'autoRecoverSeconds' => [ - 'description' => '自动恢复时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '300', - ], - 'syncFromType' => [ - 'description' => '同步策略来源类型', - 'type' => 'string', - 'example' => '"ARMS"', - ], - 'pushingSetting' => [ - 'description' => '推送设置', - '$ref' => '#/components/schemas/PushingSetting', - ], - 'name' => [ - 'description' => '响应计划名称', - 'type' => 'string', - 'example' => '"P1-Critical-Response-Plan"', - ], - 'uuid' => [ - 'description' => '全局唯一标识符', - 'type' => 'string', - 'example' => '"a1b2c3d4-e5f6-7890-1234-567890abcdef"', - ], - 'workspace' => [ - 'description' => '工作空间', - 'type' => 'string', - 'example' => '"ws-xyz789"', - ], - 'description' => [ - 'description' => '响应计划描述', - 'type' => 'string', - 'example' => '"针对支付服务不可用的紧急响应流程"', - ], - 'enabled' => [ - 'description' => '是否启用该响应计划', - 'type' => 'boolean', - 'example' => 'true', - ], - 'createTime' => [ - 'description' => '计划创建时间', - 'type' => 'string', - 'example' => '"2025-04-05T10:30:00Z"', - ], - 'updateTime' => [ - 'description' => '计划最后更新时间', - 'type' => 'string', - 'example' => '"2025-04-06T09:15:00Z"', - ], + 'items' => ['description' => '升级策略 ID', 'type' => 'string', 'example' => '"escalation-123"'], + ], + 'repeatNotifySetting' => ['description' => '循环通知设置', '$ref' => '#/components/schemas/RepeatNotifySetting'], + 'mode' => ['description' => '响应模式', 'type' => 'string', 'example' => '"Manual"'], + 'autoRecoverSeconds' => ['description' => '自动恢复时间', 'type' => 'integer', 'format' => 'int64', 'example' => '300'], + 'syncFromType' => ['description' => '同步策略来源类型', 'type' => 'string', 'example' => '"ARMS"'], + 'pushingSetting' => ['description' => '推送设置', '$ref' => '#/components/schemas/PushingSetting'], + 'name' => ['description' => '响应计划名称', 'type' => 'string', 'example' => '"P1-Critical-Response-Plan"'], + 'uuid' => ['description' => '全局唯一标识符', 'type' => 'string', 'example' => '"a1b2c3d4-e5f6-7890-1234-567890abcdef"'], + 'workspace' => ['description' => '工作空间', 'type' => 'string', 'example' => '"ws-xyz789"'], + 'description' => ['description' => '响应计划描述', 'type' => 'string', 'example' => '"针对支付服务不可用的紧急响应流程"'], + 'enabled' => ['description' => '是否启用该响应计划', 'type' => 'boolean', 'example' => 'true'], + 'createTime' => ['description' => '计划创建时间', 'type' => 'string', 'example' => '"2025-04-05T10:30:00Z"'], + 'updateTime' => ['description' => '计划最后更新时间', 'type' => 'string', 'example' => '"2025-04-06T09:15:00Z"'], ], ], 'IncidentStruct' => [ 'description' => '用于表示 一个完整事件（Incident）的核心结构体。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'severity' => [ - 'description' => '事件严重等级。', - 'type' => 'string', - 'example' => 'P1', - ], + 'severity' => ['description' => '事件严重等级。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'P1', 'backendName' => 'severity'], 'escalations' => [ 'description' => '升级策略列表。', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '事件升级结构体。', - '$ref' => '#/components/schemas/IncidentEscalationStruct', - ], - ], - 'resource' => [ - 'description' => '关联的资源详情。', - '$ref' => '#/components/schemas/IncidentResourceDetail', - ], - 'incidentPlan' => [ - 'description' => '关联的事件预案。', - '$ref' => '#/components/schemas/IncidentPlanStruct', - ], - 'time' => [ - 'description' => '时间戳。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1741234567890', - ], - 'incidentId' => [ - 'description' => '事件唯一 ID。', - 'type' => 'string', - 'example' => 'incident-001', - ], - 'title' => [ - 'description' => '事件标题。', - 'type' => 'string', - 'example' => '数据库连接数过高', - ], - 'userId' => [ - 'description' => '用户 ID。', - 'type' => 'string', - 'example' => 'user-12345', - ], - 'content' => [ - 'description' => '事件内容。', - 'type' => 'string', - 'example' => '检测到 RDS 实例 rds-bp1234567890abcdef 的连接数达到 1000，已触发告警。', - ], - 'status' => [ - 'description' => '当前状态。', - 'type' => 'string', - 'example' => 'OPEN', + 'items' => ['description' => '事件升级结构体。', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/IncidentEscalationStruct'], + 'backendName' => 'escalations', ], + 'resource' => ['description' => '关联的资源详情。', 'visibility' => 'Public', 'backendName' => 'resource', '$ref' => '#/components/schemas/IncidentResourceDetail'], + 'incidentPlan' => ['description' => '关联的事件预案。', 'visibility' => 'Public', 'backendName' => 'plan', '$ref' => '#/components/schemas/IncidentPlanStruct'], + 'time' => ['description' => '时间戳。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1741234567890', 'backendName' => 'time'], + 'incidentId' => ['description' => '事件唯一 ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'incident-001', 'backendName' => 'incidentUuid'], + 'title' => ['description' => '事件标题。', 'visibility' => 'Public', 'type' => 'string', 'example' => '数据库连接数过高', 'backendName' => 'title'], + 'userId' => ['description' => '用户 ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'user-12345', 'backendName' => 'userId'], + 'content' => ['description' => '事件内容。', 'visibility' => 'Public', 'type' => 'string', 'example' => '检测到 RDS 实例 rds-bp1234567890abcdef 的连接数达到 1000，已触发告警。', 'backendName' => 'content'], + 'status' => ['description' => '当前状态。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'OPEN', 'backendName' => 'status'], ], ], 'IncidentTimeline' => [ 'description' => '用于记录事件处理过程中的时间线节点的结构体', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'childType' => [ - 'description' => '子类型。', - 'type' => 'string', - 'example' => 'comment', - ], - 'incidentTimelineId' => [ - 'description' => '时间线节点唯一 ID。', - 'type' => 'string', - 'example' => 'timeline-001', - ], - 'timelineId' => [ - 'description' => '所属时间线 ID。', - 'type' => 'string', - 'example' => 'timeline-main-001', - ], - 'time' => [ - 'description' => '时间戳。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1741234567890', - ], - 'incidentId' => [ - 'description' => '所属事件 ID。', - 'type' => 'string', - 'example' => 'incident-001', - ], - 'title' => [ - 'description' => '时间线标题。', - 'type' => 'string', - 'example' => '已联系运维团队', - ], - 'type' => [ - 'description' => '类型。', - 'type' => 'string', - 'example' => 'ACTION', - ], - 'userId' => [ - 'description' => '用户 ID。', - 'type' => 'string', - 'example' => 'user-12345', - ], - 'content' => [ - 'description' => '内容。', - 'type' => 'string', - 'example' => '已通知运维团队进行排查', - ], + 'childType' => ['description' => '子类型。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'comment', 'backendName' => 'childType'], + 'incidentTimelineId' => ['description' => '时间线节点唯一 ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'timeline-001', 'backendName' => 'incidentItemToken'], + 'timelineId' => ['description' => '所属时间线 ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'timeline-main-001', 'backendName' => 'timelineUuid'], + 'time' => ['description' => '时间戳。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1741234567890', 'backendName' => 'time'], + 'incidentId' => ['description' => '所属事件 ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'incident-001', 'backendName' => 'incidentUuid'], + 'title' => ['description' => '时间线标题。', 'visibility' => 'Public', 'type' => 'string', 'example' => '已联系运维团队', 'backendName' => 'title'], + 'type' => ['description' => '类型。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'ACTION', 'backendName' => 'type'], + 'userId' => ['description' => '用户 ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'user-12345', 'backendName' => 'userId'], + 'content' => ['description' => '内容。', 'visibility' => 'Public', 'type' => 'string', 'example' => '已通知运维团队进行排查', 'backendName' => 'content'], ], ], 'IncidentTimelineForView' => [ 'description' => '事件时间线展示对象', 'type' => 'object', 'properties' => [ - 'incidentUuid' => [ - 'description' => '所属事件的唯一标识符', - 'type' => 'string', - 'example' => '"a1b2c3d4-e5f6-7890-1234-567890abcdef"', - ], - 'userId' => [ - 'description' => '用户 ID', - 'type' => 'string', - 'example' => '"user-abc123"', - ], - 'time' => [ - 'description' => '时间线事件发生时间戳', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1743876000000', - ], - 'timelineUuid' => [ - 'description' => '时间线记录本身的唯一标识符', - 'type' => 'string', - 'example' => '"x1y2z3a4-b5c6-d7e8-f9g0-h1i2j3k4l5m6"', - ], - 'type' => [ - 'description' => '时间线事件类型', - 'type' => 'string', - 'example' => '"Comment"', + 'incidentUuid' => ['description' => '所属事件的唯一标识符', 'type' => 'string', 'example' => '"a1b2c3d4-e5f6-7890-1234-567890abcdef"'], + 'userId' => ['description' => '用户 ID', 'type' => 'string', 'example' => '"user-abc123"'], + 'time' => ['description' => '时间线事件发生时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1743876000000'], + 'timelineUuid' => ['description' => '时间线记录本身的唯一标识符', 'type' => 'string', 'example' => '"x1y2z3a4-b5c6-d7e8-f9g0-h1i2j3k4l5m6"'], + 'type' => ['description' => '时间线事件类型', 'type' => 'string', 'example' => '"Comment"'], + 'changeType' => ['description' => '状态变更类型', 'type' => 'string', 'example' => '"Open -> In Progress"'], + 'title' => ['description' => '时间线标题', 'type' => 'string', 'example' => '"故障已升级至值班主管"'], + 'content' => ['description' => '时间线内容', 'type' => 'any', 'example' => '"{"action":"restart","resourceId":"i-bp123456"}"'], + 'workspace' => ['description' => '所属工作空间', 'type' => 'string', 'example' => '"ws-xyz789"'], + 'operator' => ['description' => '操作人信息', '$ref' => '#/components/schemas/ContactForIncidentView'], + ], + ], + 'IndexJsonKey' => [ + 'description' => 'json key', + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => '字段类型', 'type' => 'string', 'example' => 'text'], + 'chn' => ['description' => '是否包含中文。'."\n" + ."\n" + .'- true：包含中文。'."\n" + .'- false：不包含中文。', 'type' => 'boolean', 'example' => 'true'], + ], + ], + 'IndexKey' => [ + 'description' => '表结构', + 'type' => 'object', + 'properties' => [ + 'chn' => ['description' => '是否包含中文。'."\n" + ."\n" + .'- true：包含中文。'."\n" + .'- false：不包含中文。', 'type' => 'boolean', 'example' => 'true'], + 'type' => ['description' => '字段类型', 'type' => 'string', 'example' => 'text'], + 'embedding' => ['description' => '模型名称', 'type' => 'string', 'example' => 'text-embedding-v4'], + 'jsonKeys' => [ + 'description' => 'json key', + 'type' => 'object', + 'additionalProperties' => ['description' => 'json key', '$ref' => '#/components/schemas/IndexJsonKey'], ], - 'changeType' => [ - 'description' => '状态变更类型', - 'type' => 'string', - 'example' => '"Open -> In Progress"', + ], + ], + 'LabelMatcher' => [ + 'title' => '标签匹配器', + 'type' => 'object', + 'properties' => [ + 'key' => ['type' => 'string'], + 'value' => ['type' => 'string'], + ], + ], + 'LabelsFilter' => [ + 'title' => '标签过滤', + 'type' => 'object', + 'properties' => [ + 'anyOf' => [ + 'title' => '匹配任意一个标签（OR）', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/LabelMatcher'], ], - 'title' => [ - 'description' => '时间线标题', - 'type' => 'string', - 'example' => '"故障已升级至值班主管"', + 'allOf' => [ + 'title' => '匹配所有标签（AND）', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/LabelMatcher'], ], - 'content' => [ - 'description' => '时间线内容', - 'type' => 'any', - 'example' => '"{"action":"restart","resourceId":"i-bp123456"}"', + ], + ], + 'ListEventMetaCacheAllKeys_DataResult' => [ + 'type' => 'object', + 'properties' => [ + 'label' => [ + 'description' => 'label类型的Key列表', + 'type' => 'array', + 'items' => ['description' => 'Key名称', 'type' => 'string', 'example' => '_cms_rule_id'], + 'example' => '["_cms_rule_id","_cms_rule_name"]', ], - 'workspace' => [ - 'description' => '所属工作空间', - 'type' => 'string', - 'example' => '"ws-xyz789"', + 'annotation' => [ + 'description' => 'annotation类型的Key列表', + 'type' => 'array', + 'items' => ['description' => 'Key名称', 'type' => 'string', 'example' => 'message'], + 'example' => '["message","current_value"]', ], - 'operator' => [ - 'description' => '操作人信息', - '$ref' => '#/components/schemas/ContactForIncidentView', + 'resourceTag' => [ + 'description' => 'resource.tag类型的Key列表', + 'type' => 'array', + 'items' => ['description' => 'Key名称', 'type' => 'string', 'example' => 'arn'], + 'example' => '["arn","callType"]', ], ], ], 'MaintainWindowForModify' => [ 'title' => 'A short description of struct', 'description' => '静默策略对象。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'effective' => [ - 'title' => 'Crontab 表达式', - 'description' => 'Crontab 表达式', - 'type' => 'string', - 'example' => '* * 14-18 ? * *', - ], - 'description' => [ - 'title' => '创建时间', - 'description' => '描述', - 'type' => 'string', - 'example' => 'workspace test', - ], - 'filterSetting' => [ - 'description' => '筛选条件', - '$ref' => '#/components/schemas/FilterSetting', - ], - 'maintainWindowName' => [ - 'title' => '名称', - 'description' => '名称', - 'type' => 'string', - 'required' => true, - 'example' => 'test strategy', - ], - 'startTime' => [ - 'title' => '生效开始时间', - 'description' => '生效开始时间', - 'type' => 'string', - 'example' => '2025-04-11 07:55:00', - ], + 'effective' => ['title' => 'Crontab 表达式', 'description' => 'Crontab 表达式', 'visibility' => 'Public', 'type' => 'string', 'example' => '* * 14-18 ? * *', 'backendName' => 'effective'], + 'description' => ['title' => '创建时间', 'description' => '描述', 'visibility' => 'Public', 'type' => 'string', 'example' => 'workspace test', 'backendName' => 'description'], + 'filterSetting' => ['description' => '筛选条件', 'visibility' => 'Public', 'backendName' => 'filterSetting', '$ref' => '#/components/schemas/FilterSetting'], + 'maintainWindowName' => ['title' => '名称', 'description' => '名称', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'test strategy', 'backendName' => 'maintainWindowName'], + 'startTime' => ['title' => '生效开始时间', 'description' => '生效开始时间', 'visibility' => 'Public', 'type' => 'string', 'example' => '2025-04-11 07:55:00', 'backendName' => 'startTime'], 'effectTimeRange' => [ 'description' => '生效时间范围', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'startTimeInMinute' => [ - 'title' => '开始时间(分钟数)', - 'description' => '开始时间(分钟数)', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '1438', - 'minimum' => '0', - 'example' => '60', - ], - 'timeZone' => [ - 'title' => '时区', - 'description' => '时区', - 'type' => 'string', - 'example' => '+08:00', - ], + 'startTimeInMinute' => ['title' => '开始时间(分钟数)', 'description' => '开始时间(分钟数)', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1438', 'minimum' => '0', 'example' => '60', 'backendName' => 'startTimeInMinute'], + 'timeZone' => ['title' => '时区', 'description' => '时区', 'visibility' => 'Public', 'type' => 'string', 'example' => '+08:00', 'backendName' => 'timeZone'], 'dayInWeek' => [ 'title' => '生效天(周一到周日)', 'description' => '生效天(周一到周日)', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '0-6 表示周日到周六', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - 'endTimeInMinute' => [ - 'title' => '结束时间(分钟数)', - 'description' => '结束时间(分钟数)', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '1439', - 'minimum' => '0', - 'example' => '60', + 'items' => ['description' => '0-6 表示周日到周六', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'extendType' => 'true'], + 'backendName' => 'dayInWeek', ], + 'endTimeInMinute' => ['title' => '结束时间(分钟数)', 'description' => '结束时间(分钟数)', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1439', 'minimum' => '0', 'example' => '60', 'backendName' => 'endTimeInMinute'], ], + 'backendName' => 'effectTimeRange', ], - 'endTime' => [ - 'title' => '生效结束时间', - 'description' => '生效结束时间', - 'type' => 'string', - 'example' => '2024-09-05 09:30:40', - ], + 'endTime' => ['title' => '生效结束时间', 'description' => '生效结束时间', 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-09-05 09:30:40', 'backendName' => 'endTime'], ], ], 'MaintainWindowForView' => [ 'title' => 'A short description of struct', 'description' => '沉默策略对象。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'workspace' => [ - 'title' => 'workspace', - 'description' => 'workspace', - 'type' => 'string', - 'example' => 'workspace-test', - ], - 'maintainWindowId' => [ - 'title' => 'UUID', - 'description' => 'UUID', - 'type' => 'string', - 'example' => '123-12-312-31-23123', - ], - 'description' => [ - 'title' => '描述', - 'description' => '描述', - 'type' => 'string', - 'example' => 'test', - ], - 'filterSetting' => [ - 'description' => '筛选条件', - '$ref' => '#/components/schemas/FilterSetting', - ], - 'maintainWindowName' => [ - 'title' => '名称', - 'description' => '名称', - 'type' => 'string', - 'required' => true, - 'example' => '测试策略', - ], - 'updateTime' => [ - 'title' => '更新时间', - 'description' => '更新时间', - 'type' => 'string', - 'example' => '2025-05-07T02:19:05Z', - ], + 'workspace' => ['title' => 'workspace', 'description' => 'workspace', 'visibility' => 'Public', 'type' => 'string', 'example' => 'workspace-test', 'backendName' => 'workspace'], + 'maintainWindowId' => ['title' => 'UUID', 'description' => 'UUID', 'visibility' => 'Public', 'type' => 'string', 'example' => '123-12-312-31-23123', 'backendName' => 'maintainWindowId'], + 'description' => ['title' => '描述', 'description' => '描述', 'visibility' => 'Public', 'type' => 'string', 'example' => 'test', 'backendName' => 'description'], + 'filterSetting' => ['description' => '筛选条件', 'visibility' => 'Public', 'backendName' => 'filterSetting', '$ref' => '#/components/schemas/FilterSetting'], + 'maintainWindowName' => ['title' => '名称', 'description' => '名称', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => '测试策略', 'backendName' => 'maintainWindowName'], + 'updateTime' => ['title' => '更新时间', 'description' => '更新时间', 'visibility' => 'Public', 'type' => 'string', 'example' => '2025-05-07T02:19:05Z', 'backendName' => 'updateTime'], 'effectTimeRange' => [ 'description' => '生效时间范围', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'startTimeInMinute' => [ - 'title' => '开始时间(分钟数)', - 'description' => '开始时间(分钟数)', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '1438', - 'minimum' => '0', - 'example' => '60', - ], - 'timeZone' => [ - 'title' => '时区', - 'description' => '时区', - 'type' => 'string', - 'example' => '+08:00', - ], + 'startTimeInMinute' => ['title' => '开始时间(分钟数)', 'description' => '开始时间(分钟数)', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1438', 'minimum' => '0', 'example' => '60', 'backendName' => 'startTimeInMinute'], + 'timeZone' => ['title' => '时区', 'description' => '时区', 'visibility' => 'Public', 'type' => 'string', 'example' => '+08:00', 'backendName' => 'timeZone'], 'dayInWeek' => [ 'title' => '生效天(周一到周日)', 'description' => '生效天(周一到周日)', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '0-6 标志周日到周六', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - ], - 'endTimeInMinute' => [ - 'title' => '结束时间(分钟数)', - 'description' => '结束时间(分钟数)', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '1439', - 'minimum' => '0', - 'example' => '360', + 'items' => ['description' => '0-6 标志周日到周六', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'extendType' => 'true'], + 'backendName' => 'dayInWeek', ], + 'endTimeInMinute' => ['title' => '结束时间(分钟数)', 'description' => '结束时间(分钟数)', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1439', 'minimum' => '0', 'example' => '360', 'backendName' => 'endTimeInMinute'], ], + 'backendName' => 'effectTimeRange', ], - 'userId' => [ - 'title' => '用户id', - 'description' => '用户id', - 'type' => 'string', - 'example' => '12312312***', + 'userId' => ['title' => '用户id', 'description' => '用户id', 'visibility' => 'Public', 'type' => 'string', 'example' => '12312312***', 'backendName' => 'userId'], + 'effective' => ['title' => 'Crontab 表达式', 'description' => 'Crontab 表达式', 'visibility' => 'Public', 'type' => 'string', 'example' => '* * 14-18 ? * *', 'backendName' => 'effective'], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'visibility' => 'Public', 'type' => 'string', 'example' => '2025-03-11T08:21:58Z', 'backendName' => 'createTime'], + 'enable' => ['title' => '是否启用', 'description' => '是否启用', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'enabled'], + 'startTime' => ['title' => '生效开始时间', 'description' => '生效开始时间', 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-11-26 10:02:01', 'backendName' => 'startTime'], + 'endTime' => ['title' => '生效结束时间', 'description' => '生效结束时间', 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-11-26 12:02:01', 'backendName' => 'endTime'], + ], + ], + 'ManageAlertRulesResult' => [ + 'title' => '告警规则管理响应 data', + 'type' => 'object', + 'properties' => [ + 'alertRule' => ['$ref' => '#/components/schemas/AlertRuleV2'], + 'deletedCount' => ['title' => '成功删除的规则数量', 'type' => 'integer', 'format' => 'int32'], + 'deletedUuidList' => [ + 'title' => '成功删除的规则 UUID 列表', + 'type' => 'array', + 'items' => ['type' => 'string'], ], - 'effective' => [ - 'title' => 'Crontab 表达式', - 'description' => 'Crontab 表达式', - 'type' => 'string', - 'example' => '* * 14-18 ? * *', + 'updatedCount' => ['title' => '成功启用 / 禁用的规则数量', 'type' => 'integer', 'format' => 'int32'], + 'updatedUuidList' => [ + 'title' => '成功启用 / 禁用的规则 UUID 列表', + 'type' => 'array', + 'items' => ['type' => 'string'], ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', + ], + ], + 'ManageAlertRulesUnifiedActionInput' => [ + 'title' => '管理告警规则请求体聚合（CREATE/UPDATE/PATCH/BATCH_DELETE/BATCH_ENABLE/BATCH_DISABLE/DELETE/ENABLE/DISABLE 共用，按 action 选填字段）', + 'type' => 'object', + 'properties' => [ + 'action' => [ + 'title' => '操作类型', 'type' => 'string', - 'example' => '2025-03-11T08:21:58Z', - ], - 'enable' => [ - 'title' => '是否启用', - 'description' => '是否启用', - 'type' => 'boolean', - 'example' => 'true', + 'required' => true, + 'enum' => ['CREATE', 'UPDATE', 'PATCH', 'BATCH_DELETE', 'BATCH_ENABLE', 'BATCH_DISABLE', 'DELETE', 'ENABLE', 'DISABLE'], + ], + 'uuid' => ['title' => '规则 UUID（UPDATE/PATCH/DELETE/ENABLE/DISABLE 必填）', 'type' => 'string'], + 'workspace' => ['title' => '工作空间（CREATE/UPDATE/DELETE/ENABLE/DISABLE 等）', 'type' => 'string'], + 'displayName' => ['title' => '显示名称', 'type' => 'string'], + 'contentTemplate' => ['title' => '内容模板', 'type' => 'string'], + 'enabled' => ['title' => '是否启用', 'type' => 'boolean'], + 'datasourceConfig' => ['$ref' => '#/components/schemas/DatasourceConfigUnified'], + 'queryConfig' => ['$ref' => '#/components/schemas/QueryConfigUnified'], + 'conditionConfig' => ['$ref' => '#/components/schemas/ConditionConfigUnified'], + 'scheduleConfig' => ['$ref' => '#/components/schemas/ScheduleConfigUnified'], + 'notifyConfig' => ['$ref' => '#/components/schemas/NotifyConfigUnified'], + 'actionIntegrationConfig' => ['$ref' => '#/components/schemas/ActionIntegrationConfig'], + 'armsIntegrationConfig' => ['$ref' => '#/components/schemas/ArmsIntegrationConfig'], + 'observeResourceInstanceId' => ['type' => 'string'], + 'observeResourceType' => ['type' => 'string'], + 'labels' => [ + 'title' => '标签', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string'], ], - 'startTime' => [ - 'title' => '生效开始时间', - 'description' => '生效开始时间', - 'type' => 'string', - 'example' => '2024-11-26 10:02:01', + 'annotations' => [ + 'title' => '注解', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string'], ], - 'endTime' => [ - 'title' => '生效结束时间', - 'description' => '生效结束时间', - 'type' => 'string', - 'example' => '2024-11-26 12:02:01', + 'uuidList' => [ + 'title' => '待删除 / 启用 / 禁用规则 UUID 列表（BATCH_DELETE / BATCH_ENABLE / BATCH_DISABLE 共用；DELETE / ENABLE / DISABLE 用 uuid 单字段）', + 'type' => 'array', + 'items' => ['type' => 'string'], ], ], ], 'MergeContact' => [ 'description' => '用于表示 联系人信息的合并对象 的结构体。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'gmtModified' => [ - 'description' => '最后修改时间。', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58.789Z', - ], - 'name' => [ - 'description' => '联系人姓名。', - 'type' => 'string', - 'example' => '张三', - ], - 'gmtCreate' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58.789Z', - ], - 'identifier' => [ - 'description' => '联系人唯一标识符。', - 'type' => 'string', - 'example' => 'user-12345', - ], - 'phoneCode' => [ - 'description' => '手机号码国家区号。', - 'type' => 'string', - 'example' => '86', - ], - 'phone' => [ - 'description' => '手机号码。', - 'type' => 'string', - 'example' => '13800138000', - ], - 'phoneVerify' => [ - 'description' => '手机号码是否已验证。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'email' => [ - 'description' => '邮箱地址。', - 'type' => 'string', - 'example' => 'zhangsan@company.com', - ], - 'emailVerify' => [ - 'description' => '邮箱是否已验证。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'lang' => [ - 'description' => '语言偏好。', - 'type' => 'string', - 'example' => 'zh-CN', - ], - 'source' => [ - 'description' => '联系人来源系统。', - 'type' => 'string', - 'example' => 'dingtalk', - ], - 'extend' => [ - 'description' => '扩展字段，用于存储额外信息。', - 'type' => 'object', - 'example' => '{ "department": "运维部", "role": "工程师" }', - ], + 'gmtModified' => ['description' => '最后修改时间。', 'visibility' => 'Public', 'type' => 'string', 'example' => '2025-03-11T08:21:58.789Z', 'backendName' => 'gmtModified'], + 'name' => ['description' => '联系人姓名。', 'visibility' => 'Public', 'type' => 'string', 'example' => '张三', 'backendName' => 'name'], + 'gmtCreate' => ['description' => '创建时间。', 'visibility' => 'Public', 'type' => 'string', 'example' => '2025-03-11T08:21:58.789Z', 'backendName' => 'gmtCreate'], + 'identifier' => ['description' => '联系人唯一标识符。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'user-12345', 'backendName' => 'identifier'], + 'phoneCode' => ['description' => '手机号码国家区号。', 'visibility' => 'Public', 'type' => 'string', 'example' => '86', 'backendName' => 'phoneCode'], + 'phone' => ['description' => '手机号码。', 'visibility' => 'Public', 'type' => 'string', 'example' => '13800138000', 'backendName' => 'phone', 'sensitive' => true], + 'phoneVerify' => ['description' => '手机号码是否已验证。', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'phoneVerify'], + 'email' => ['description' => '邮箱地址。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'zhangsan@company.com', 'backendName' => 'email', 'sensitive' => true], + 'emailVerify' => ['description' => '邮箱是否已验证。', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'emailVerify'], + 'lang' => ['description' => '语言偏好。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'zh-CN', 'backendName' => 'lang'], + 'source' => ['description' => '联系人来源系统。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'dingtalk', 'backendName' => 'source'], + 'extend' => ['description' => '扩展字段，用于存储额外信息。', 'visibility' => 'Public', 'type' => 'object', 'example' => '{ "department": "运维部", "role": "工程师" }', 'backendName' => 'extend'], ], ], 'MergeContactGroup' => [ 'description' => '用于表示 联系人组的合并对象 的结构体。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '联系人组名称。', - 'type' => 'string', - 'example' => '运维团队', - ], - 'gmtModified' => [ - 'description' => '最后修改时间。', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58.789Z', - ], - 'identifier' => [ - 'description' => '联系人组唯一标识符。', - 'type' => 'string', - 'example' => 'group-12345', - ], - 'gmtCreate' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58.789Z', - ], + 'name' => ['description' => '联系人组名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => '运维团队', 'backendName' => 'name'], + 'gmtModified' => ['description' => '最后修改时间。', 'visibility' => 'Public', 'type' => 'string', 'example' => '2025-03-11T08:21:58.789Z', 'backendName' => 'gmtCreate'], + 'identifier' => ['description' => '联系人组唯一标识符。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'group-12345', 'backendName' => 'identifier'], + 'gmtCreate' => ['description' => '创建时间。', 'visibility' => 'Public', 'type' => 'string', 'example' => '2025-03-11T08:21:58.789Z', 'backendName' => 'plan'], 'contacts' => [ 'description' => '组内成员的唯一标识符列表。', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '组内成员的唯一标识符。', - 'type' => 'string', - 'example' => 'user-12345', - ], - ], - 'extend' => [ - 'description' => '扩展字段，用于存储额外信息。', - 'type' => 'object', - 'example' => '{ "department": "运维部", "role": "工程师" }', - ], - 'source' => [ - 'description' => '联系人组来源系统。', - 'type' => 'string', - 'example' => 'dingtalk', + 'items' => ['description' => '组内成员的唯一标识符。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'user-12345', 'extendType' => 'true'], + 'backendName' => 'contacts', ], + 'extend' => ['description' => '扩展字段，用于存储额外信息。', 'visibility' => 'Public', 'type' => 'object', 'example' => '{ "department": "运维部", "role": "工程师" }', 'backendName' => 'extend'], + 'source' => ['description' => '联系人组来源系统。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'dingtalk', 'backendName' => 'source'], + ], + ], + 'MergeOncallSchedule' => [ + 'type' => 'object', + 'properties' => [ + 'gmtModified' => ['type' => 'string'], + 'name' => ['type' => 'string'], + 'gmtCreate' => ['type' => 'string'], + 'identifier' => ['type' => 'string'], + 'source' => ['type' => 'string'], + 'detail' => ['type' => 'object'], + 'workspace' => ['type' => 'string'], ], ], 'MergeRobot' => [ 'description' => '用于表示 机器人（Bot）的合并对象 的结构体。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '机器人名称。', - 'type' => 'string', - 'example' => '运维告警机器人', - ], - 'webhook' => [ - 'description' => 'Webhook 地址。', - 'type' => 'string', - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=abc123', - ], - 'type' => [ - 'description' => '机器人类型。', - 'type' => 'string', - 'example' => 'dingtalk', - ], - 'createTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58.789Z', - ], - 'gmtModified' => [ - 'description' => '最后修改时间。', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58.789Z', - ], - 'identifier' => [ - 'description' => '机器人唯一标识符。', - 'type' => 'string', - 'example' => 'robot-12345', - ], - 'lang' => [ - 'description' => '语言偏好。', - 'type' => 'string', - 'example' => 'zh-CN', - ], + 'name' => ['description' => '机器人名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => '运维告警机器人', 'backendName' => 'name'], + 'webhook' => ['description' => 'Webhook 地址。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=abc123', 'backendName' => 'webhook'], + 'type' => ['description' => '机器人类型。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'dingtalk', 'backendName' => 'type'], + 'createTime' => ['description' => '创建时间。', 'visibility' => 'Public', 'type' => 'string', 'example' => '2025-03-11T08:21:58.789Z', 'backendName' => 'gmtCreate'], + 'gmtModified' => ['description' => '最后修改时间。', 'visibility' => 'Public', 'type' => 'string', 'example' => '2025-03-11T08:21:58.789Z', 'backendName' => 'gmtModified'], + 'identifier' => ['description' => '机器人唯一标识符。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'robot-12345', 'backendName' => 'identifier'], + 'lang' => ['description' => '语言偏好。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'zh-CN', 'backendName' => 'lang'], 'extend' => [ 'description' => '扩展字段。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'dailyNoc' => [ - 'description' => '是否启用每日值班报告。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'dingSignKey' => [ - 'description' => '钉钉签名密钥。', - 'type' => 'string', - 'example' => 'abc123', - ], - 'enableOutgoing' => [ - 'description' => '是否启用出站请求。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'cardTemplate' => [ - 'description' => '卡片模板。', - 'type' => 'string', - 'example' => 'incident-card-template', - ], - 'dailyNocTime' => [ - 'description' => '每日值班报告时间。', - 'type' => 'string', - 'example' => '09:00', - ], - 'token' => [ - 'description' => '认证令牌。', - 'type' => 'string', - 'example' => 'token-abc123', - ], + 'dailyNoc' => ['description' => '是否启用每日值班报告。', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'dailyNoc'], + 'dingSignKey' => ['description' => '钉钉签名密钥。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'abc123', 'backendName' => 'dingSignKey'], + 'enableOutgoing' => ['description' => '是否启用出站请求。', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'false', 'backendName' => 'enableOutgoing'], + 'cardTemplate' => ['description' => '卡片模板。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'incident-card-template', 'backendName' => 'cardTemplate'], + 'dailyNocTime' => ['description' => '每日值班报告时间。', 'visibility' => 'Public', 'type' => 'string', 'example' => '09:00', 'backendName' => 'dailyNocTime'], + 'token' => ['description' => '认证令牌。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'token-abc123', 'backendName' => 'token', 'sensitive' => true], ], + 'backendName' => 'extend', ], - 'source' => [ - 'description' => '机器人来源系统。', - 'type' => 'string', - 'example' => 'dingtalk', - ], + 'source' => ['description' => '机器人来源系统。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'dingtalk', 'backendName' => 'source'], ], ], 'MergeWebhook' => [ 'description' => '用于表示 Webhook 的合并对象 的结构体。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'gmtCreate' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58.789Z', - ], - 'name' => [ - 'description' => 'Webhook 名称。', + 'gmtCreate' => ['description' => '创建时间。', 'visibility' => 'Public', 'type' => 'string', 'example' => '2025-03-11T08:21:58.789Z', 'backendName' => 'gmtCreate'], + 'name' => ['description' => 'Webhook 名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => '运维告警通知', 'backendName' => 'name'], + 'gmtModified' => ['description' => '最后修改时间。', 'visibility' => 'Public', 'type' => 'object', 'example' => '2025-03-11T08:21:58.789Z', 'backendName' => 'gmtModified'], + 'identifier' => ['description' => 'Webhook 唯一标识符。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'webhook-12345', 'backendName' => 'identifier'], + 'webhook' => ['description' => 'Webhook 地址，用于发送请求。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=abc123', 'backendName' => 'webhook'], + 'type' => ['description' => 'Webhook 类型，表示其目标平台。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'dingtalk', 'backendName' => 'type'], + 'headers' => ['description' => '请求头信息。', 'visibility' => 'Public', 'type' => 'string', 'example' => '{"Authorization": "Bearer abc123"}', 'backendName' => 'headers'], + 'method' => ['description' => 'HTTP 请求方法。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'POST', 'backendName' => 'method'], + 'contentType' => ['description' => '内容类型。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'application/json', 'backendName' => 'contentType'], + 'lang' => ['description' => '语言偏好。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'zh-CN', 'backendName' => 'lang'], + 'extend' => ['description' => '扩展字段，用于存储额外配置。', 'visibility' => 'Public', 'type' => 'string', 'example' => '{"timeout": 3000}', 'backendName' => 'extend'], + 'source' => ['description' => 'Webhook 来源系统。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'dingtalk', 'backendName' => 'source'], + ], + ], + 'MetricSetMultiTrigger' => [ + 'title' => 'MetricSet 多指标触发器（UMODEL_METRICSET_MULTI_CONDITION 使用）。SIMPLE 类型的 queryName、operator、threshold 直接平铺在 trigger 对象中；COMPOSITE 类型的 logicOperator、conditions 直接平铺在 trigger 对象中。', + 'type' => 'object', + 'properties' => [ + 'severity' => [ + 'title' => '告警严重等级：CRITICAL > ERROR > WARN / WARNING > INFO；多 trigger 按此优先级排序，首个匹配触发', 'type' => 'string', - 'example' => '运维告警通知', + 'enum' => ['INFO', 'WARN', 'WARNING', 'ERROR', 'CRITICAL'], ], - 'gmtModified' => [ - 'description' => '最后修改时间。', - 'type' => 'object', - 'example' => '2025-03-11T08:21:58.789Z', - ], - 'identifier' => [ - 'description' => 'Webhook 唯一标识符。', + 'durationSecs' => ['title' => '持续时间（秒），触发告警所需的数据持续满足条件的时长；不填则继承 conditionConfig.durationSecs', 'type' => 'integer', 'format' => 'int32'], + 'expressionType' => [ + 'title' => '表达式类型：SIMPLE（单指标阈值）或 COMPOSITE（多指标 AND/OR/UNLESS 组合）', 'type' => 'string', - 'example' => 'webhook-12345', + 'enum' => ['SIMPLE', 'COMPOSITE'], ], - 'webhook' => [ - 'description' => 'Webhook 地址，用于发送请求。', + 'queryName' => ['title' => '引用的查询名称（expressionType=SIMPLE 时使用），对应 QueryConfigUnified.queries[].name', 'type' => 'string'], + 'operator' => [ + 'title' => '比较操作符（expressionType=SIMPLE 时使用）：GT（大于）/ GE（大于等于）/ LT（小于）/ LE（小于等于）/ EQ（等于）/ NE（不等于）/ IN_RANGE（在区间内，需同时填 min/max）/ OUT_OF_RANGE（在区间外，需同时填 min/max）/ PRESENT（字段存在，不需要 threshold/min/max）/ NOT_PRESENT（字段不存在，不需要 threshold/min/max）', 'type' => 'string', - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=abc123', + 'enum' => ['GT', 'GE', 'GTE', 'LT', 'LE', 'LTE', 'EQ', 'NE', 'IN_RANGE', 'OUT_OF_RANGE', 'PRESENT', 'NOT_PRESENT', 'YOY_UP', 'YOY_DOWN'], ], - 'type' => [ - 'description' => 'Webhook 类型，表示其目标平台。', + 'threshold' => ['title' => '比较阈值（expressionType=SIMPLE 且 operator 为 GT/GE/LT/LE/EQ/NE 时使用；IN_RANGE/OUT_OF_RANGE 使用 min/max；PRESENT/NOT_PRESENT 不填）', 'type' => 'number', 'format' => 'double'], + 'min' => ['title' => '区间下界（expressionType=SIMPLE 且 operator=IN_RANGE/OUT_OF_RANGE 时必填）', 'type' => 'number', 'format' => 'double'], + 'max' => ['title' => '区间上界（expressionType=SIMPLE 且 operator=IN_RANGE/OUT_OF_RANGE 时必填，需 >= min）', 'type' => 'number', 'format' => 'double'], + 'logicOperator' => [ + 'title' => '逻辑运算符（expressionType=COMPOSITE 时使用）：AND（全部满足）/ OR（任一满足）/ UNLESS（首条满足且其余均不满足）', 'type' => 'string', - 'example' => 'dingtalk', + 'enum' => ['AND', 'OR', 'UNLESS'], ], - 'headers' => [ - 'description' => '请求头信息。', - 'type' => 'string', - 'example' => '{"Authorization": "Bearer abc123"}', + 'conditions' => [ + 'title' => '子条件列表（expressionType=COMPOSITE 时使用），每项含 queryName / operator / threshold', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/MetricSetTriggerSimpleExpression'], ], - 'method' => [ - 'description' => 'HTTP 请求方法。', - 'type' => 'string', - 'example' => 'POST', + ], + ], + 'MetricSetNamedQueryEntry' => [ + 'title' => 'UModel MetricSet 多指标查询命名条目', + 'type' => 'object', + 'properties' => [ + 'name' => ['title' => '查询名称，如 A、B，供 condition trigger 引用', 'type' => 'string'], + 'metricSet' => ['title' => '指标集名称', 'type' => 'string'], + 'metric' => ['title' => '指标名称', 'type' => 'string'], + 'labelFilters' => [ + 'title' => '标签过滤条件（可选，每查询独立）', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/UmodelLabelFilter'], ], - 'contentType' => [ - 'description' => '内容类型。', + ], + ], + 'MetricSetTriggerCompositeExpression' => [ + 'title' => 'MetricSet 触发器组合比较表达式：多个简单比较通过逻辑运算符组合（AND / OR / UNLESS）', + 'type' => 'object', + 'properties' => [ + 'expressionType' => ['title' => '表达式类型，固定为 COMPOSITE', 'type' => 'string'], + 'logicOperator' => [ + 'title' => '逻辑运算符：AND（全部满足）/ OR（任一满足）/ UNLESS（首条满足且其余均不满足）', 'type' => 'string', - 'example' => 'application/json', + 'enum' => ['AND', 'OR', 'UNLESS'], ], - 'lang' => [ - 'description' => '语言偏好。', - 'type' => 'string', - 'example' => 'zh-CN', + 'conditions' => [ + 'title' => '子条件列表，每项为一个简单比较表达式', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/MetricSetTriggerSimpleExpression'], ], - 'extend' => [ - 'description' => '扩展字段，用于存储额外配置。', + ], + ], + 'MetricSetTriggerSimpleExpression' => [ + 'title' => 'MetricSet 触发器简单比较表达式：单指标查询结果与阈值比较', + 'type' => 'object', + 'properties' => [ + 'expressionType' => ['title' => '表达式类型，固定为 SIMPLE', 'type' => 'string'], + 'queryName' => ['title' => '引用的查询名称，对应 QueryConfigUnified.queries[].name', 'type' => 'string'], + 'operator' => [ + 'title' => '比较操作符：GT（大于）/ GE（大于等于）/ LT（小于）/ LE（小于等于）/ EQ（等于）/ NE（不等于）/ IN_RANGE（在区间内，需同时填 min/max）/ OUT_OF_RANGE（在区间外，需同时填 min/max）/ PRESENT（字段存在，不需要 threshold/min/max）/ NOT_PRESENT（字段不存在，不需要 threshold/min/max）', 'type' => 'string', - 'example' => '{"timeout": 3000}', + 'enum' => ['GT', 'GE', 'GTE', 'LT', 'LE', 'LTE', 'EQ', 'NE', 'IN_RANGE', 'OUT_OF_RANGE', 'PRESENT', 'NOT_PRESENT', 'YOY_UP', 'YOY_DOWN'], ], - 'source' => [ - 'description' => 'Webhook 来源系统。', - 'type' => 'string', - 'example' => 'dingtalk', + 'threshold' => ['title' => '比较阈值（operator 为 GT/GE/LT/LE/EQ/NE 时使用；IN_RANGE/OUT_OF_RANGE 使用 min/max；PRESENT/NOT_PRESENT 不填）', 'type' => 'number', 'format' => 'double'], + 'min' => ['title' => '区间下界（operator=IN_RANGE/OUT_OF_RANGE 时必填）', 'type' => 'number', 'format' => 'double'], + 'max' => ['title' => '区间上界（operator=IN_RANGE/OUT_OF_RANGE 时必填，需 >= min）', 'type' => 'number', 'format' => 'double'], + ], + ], + 'ModelParameters' => [ + 'type' => 'object', + 'properties' => [ + 'temperature' => ['type' => 'number', 'format' => 'float'], + 'maxTokens' => ['type' => 'integer', 'format' => 'int64'], + 'topP' => ['type' => 'number', 'format' => 'float'], + 'topK' => ['type' => 'integer', 'format' => 'int32'], + 'frequencyPenalty' => ['type' => 'number', 'format' => 'float'], + 'presencePenalty' => ['type' => 'number', 'format' => 'float'], + 'stopSequences' => [ + 'type' => 'array', + 'items' => ['type' => 'string'], ], ], ], @@ -4752,27 +3244,80 @@ 'description' => '通知渠道配置对象', 'type' => 'object', 'properties' => [ - 'channelType' => [ - 'description' => '通知渠道类型', - 'type' => 'string', - 'example' => '"DingTalk"', - ], + 'channelType' => ['description' => '通知渠道类型', 'type' => 'string', 'example' => '"DingTalk"'], 'receivers' => [ 'description' => '接收者列表', 'type' => 'array', - 'items' => [ - 'description' => '接收者。', - 'type' => 'string', - 'example' => '[]', - ], + 'items' => ['description' => '接收者。', 'type' => 'string', 'example' => '[]'], ], 'enabledSubChannels' => [ 'description' => '启用的子渠道列表', 'type' => 'array', + 'items' => ['description' => '渠道', 'type' => 'string', 'example' => '[]'], + ], + ], + ], + 'NotifyConfigUnified' => [ + 'title' => '通知配置聚合（两种互斥子类型：DIRECT_NOTIFY 极简模式 / NOTIFY_POLICY 通知策略模式；按 type 选填对应字段）', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'title' => '通知配置类型', + 'type' => 'string', + 'required' => true, + 'enum' => ['DIRECT_NOTIFY', 'NOTIFY_POLICY'], + ], + 'channels' => [ + 'title' => '通知渠道列表（type=DIRECT_NOTIFY）', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/DirectNotifyChannel'], + ], + 'silenceTimeSecs' => ['title' => '通道沉默周期（秒，type=DIRECT_NOTIFY）；缺省 86400（24 小时）', 'type' => 'integer', 'format' => 'int32'], + 'activeDays' => [ + 'title' => '一周中发送通知的星期，1-7（type=DIRECT_NOTIFY）；缺省 [1,2,3,4,5,6,7]', + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int32'], + ], + 'activeStartTime' => ['title' => '每天通知生效开始时间（HH:mm，type=DIRECT_NOTIFY）；缺省 00:00', 'type' => 'string'], + 'activeEndTime' => ['title' => '每天通知生效结束时间（HH:mm，type=DIRECT_NOTIFY）；缺省 23:59', 'type' => 'string'], + 'utcOffset' => ['title' => 'UTC 时区偏移量（type=DIRECT_NOTIFY）；缺省 +08:00', 'type' => 'string'], + 'notifyStrategies' => [ + 'title' => '通知策略 ID 列表（type=NOTIFY_POLICY，当前业务上最多 1 个；与 DIRECT_NOTIFY 的 channels/silenceTimeSecs/activeDays/activeStartTime/activeEndTime/utcOffset 互斥）', + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + ], + ], + 'NotifyRouteForSubscription' => [ + 'type' => 'object', + 'properties' => [ + 'channels' => [ + 'type' => 'array', 'items' => [ - 'description' => '渠道', - 'type' => 'string', - 'example' => '[]', + 'type' => 'object', + 'properties' => [ + 'channelType' => ['type' => 'string'], + 'receivers' => [ + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + 'enabledSubChannels' => [ + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + ], + ], + ], + 'effectTimeRange' => [ + 'type' => 'object', + 'properties' => [ + 'timeZone' => ['type' => 'string'], + 'dayInWeek' => [ + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int32'], + ], + 'startTimeInMinute' => ['type' => 'integer', 'format' => 'int32'], + 'endTimeInMinute' => ['type' => 'integer', 'format' => 'int32'], ], ], ], @@ -4782,12 +3327,7 @@ 'description' => '用于查看的实体。', 'type' => 'object', 'properties' => [ - 'description' => [ - 'title' => '描述', - 'description' => '描述', - 'type' => 'string', - 'example' => 'test', - ], + 'description' => ['title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'test'], 'groupingSetting' => [ 'title' => '合并设置', 'description' => '合并设置', @@ -4797,49 +3337,16 @@ 'title' => '合并keys', 'description' => '合并keys', 'type' => 'array', - 'items' => [ - 'description' => '合并字段', - 'type' => 'string', - 'example' => 'severity', - ], - ], - 'periodMin' => [ - 'title' => '检查周期分钟数', - 'description' => '检查周期分钟数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'silenceSec' => [ - 'title' => '沉默秒数', - 'description' => '沉默秒数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '300', - ], - 'times' => [ - 'title' => '触发次数', - 'description' => '触发次数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'items' => ['description' => '合并字段', 'type' => 'string', 'example' => 'severity'], ], + 'periodMin' => ['title' => '检查周期分钟数', 'description' => '检查周期分钟数', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'silenceSec' => ['title' => '沉默秒数', 'description' => '沉默秒数', 'type' => 'integer', 'format' => 'int32', 'example' => '300'], + 'times' => ['title' => '触发次数', 'description' => '触发次数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], 'required' => true, ], - 'ignoreRestoredNotification' => [ - 'title' => '恢复是否通知', - 'description' => '恢复是否通知', - 'type' => 'boolean', - 'example' => 'false', - ], - 'notifyStrategyName' => [ - 'title' => '名称', - 'description' => '名称', - 'type' => 'string', - 'required' => true, - 'example' => '策略名称', - ], + 'ignoreRestoredNotification' => ['title' => '恢复是否通知', 'description' => '恢复是否通知', 'type' => 'boolean', 'example' => 'false'], + 'notifyStrategyName' => ['title' => '名称', 'description' => '名称', 'type' => 'string', 'required' => true, 'example' => '策略名称'], 'routes' => [ 'title' => '通知渠道路由设置', 'description' => '通知渠道路由设置', @@ -4862,37 +3369,19 @@ 'type' => 'string', 'required' => true, 'example' => 'CONTACT', - 'enum' => [ - 'DING', - 'WEIXIN', - 'FEISHU', - 'SLACK', - 'TEAMS', - 'CONTACT', - 'GROUP', - 'DUTY', - 'DING_COOL_APP', - ], + 'enum' => ['DING', 'WEIXIN', 'FEISHU', 'SLACK', 'TEAMS', 'CONTACT', 'GROUP', 'DUTY', 'DING_COOL_APP'], ], 'enabledSubChannels' => [ 'title' => '启用通知类型', 'description' => '启用通知类型', 'type' => 'array', - 'items' => [ - 'description' => '通知渠道', - 'type' => 'string', - 'example' => 'SMS', - ], + 'items' => ['description' => '通知渠道', 'type' => 'string', 'example' => 'SMS'], ], 'receivers' => [ 'title' => '渠道接收方', 'description' => '渠道接收方', 'type' => 'array', - 'items' => [ - 'description' => '指定接受人', - 'type' => 'string', - 'example' => 'contactId', - ], + 'items' => ['description' => '指定接受人', 'type' => 'string', 'example' => 'contactId'], 'required' => true, ], ], @@ -4907,58 +3396,21 @@ 'title' => '生效天(周一到周日)', 'description' => '生效天(周一到周日)', 'type' => 'array', - 'items' => [ - 'description' => '1-7 表示周一到周日', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - 'endTimeInMinute' => [ - 'title' => '结束时间(分钟数)', - 'description' => '结束时间(分钟数)', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '1439', - 'minimum' => '0', - 'example' => '30', - ], - 'startTimeInMinute' => [ - 'title' => '开始时间(分钟数)', - 'description' => '开始时间(分钟数)', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '1438', - 'minimum' => '0', - 'example' => '60', - ], - 'timeZone' => [ - 'title' => '时区', - 'description' => '时区', - 'type' => 'string', - 'example' => '+08:00', + 'items' => ['description' => '1-7 表示周一到周日', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], + 'endTimeInMinute' => ['title' => '结束时间(分钟数)', 'description' => '结束时间(分钟数)', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1439', 'minimum' => '0', 'example' => '30'], + 'startTimeInMinute' => ['title' => '开始时间(分钟数)', 'description' => '开始时间(分钟数)', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1438', 'minimum' => '0', 'example' => '60'], + 'timeZone' => ['title' => '时区', 'description' => '时区', 'type' => 'string', 'example' => '+08:00'], ], ], - 'filterSetting' => [ - 'description' => '路由条件', - '$ref' => '#/components/schemas/FilterSetting', - ], + 'filterSetting' => ['description' => '路由条件', '$ref' => '#/components/schemas/FilterSetting'], 'severities' => [ 'description' => '严重级别列表', 'type' => 'array', - 'items' => [ - 'description' => '严重级别，CRITICAL WARNING INFO', - 'type' => 'string', - 'example' => 'INFO', - ], - ], - 'digitalEmployeeName' => [ - 'type' => 'string', - ], - 'enableRca' => [ - 'type' => 'boolean', + 'items' => ['description' => '严重级别，CRITICAL WARNING INFO', 'type' => 'string', 'example' => 'INFO'], ], + 'digitalEmployeeName' => ['type' => 'string'], + 'enableRca' => ['type' => 'boolean'], ], ], 'required' => true, @@ -4971,62 +3423,28 @@ 'description' => '模板详情', 'type' => 'object', 'properties' => [ - 'targetType' => [ - 'title' => '通知类型', - 'description' => '通知类型', - 'type' => 'string', - 'required' => true, - 'example' => 'SMS', - ], - 'templateUuid' => [ - 'title' => '模板UUID', - 'description' => '模板UUID', - 'type' => 'string', - 'required' => true, - 'example' => '123123-12-31-231-23-12-3123', - ], + 'targetType' => ['title' => '通知类型', 'description' => '通知类型', 'type' => 'string', 'required' => true, 'example' => 'SMS'], + 'templateUuid' => ['title' => '模板UUID', 'description' => '模板UUID', 'type' => 'string', 'required' => true, 'example' => '123123-12-31-231-23-12-3123'], ], ], ], - 'enableIncidentManagement' => [ - 'description' => '是否启用事件管理', - 'type' => 'boolean', - 'example' => 'true', - ], - 'filterSetting' => [ - 'description' => '过滤设置', - '$ref' => '#/components/schemas/FilterSetting', - ], - 'workspaceFilterSetting' => [ - 'description' => '工作空间过滤设置', - '$ref' => '#/components/schemas/WorkspaceFilterSetting', - ], + 'enableIncidentManagement' => ['description' => '是否启用事件管理', 'type' => 'boolean', 'example' => 'true'], + 'filterSetting' => ['description' => '过滤设置', '$ref' => '#/components/schemas/FilterSetting'], + 'workspaceFilterSetting' => ['description' => '工作空间过滤设置', '$ref' => '#/components/schemas/WorkspaceFilterSetting'], 'pushingSetting' => [ 'description' => '推送设置', 'type' => 'object', 'properties' => [ - 'templateUuid' => [ - 'description' => '消息模板 UUID', - 'type' => 'string', - 'example' => '模板 UUID', - ], + 'templateUuid' => ['description' => '消息模板 UUID', 'type' => 'string', 'example' => '模板 UUID'], 'alertActionIds' => [ 'description' => '告警动作 ID 列表', 'type' => 'array', - 'items' => [ - 'description' => '告警动作 ID', - 'type' => 'string', - 'example' => '["action-123", "action-456"]', - ], + 'items' => ['description' => '告警动作 ID', 'type' => 'string', 'example' => '["action-123", "action-456"]'], ], 'restoreActionIds' => [ 'description' => '恢复动作 ID 列表', 'type' => 'array', - 'items' => [ - 'description' => '恢复动作 ID', - 'type' => 'string', - 'example' => '["restore-789"]', - ], + 'items' => ['description' => '恢复动作 ID', 'type' => 'string', 'example' => '["restore-789"]'], ], ], ], @@ -5034,34 +3452,234 @@ 'description' => '循环通知设置', 'type' => 'object', 'properties' => [ - 'endIncidentState' => [ - 'description' => '结束事件状态', - 'type' => 'string', - 'example' => '"Resolved"', + 'endIncidentState' => ['description' => '结束事件状态', 'type' => 'string', 'example' => '"Resolved"'], + 'repeatInterval' => ['description' => '重复通知的时间间隔', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + ], + ], + 'autoRecoverSeconds' => ['description' => '自动恢复时间', 'type' => 'integer', 'format' => 'int32', 'example' => '300'], + 'escalationId' => [ + 'description' => '升级策略 ID 列表', + 'type' => 'array', + 'items' => ['description' => '升级策略 ID', 'type' => 'string', 'example' => '["escalation-123", "escalation-456"]'], + ], + ], + ], + 'NotifyStrategyForSNSModify' => [ + 'title' => 'SNS 内嵌的通知策略入参', + 'description' => '用于 SubscriptionAndNotifyStrategy 聚合接口的 notifyStrategy 子实体入参。'."\n" + .'与老 NotifyStrategyForModify 区别：'."\n" + .'- 移除 filterSetting / workspaceFilterSetting（改由 sns.subscription 承载）'."\n" + .'- 移除 pushingSetting / repeatNotifySetting / autoRecoverSeconds / escalationId（改由 sns.responsePlan 承载）'."\n" + .'- 不暴露 uuid / mode / syncFromType / incidentResponsePlanId / enabled（后端强制覆盖）'."\n", + 'type' => 'object', + 'properties' => [ + 'description' => ['title' => '描述', 'type' => 'string'], + 'groupingSetting' => [ + 'title' => '合并设置', + 'type' => 'object', + 'properties' => [ + 'groupingKeys' => [ + 'title' => '合并keys', + 'type' => 'array', + 'items' => ['type' => 'string'], ], - 'repeatInterval' => [ - 'description' => '重复通知的时间间隔', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', + 'periodMin' => ['title' => '检查周期分钟数', 'type' => 'integer', 'format' => 'int32'], + 'silenceSec' => ['title' => '沉默秒数', 'type' => 'integer', 'format' => 'int32'], + 'times' => ['title' => '触发次数', 'type' => 'integer', 'format' => 'int32'], + ], + 'required' => true, + ], + 'ignoreRestoredNotification' => ['title' => '恢复是否通知', 'type' => 'boolean'], + 'enableIncidentManagement' => ['title' => '是否启用事件管理', 'type' => 'boolean'], + 'routes' => [ + 'title' => '通知渠道路由设置', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'channels' => [ + 'title' => '通知渠道', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'channelType' => [ + 'title' => '渠道类型', + 'type' => 'string', + 'required' => true, + 'enum' => ['DING', 'WEIXIN', 'FEISHU', 'SLACK', 'TEAMS', 'CONTACT', 'GROUP', 'DUTY', 'DING_COOL_APP'], + ], + 'enabledSubChannels' => [ + 'title' => '启用通知类型', + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + 'receivers' => [ + 'title' => '渠道接收方', + 'type' => 'array', + 'items' => ['type' => 'string'], + 'required' => true, + ], + ], + ], + ], + 'effectTimeRange' => [ + 'title' => '生效时段', + 'type' => 'object', + 'properties' => [ + 'dayInWeek' => [ + 'title' => '生效天(周一到周日)', + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int32'], + ], + 'endTimeInMinute' => ['title' => '结束时间(分钟数)', 'type' => 'integer', 'format' => 'int32'], + 'startTimeInMinute' => ['title' => '开始时间(分钟数)', 'type' => 'integer', 'format' => 'int32'], + 'timeZone' => ['title' => '时区', 'type' => 'string'], + ], + ], + 'filterSetting' => [ + 'title' => '路由级 filter（与顶层 subscription.filterSetting 不同层级）', + 'type' => 'object', + 'properties' => [ + 'conditions' => [ + 'title' => '订阅条件', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'field' => ['title' => '字段', 'type' => 'string'], + 'op' => ['title' => '比较符', 'type' => 'string'], + 'value' => ['title' => '值', 'type' => 'string'], + ], + ], + 'maxItems' => 10, + ], + 'expression' => ['title' => '表达式', 'type' => 'string'], + 'relation' => ['title' => '条件间关系', 'type' => 'string'], + ], + ], + 'severities' => [ + 'title' => '等级过滤', + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + 'digitalEmployeeName' => ['title' => '数字员工名', 'type' => 'string'], + 'enableRca' => ['title' => '是否启用 RCA', 'type' => 'boolean'], ], ], + 'required' => true, ], - 'autoRecoverSeconds' => [ - 'description' => '自动恢复时间', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '300', + 'customTemplateEntries' => [ + 'title' => '通知渠道模板', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'targetType' => ['title' => '通知类型', 'type' => 'string', 'required' => false], + 'templateUuid' => ['title' => '模板UUID', 'type' => 'string', 'required' => false], + ], + ], ], - 'escalationId' => [ - 'description' => '升级策略 ID 列表', + ], + ], + 'NotifyStrategyForSNSView' => [ + 'title' => 'SNS 内嵌的通知策略查看视图', + 'description' => '用于 SubscriptionAndNotifyStrategyForView.notifyStrategy 子字段', + 'type' => 'object', + 'properties' => [ + 'notifyStrategyId' => ['title' => 'uuid（= SNS uuid，D8）', 'type' => 'string'], + 'notifyStrategyName' => ['title' => '名称', 'type' => 'string'], + 'description' => ['title' => '描述', 'type' => 'string'], + 'enable' => ['title' => '是否启用', 'type' => 'boolean'], + 'userId' => ['title' => '用户id', 'type' => 'string'], + 'workspace' => ['title' => 'workspace', 'type' => 'string'], + 'syncFromType' => ['title' => '同步来源（SNS 新建必为 OBS）', 'type' => 'string'], + 'mode' => ['title' => '生命周期模式（SNS 内必为 BundleStrategy）', 'type' => 'string'], + 'enableIncidentManagement' => ['title' => '是否启用事件管理', 'type' => 'boolean'], + 'ignoreRestoredNotification' => ['title' => '恢复是否通知', 'type' => 'boolean'], + 'incidentResponsePlanId' => ['title' => '关联响应计划 uuid（= notifyStrategyId）', 'type' => 'string'], + 'groupingSetting' => [ + 'title' => '合并设置', + 'type' => 'object', + 'properties' => [ + 'groupingKeys' => [ + 'title' => '合并keys', + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + 'periodMin' => ['title' => '检查周期分钟数', 'type' => 'integer', 'format' => 'int32'], + 'silenceSec' => ['title' => '沉默秒数', 'type' => 'integer', 'format' => 'int32'], + 'times' => ['title' => '触发次数', 'type' => 'integer', 'format' => 'int32'], + ], + ], + 'routes' => [ + 'title' => '通知渠道路由设置', 'type' => 'array', 'items' => [ - 'description' => '升级策略 ID', - 'type' => 'string', - 'example' => '["escalation-123", "escalation-456"]', + 'type' => 'object', + 'properties' => [ + 'channels' => [ + 'title' => '通知渠道', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'channelType' => [ + 'title' => '渠道类型', + 'type' => 'string', + 'enum' => ['DING', 'WEIXIN', 'FEISHU', 'SLACK', 'TEAMS', 'CONTACT', 'GROUP', 'DUTY', 'DING_COOL_APP'], + ], + 'enabledSubChannels' => [ + 'title' => '启用通知类型', + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + 'receivers' => [ + 'title' => '渠道接收方', + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + ], + ], + ], + 'effectTimeRange' => [ + 'title' => '生效时段', + 'type' => 'object', + 'properties' => [ + 'dayInWeek' => [ + 'title' => '生效天(周一到周日)', + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int32'], + ], + 'endTimeInMinute' => ['title' => '结束时间(分钟数)', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1439', 'minimum' => '0'], + 'startTimeInMinute' => ['title' => '开始时间(分钟数)', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1438', 'minimum' => '0'], + 'timeZone' => ['title' => '时区', 'type' => 'string'], + ], + ], + 'filterSetting' => ['title' => '路由级 filter', '$ref' => '#/components/schemas/FilterSetting'], + 'severities' => [ + 'title' => '等级过滤', + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + 'digitalEmployeeName' => ['title' => '数字员工名', 'type' => 'string'], + 'enableRca' => ['title' => '是否启用 RCA', 'type' => 'boolean'], + ], + ], + ], + 'customTemplateEntries' => [ + 'title' => '通知渠道模板', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'targetType' => ['title' => '通知类型', 'type' => 'string'], + 'templateUuid' => ['title' => '模板UUID', 'type' => 'string'], + ], ], ], + 'createTime' => ['title' => '创建时间', 'type' => 'string'], + 'updateTime' => ['title' => '更新时间', 'type' => 'string'], ], ], 'NotifyStrategyForView' => [ @@ -5069,24 +3687,9 @@ 'description' => '用于查看的实体。', 'type' => 'object', 'properties' => [ - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58Z', - ], - 'description' => [ - 'title' => '描述', - 'description' => '描述', - 'type' => 'string', - 'example' => 'test', - ], - 'enable' => [ - 'title' => '是否启用', - 'description' => '是否启用', - 'type' => 'boolean', - 'example' => 'false', - ], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-03-11T08:21:58Z'], + 'description' => ['title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'test'], + 'enable' => ['title' => '是否启用', 'description' => '是否启用', 'type' => 'boolean', 'example' => 'false'], 'groupingSetting' => [ 'title' => '合并设置', 'description' => '合并设置', @@ -5096,49 +3699,16 @@ 'title' => '合并keys', 'description' => '合并keys', 'type' => 'array', - 'items' => [ - 'description' => '合并key', - 'type' => 'string', - 'example' => 'severity', - ], - ], - 'periodMin' => [ - 'title' => '检查周期分钟数', - 'description' => '检查周期分钟数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'silenceSec' => [ - 'title' => '沉默秒数', - 'description' => '沉默秒数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '300', - ], - 'times' => [ - 'title' => '触发次数', - 'description' => '触发次数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', + 'items' => ['description' => '合并key', 'type' => 'string', 'example' => 'severity'], ], + 'periodMin' => ['title' => '检查周期分钟数', 'description' => '检查周期分钟数', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'silenceSec' => ['title' => '沉默秒数', 'description' => '沉默秒数', 'type' => 'integer', 'format' => 'int32', 'example' => '300'], + 'times' => ['title' => '触发次数', 'description' => '触发次数', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], ], 'required' => true, ], - 'ignoreRestoredNotification' => [ - 'title' => '恢复是否通知', - 'description' => '恢复是否通知', - 'type' => 'boolean', - 'example' => 'true', - ], - 'notifyStrategyName' => [ - 'title' => '名称', - 'description' => '名称', - 'type' => 'string', - 'required' => true, - 'example' => '测试策略', - ], + 'ignoreRestoredNotification' => ['title' => '恢复是否通知', 'description' => '恢复是否通知', 'type' => 'boolean', 'example' => 'true'], + 'notifyStrategyName' => ['title' => '名称', 'description' => '名称', 'type' => 'string', 'required' => true, 'example' => '测试策略'], 'routes' => [ 'title' => '通知渠道路由设置', 'description' => '通知渠道路由设置', @@ -5161,37 +3731,19 @@ 'type' => 'string', 'required' => true, 'example' => 'CONTACT', - 'enum' => [ - 'DING', - 'WEIXIN', - 'FEISHU', - 'SLACK', - 'TEAMS', - 'CONTACT', - 'GROUP', - 'DUTY', - 'DING_COOL_APP', - ], + 'enum' => ['DING', 'WEIXIN', 'FEISHU', 'SLACK', 'TEAMS', 'CONTACT', 'GROUP', 'DUTY', 'DING_COOL_APP'], ], 'enabledSubChannels' => [ 'title' => '启用通知类型', 'description' => '启用通知类型', 'type' => 'array', - 'items' => [ - 'description' => '渠道', - 'type' => 'string', - 'example' => 'SMS', - ], + 'items' => ['description' => '渠道', 'type' => 'string', 'example' => 'SMS'], ], 'receivers' => [ 'title' => '渠道接收方', 'description' => '渠道接收方', 'type' => 'array', - 'items' => [ - 'description' => '接收方', - 'type' => 'string', - 'example' => 'user1', - ], + 'items' => ['description' => '接收方', 'type' => 'string', 'example' => 'user1'], 'required' => true, ], ], @@ -5206,58 +3758,21 @@ 'title' => '生效天(周一到周日)', 'description' => '生效天(周一到周日)', 'type' => 'array', - 'items' => [ - 'description' => '1-7表示周一到周日', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - 'endTimeInMinute' => [ - 'title' => '结束时间(分钟数)', - 'description' => '结束时间(分钟数)', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '1439', - 'minimum' => '0', - 'example' => '60', - ], - 'startTimeInMinute' => [ - 'title' => '开始时间(分钟数)', - 'description' => '开始时间(分钟数)', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '1438', - 'minimum' => '0', - 'example' => '60', - ], - 'timeZone' => [ - 'title' => '时区', - 'description' => '时区', - 'type' => 'string', - 'example' => '+08:00', + 'items' => ['description' => '1-7表示周一到周日', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], + 'endTimeInMinute' => ['title' => '结束时间(分钟数)', 'description' => '结束时间(分钟数)', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1439', 'minimum' => '0', 'example' => '60'], + 'startTimeInMinute' => ['title' => '开始时间(分钟数)', 'description' => '开始时间(分钟数)', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1438', 'minimum' => '0', 'example' => '60'], + 'timeZone' => ['title' => '时区', 'description' => '时区', 'type' => 'string', 'example' => '+08:00'], ], ], - 'filterSetting' => [ - 'description' => '路由设置', - '$ref' => '#/components/schemas/FilterSetting', - ], + 'filterSetting' => ['description' => '路由设置', '$ref' => '#/components/schemas/FilterSetting'], 'severities' => [ 'description' => '严重级别列表', 'type' => 'array', - 'items' => [ - 'description' => '严重级别 CRITICAL WARNING INFO', - 'type' => 'string', - 'example' => 'INFO', - ], - ], - 'digitalEmployeeName' => [ - 'type' => 'string', - ], - 'enableRca' => [ - 'type' => 'boolean', + 'items' => ['description' => '严重级别 CRITICAL WARNING INFO', 'type' => 'string', 'example' => 'INFO'], ], + 'digitalEmployeeName' => ['type' => 'string'], + 'enableRca' => ['type' => 'boolean'], ], ], 'required' => true, @@ -5270,81 +3785,31 @@ 'description' => '通知模版配置', 'type' => 'object', 'properties' => [ - 'targetType' => [ - 'title' => '通知类型', - 'description' => '通知类型', - 'type' => 'string', - 'required' => true, - 'example' => 'SMS', - ], - 'templateUuid' => [ - 'title' => '模板UUID', - 'description' => '模板UUID', - 'type' => 'string', - 'required' => true, - 'example' => '123-12-312-312-31-23', - ], + 'targetType' => ['title' => '通知类型', 'description' => '通知类型', 'type' => 'string', 'required' => true, 'example' => 'SMS'], + 'templateUuid' => ['title' => '模板UUID', 'description' => '模板UUID', 'type' => 'string', 'required' => true, 'example' => '123-12-312-312-31-23'], ], ], ], - 'updateTime' => [ - 'title' => '更新时间', - 'description' => '更新时间', - 'type' => 'string', - 'example' => '2025-05-30T02:29:09Z', - ], - 'userId' => [ - 'title' => '用户id', - 'description' => '用户id', - 'type' => 'string', - 'example' => '123123****', - ], - 'notifyStrategyId' => [ - 'title' => 'UUID', - 'description' => 'UUID', - 'type' => 'string', - 'example' => '12312-31-23-123-1-23123', - ], - 'workspace' => [ - 'title' => 'workspace', - 'description' => '工作空间', - 'type' => 'string', - 'example' => 'workspace-test', - ], - 'filterSetting' => [ - 'description' => '过滤设置', - '$ref' => '#/components/schemas/FilterSetting', - ], - 'workspaceFilterSetting' => [ - 'description' => '工作空间过滤设置', - '$ref' => '#/components/schemas/WorkspaceFilterSetting', - ], + 'updateTime' => ['title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2025-05-30T02:29:09Z'], + 'userId' => ['title' => '用户id', 'description' => '用户id', 'type' => 'string', 'example' => '123123****'], + 'notifyStrategyId' => ['title' => 'UUID', 'description' => 'UUID', 'type' => 'string', 'example' => '12312-31-23-123-1-23123'], + 'workspace' => ['title' => 'workspace', 'description' => '工作空间', 'type' => 'string', 'example' => 'workspace-test'], + 'filterSetting' => ['description' => '过滤设置', '$ref' => '#/components/schemas/FilterSetting'], + 'workspaceFilterSetting' => ['description' => '工作空间过滤设置', '$ref' => '#/components/schemas/WorkspaceFilterSetting'], 'pushingSetting' => [ 'description' => '推送设置', 'type' => 'object', 'properties' => [ - 'templateUuid' => [ - 'description' => '模板 UUID', - 'type' => 'string', - 'example' => '"template-abc123"', - ], + 'templateUuid' => ['description' => '模板 UUID', 'type' => 'string', 'example' => '"template-abc123"'], 'alertActionIds' => [ 'description' => '告警动作 ID 列表', 'type' => 'array', - 'items' => [ - 'description' => '告警动作 ID', - 'type' => 'string', - 'example' => '"action-123"', - ], + 'items' => ['description' => '告警动作 ID', 'type' => 'string', 'example' => '"action-123"'], ], 'restoreActionIds' => [ 'description' => '恢复动作 ID 列表', 'type' => 'array', - 'items' => [ - 'description' => '恢复动作 ID', - 'type' => 'string', - 'example' => '"restore-789"', - ], + 'items' => ['description' => '恢复动作 ID', 'type' => 'string', 'example' => '"restore-789"'], ], ], ], @@ -5352,164 +3817,608 @@ 'description' => '循环通知设置', 'type' => 'object', 'properties' => [ - 'endIncidentState' => [ - 'description' => '结束事件状态', - 'type' => 'string', - 'example' => '"Resolved"', - ], - 'repeatInterval' => [ - 'description' => '重复通知的时间间隔', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], + 'endIncidentState' => ['description' => '结束事件状态', 'type' => 'string', 'example' => '"Resolved"'], + 'repeatInterval' => ['description' => '重复通知的时间间隔', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], ], ], - 'autoRecoverSeconds' => [ - 'description' => '自动恢复时间', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '300', - ], - 'syncFromType' => [ - 'description' => '同步策略来源类型', - 'type' => 'string', - 'example' => '"ARMS"', - ], + 'autoRecoverSeconds' => ['description' => '自动恢复时间', 'type' => 'integer', 'format' => 'int32', 'example' => '300'], + 'syncFromType' => ['description' => '同步策略来源类型', 'type' => 'string', 'example' => '"ARMS"'], 'receiverNames' => [ 'description' => '接收者名称列表', 'type' => 'array', - 'items' => [ - 'description' => '接收者名称', - 'type' => 'string', - 'example' => '"张三"', - ], + 'items' => ['description' => '接收者名称', 'type' => 'string', 'example' => '"张三"'], ], 'incidentEscalationPolicies' => [ 'description' => '关联的升级策略列表', 'type' => 'array', + 'items' => ['description' => '升级策略', 'type' => 'any', 'example' => '{ "name": "Critical-Escalation"}'], + ], + ], + ], + 'NotifyStrategyIdFilter' => [ + 'title' => '通知策略 ID 过滤', + 'type' => 'object', + 'properties' => [ + 'eq' => ['title' => '精确匹配', 'type' => 'string'], + ], + ], + 'ObserveGroup' => [ + 'type' => 'object', + 'properties' => [ + 'groupId' => ['title' => '观测分组 ID', 'description' => '观测分组全局唯一 ID，格式 og-<16位hash>，指标/告警/控制台统一使用。', 'type' => 'string'], + 'groupName' => ['title' => '观测分组名称', 'description' => '观测分组名称（同 workspace 下唯一）。', 'type' => 'string'], + 'description' => ['title' => '分组描述', 'description' => '观测分组描述（业务用途说明）。', 'type' => 'string'], + 'resourceGroupId' => ['title' => '资源组 ID', 'description' => '阿里云资源组 ID。', 'type' => 'string'], + 'aliUid' => ['title' => '主账号 UID', 'description' => '分组归属的阿里云主账号 UID。', 'type' => 'string'], + 'regionId' => ['title' => '地域 ID', 'description' => '分组所属地域 ID。', 'type' => 'string'], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间，UTC 格式 yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string'], + 'modifyTime' => ['title' => '修改时间', 'description' => '最后修改时间，UTC 格式 yyyy-MM-ddTHH:mm:ssZ。资源任意属性变更时自动更新。', 'type' => 'string'], + 'groupType' => ['title' => '分组类型', 'description' => '观测分组类型。', 'type' => 'string'], + 'discoverRules' => [ + 'title' => '发现规则', + 'description' => '实体发现规则列表，定义分组自动匹配哪些实体。', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/ObserveGroupDiscoverRule'], + ], + 'extraInfo' => ['title' => '扩展信息', 'description' => '扩展信息（JSON 字符串，承载告警模板/联系人组/暂停策略等）。', 'type' => 'string'], + 'workspaceId' => ['title' => 'Workspace ID', 'description' => '分组归属的 workspace ID（workspace 级归属，创建后不可变）。', 'type' => 'string'], + 'sourceOrigin' => ['title' => '数据来源', 'description' => '数据来源：native_2_0（2.0 原生）/ synced_from_1_0（从 1.0 应用分组同步）。', 'type' => 'string'], + 'originGroupId' => ['title' => '1.0 分组 ID', 'description' => '仅 synced_from_1_0 时填值，存 1.0 应用分组的 product_group.id。', 'type' => 'string'], + 'entityCounts' => [ + 'title' => '各分类实体数量', + 'description' => '各分类实体数量。key=分类 domain（acs=云产品 / apm / rum，可扩展），value=该分类下属于本分组的实体数。仅 withEntityCount=true 时返回。', + 'type' => 'object', + 'additionalProperties' => ['type' => 'integer', 'format' => 'int32'], + ], + 'health' => ['title' => '健康状态', 'description' => '分组健康状态：-1 未知（占位）/ 1 健康 / 0 不健康。', 'type' => 'integer', 'format' => 'int32'], + 'favorited' => ['title' => '是否关注', 'description' => '当前用户是否已关注该分组（「我的关注」筛选依据）。', 'type' => 'boolean'], + 'ogEntityInfoEnabled' => ['title' => 'og_entity_info 指标输出开关', 'description' => '是否开启 og_entity_info 指标输出。开启后数据面会把本分组归属写入目标 Prometheus 实例。', 'type' => 'boolean'], + 'ogEntityInfoPromInstances' => [ + 'title' => 'og_entity_info Prometheus 实例集合', + 'description' => '写入 og_entity_info 的 Prometheus 实例集合，包含系统自动识别(system)和用户自定义(custom)两类来源。', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/ObserveGroupPromInstance'], + ], + 'tags' => [ + 'title' => '资源标签', + 'description' => '资源标签（阿里云标准标签），键值对数组。', + 'type' => 'array', 'items' => [ - 'description' => '升级策略', - 'type' => 'any', - 'example' => '{ "name": "Critical-Escalation"}', + 'type' => 'object', + 'properties' => [ + 'tagKey' => ['title' => '标签键', 'description' => '标签键。', 'type' => 'string'], + 'tagValue' => ['title' => '标签值', 'description' => '标签值。', 'type' => 'string'], + ], ], ], ], ], - 'PrometheusManagedInstance' => [ - 'description' => 'Prometheus纳管实例结构', + 'ObserveGroupDetail' => [ 'type' => 'object', 'properties' => [ - 'prometheusInstanceId' => [ - 'title' => 'RUM关联的Prometheus实例ID', - 'description' => 'RUM关联的Prometheus实例ID', - 'type' => 'string', - 'example' => 'rum-xxx', + 'groupId' => ['title' => '观测分组ID', 'type' => 'string'], + 'groupName' => ['title' => '观测分组名称', 'description' => '观测分组名称（同 workspace 下唯一）。', 'type' => 'string'], + 'description' => ['title' => '分组描述', 'description' => '观测分组描述（业务用途说明）。', 'type' => 'string'], + 'resourceGroupId' => ['title' => '资源组 ID', 'description' => '阿里云资源组 ID。', 'type' => 'string'], + 'aliUid' => ['title' => '主账号 UID', 'description' => '分组归属的阿里云主账号 UID。', 'type' => 'string'], + 'regionId' => ['title' => '地域 ID', 'description' => '分组所属地域 ID。', 'type' => 'string'], + 'groupType' => ['title' => '分组类型', 'description' => '观测分组类型。', 'type' => 'string'], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间，UTC 格式 yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string'], + 'modifyTime' => ['title' => '修改时间', 'description' => '最后修改时间，UTC 格式 yyyy-MM-ddTHH:mm:ssZ。资源任意属性变更时自动更新。', 'type' => 'string'], + 'discoverRules' => [ + 'title' => '发现规则', + 'description' => '实体发现规则列表，定义分组自动匹配哪些实体。', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/ObserveGroupDiscoverRule'], + ], + 'extraInfo' => ['title' => '扩展信息', 'description' => '扩展信息（JSON 字符串，承载告警模板/联系人组/暂停策略等）。', 'type' => 'string'], + 'workspaceId' => ['title' => 'Workspace ID', 'description' => '分组归属的 workspace ID（workspace 级归属，创建后不可变）。', 'type' => 'string'], + 'sourceOrigin' => ['title' => '数据来源', 'description' => '数据来源：native_2_0（2.0 原生）/ synced_from_1_0（从 1.0 应用分组同步）。', 'type' => 'string'], + 'originGroupId' => ['title' => '1.0 分组 ID', 'description' => '仅 synced_from_1_0 时填值，存 1.0 应用分组的 product_group.id。', 'type' => 'string'], + 'entitySummaries' => [ + 'title' => '实体统计', + 'description' => '分组内实体按类型的统计。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'entityDomain' => ['title' => '实体域', 'description' => '实体域。', 'type' => 'string'], + 'entityType' => ['title' => '实体类型', 'description' => '实体类型。', 'type' => 'string'], + 'entityCount' => ['title' => '实体数量', 'description' => '实体数量。', 'type' => 'integer', 'format' => 'int32'], + 'entityCategory' => ['title' => '实体分类', 'description' => '实体分类。', 'type' => 'string'], + ], + ], ], - 'prometheusInstanceName' => [ - 'title' => 'RUM关联的Prometheus实例名称', - 'description' => 'RUM关联的Prometheus实例名称', - 'type' => 'string', - 'example' => 'rum-xxx', + 'favorited' => ['title' => '是否关注', 'description' => '当前用户是否已关注该分组。', 'type' => 'boolean'], + 'ogEntityInfoEnabled' => ['title' => 'og_entity_info 指标输出开关', 'description' => '是否开启 og_entity_info 指标输出。开启后数据面会把本分组归属写入目标 Prometheus 实例。', 'type' => 'boolean'], + 'ogEntityInfoPromInstances' => [ + 'title' => 'og_entity_info Prometheus 实例集合', + 'description' => '写入 og_entity_info 的 Prometheus 实例集合，包含系统自动识别(system)和用户自定义(custom)两类来源。', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/ObserveGroupPromInstance'], ], - 'regionId' => [ - 'title' => '阿里云RegionId', - 'description' => '阿里云RegionId', - 'type' => 'string', - 'example' => 'cn-hangzhou', + 'tags' => [ + 'title' => '资源标签', + 'description' => '资源标签（阿里云标准标签），键值对数组。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'tagKey' => ['title' => '标签键', 'description' => '标签键。', 'type' => 'string'], + 'tagValue' => ['title' => '标签值', 'description' => '标签值。', 'type' => 'string'], + ], + ], ], - 'workspace' => [ - 'title' => '云监控2.0 workspace', - 'description' => '云监控2.0 workspace', - 'type' => 'string', - 'example' => 'workspace-test', + ], + ], + 'ObserveGroupDiscoverRule' => [ + 'type' => 'object', + 'properties' => [ + 'ruleId' => ['title' => '规则 ID', 'description' => '规则稳定 ID（编辑/删除/启停锚点），格式 dr-<16位hash>。', 'type' => 'string'], + 'ruleType' => ['title' => '匹配方式', 'description' => '匹配方式：byTag / byResourceGroup / byInstanceName / byManual / bySpl。', 'type' => 'string'], + 'scope' => ['title' => '适用范围', 'description' => '适用范围：all（全部实体类型，独占）/ entity（指定实体类型）。', 'type' => 'string'], + 'enabled' => ['title' => '是否启用', 'description' => '规则是否启用；false 时数据面跳过该规则（不匹配 / 不打标 / 不下发）。', 'type' => 'boolean'], + 'gmtCreate' => ['title' => '创建时间', 'description' => '规则创建时间（Unix 毫秒时间戳），控制台展示用。', 'type' => 'integer', 'format' => 'int64'], + 'entityType' => ['title' => '实体类型', 'description' => '（旧）单实体类型，向后兼容，优先用 entityTypes。', 'type' => 'string'], + 'entityTypes' => [ + 'title' => '实体类型列表', + 'description' => '实体类型列表，支持一条规则跨多类型匹配（如 acs.ecs.instance/acs.rds.instance/acs.arms.service）。', + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + 'spl' => ['title' => 'SPL 表达式', 'description' => '完整 SPL 表达式（高级配置）；非空时优先生效，覆盖其它过滤字段。', 'type' => 'string'], + 'userId' => ['title' => '用户 UID', 'description' => '规则所属用户 UID。', 'type' => 'string'], + 'resourceGroupId' => ['title' => '资源组 ID', 'description' => '按资源组过滤。', 'type' => 'string'], + 'tagRules' => [ + 'title' => '标签匹配规则', + 'description' => '标签匹配规则。', + 'type' => 'object', + 'properties' => [ + 'op' => ['title' => '标签匹配逻辑', 'description' => '标签匹配逻辑。', 'type' => 'string'], + 'tags' => [ + 'title' => '标签条件列表', + 'description' => '标签条件列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'tagKey' => ['title' => '标签键', 'description' => '标签键。', 'type' => 'string'], + 'op' => ['title' => '匹配操作', 'description' => '匹配操作。', 'type' => 'string'], + 'tagValues' => [ + 'title' => '标签值列表', + 'description' => '标签值列表。', + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + ], + ], + ], + ], ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58Z', + 'nameRules' => [ + 'title' => '名称匹配规则', + 'description' => '名称匹配规则。', + 'type' => 'object', + 'properties' => [ + 'op' => ['title' => '名称匹配逻辑', 'description' => '名称匹配逻辑。', 'type' => 'string'], + 'tags' => [ + 'title' => '名称条件列表', + 'description' => '名称条件列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'op' => ['title' => '匹配操作', 'description' => '匹配操作。', 'type' => 'string'], + 'tagValues' => [ + 'title' => '匹配值列表', + 'description' => '匹配值列表。', + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + ], + ], + ], + ], ], - 'instanceType' => [ - 'title' => '实例类型', - 'description' => '实例类型', - 'type' => 'string', - 'example' => 'test', + 'instanceIds' => [ + 'title' => '实例 ID 列表', + 'description' => '手动指定的实例 ID 列表（枚举型，含 1.0 手动实例同步）。', + 'type' => 'array', + 'items' => ['type' => 'string'], ], - 'status' => [ - 'title' => '实例状态', - 'description' => '实例状态', - 'type' => 'string', - 'example' => 'Running', + 'regionIds' => [ + 'title' => '地域列表', + 'description' => '按地域过滤的 region ID 列表。', + 'type' => 'array', + 'items' => ['type' => 'string'], ], ], ], + 'ObserveGroupInstance' => [ + 'type' => 'object', + 'properties' => [ + 'entityDomain' => ['title' => '实体域', 'description' => '实体域（如 acs）。', 'type' => 'string'], + 'entityType' => ['title' => '实体类型', 'description' => '实体类型（如 acs.ecs.instance）。', 'type' => 'string'], + 'instanceId' => ['title' => '实例 ID', 'description' => '实例 ID。', 'type' => 'string'], + 'instanceName' => ['title' => '实例名称', 'description' => '实例名称。', 'type' => 'string'], + 'regionId' => ['title' => '地域 ID', 'description' => '实例所属地域 ID。', 'type' => 'string'], + 'resourceGroupId' => ['title' => '资源组 ID', 'description' => '实例所属资源组 ID。', 'type' => 'string'], + 'userId' => ['title' => '用户 UID', 'description' => '实例归属的用户 UID。', 'type' => 'string'], + 'category' => ['title' => '实体分类', 'description' => '实体分类（由 entityType 适配）。', 'type' => 'string'], + 'groupId' => ['title' => '观测分组 ID', 'description' => '所属观测分组 ID。', 'type' => 'string'], + 'tags' => [ + 'title' => '标签', + 'description' => '实例标签键值对。', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string'], + ], + 'dimension' => [ + 'title' => '监控维度', + 'description' => '监控维度键值对。', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string'], + ], + ], + ], + 'ObserveGroupPromInstance' => [ + 'type' => 'object', + 'properties' => [ + 'id' => ['title' => 'Prometheus 实例 ID', 'description' => 'Prometheus 实例 ID，如 rw-xxxxxxxxxx。', 'type' => 'string'], + 'region' => ['title' => 'Prometheus 实例地域', 'description' => 'Prometheus 实例所在地域。为空时后端按观测分组所属 workspace 地域补齐。', 'type' => 'string'], + 'kind' => ['title' => '实例来源', 'description' => '实例来源：system 表示系统根据 workspace/UModel 自动识别，custom 表示用户在控制台手动选择。', 'type' => 'string'], + 'time' => ['title' => '记录时间', 'description' => '记录写入或选择时间，格式 yyyy-MM-dd HH:mm:ss。', 'type' => 'string'], + ], + ], + 'ObserveResourceGlobalScopeFilter' => [ + 'title' => '是否对该资源类型全量生效过滤（精确匹配）', + 'type' => 'object', + 'properties' => [ + 'eq' => ['title' => '精确匹配', 'type' => 'boolean'], + ], + ], + 'ObserveResourceListFilter' => [ + 'title' => '资源实例 ID 列表过滤（contains 语义；多值时按 OR 命中：规则的 observeResourceList 包含数组中任一即命中）', + 'type' => 'object', + 'properties' => [ + 'contains' => [ + 'title' => '命中条件：规则的 observeResourceList 中至少包含数组中任一实例 ID（OR 语义）', + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + ], + ], + 'ObserveResourceTypeFilter' => [ + 'title' => '监控资源类型过滤（精确匹配）', + 'type' => 'object', + 'properties' => [ + 'eq' => ['title' => '精确匹配', 'type' => 'string'], + ], + ], + 'Pagination' => [ + 'title' => '分页配置', + 'type' => 'object', + 'properties' => [ + 'pageNumber' => ['title' => '页码（从 1 开始）', 'type' => 'integer', 'format' => 'int32'], + 'pageSize' => ['title' => '每页数量', 'type' => 'integer', 'format' => 'int32'], + ], + ], + 'PartitionKeyFilter' => [ + 'title' => '分区键过滤（精确匹配）', + 'type' => 'object', + 'properties' => [ + 'eq' => ['title' => '精确匹配', 'type' => 'string'], + ], + ], + 'PrometheusManagedInstance' => [ + 'description' => 'Prometheus纳管实例结构', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'prometheusInstanceId' => ['title' => 'RUM关联的Prometheus实例ID', 'description' => 'RUM关联的Prometheus实例ID', 'visibility' => 'Public', 'type' => 'string', 'example' => 'rum-xxx', 'backendName' => 'prometheusInstanceId'], + 'prometheusInstanceName' => ['title' => 'RUM关联的Prometheus实例名称', 'description' => 'RUM关联的Prometheus实例名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'rum-xxx', 'backendName' => 'prometheusInstanceName'], + 'regionId' => ['title' => '阿里云RegionId', 'description' => '阿里云RegionId', 'visibility' => 'Public', 'type' => 'string', 'example' => 'cn-hangzhou', 'backendName' => 'regionId'], + 'workspace' => ['title' => '云监控2.0 workspace', 'description' => '云监控2.0 workspace', 'visibility' => 'Public', 'type' => 'string', 'example' => 'workspace-test', 'backendName' => 'workspace'], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'visibility' => 'Public', 'type' => 'string', 'example' => '2025-03-11T08:21:58Z', 'backendName' => 'createTime'], + 'instanceType' => ['title' => '实例类型', 'description' => '实例类型', 'visibility' => 'Public', 'type' => 'string', 'example' => 'test', 'backendName' => 'instanceType'], + 'status' => ['title' => '实例状态', 'description' => '实例状态', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Running', 'backendName' => 'status'], + ], + ], + 'PromptTemplateItem' => [ + 'type' => 'object', + 'properties' => [ + 'role' => ['type' => 'string'], + 'content' => ['type' => 'string'], + ], + ], 'PushingSetting' => [ 'description' => '推送设置对象', 'type' => 'object', 'properties' => [ - 'templateUuid' => [ - 'description' => '消息模板 UUID', - 'type' => 'string', - 'example' => '"template-abc123"', - ], + 'templateUuid' => ['description' => '消息模板 UUID', 'type' => 'string', 'example' => '"template-abc123"'], 'alertActionIds' => [ 'description' => '告警动作 ID 列表', 'type' => 'array', - 'items' => [ - 'description' => '告警动作 ID', - 'type' => 'string', - 'example' => '"action-123"', - ], + 'items' => ['description' => '告警动作 ID', 'type' => 'string', 'example' => '"action-123"'], ], 'restoreActionIds' => [ 'description' => '恢复动作 ID 列表', 'type' => 'array', - 'items' => [ - 'description' => '恢复动作 ID', - 'type' => 'string', - 'example' => '"restore-789"', - ], + 'items' => ['description' => '恢复动作 ID', 'type' => 'string', 'example' => '"restore-789"'], ], ], ], - 'RepeatNotifySetting' => [ - 'description' => '循环通知设置对象', + 'QueryAlertRulesFilter' => [ + 'title' => '过滤条件（同级字段 AND）', + 'type' => 'object', + 'properties' => [ + 'uuid' => ['$ref' => '#/components/schemas/UuidFilter'], + 'displayName' => ['$ref' => '#/components/schemas/DisplayNameFilter'], + 'labels' => ['$ref' => '#/components/schemas/LabelsFilter'], + 'status' => ['$ref' => '#/components/schemas/StatusFilter'], + 'enabled' => ['$ref' => '#/components/schemas/EnabledFilter'], + 'datasourceType' => ['$ref' => '#/components/schemas/DatasourceTypeFilter'], + 'observeResourceType' => ['$ref' => '#/components/schemas/ObserveResourceTypeFilter'], + 'observeResourceGlobalScope' => ['$ref' => '#/components/schemas/ObserveResourceGlobalScopeFilter'], + 'observeResourceList' => ['$ref' => '#/components/schemas/ObserveResourceListFilter'], + 'observeResourceInstanceId' => ['title' => '[已废弃] 资源实例 ID 单值过滤；仅为兼容历史 SDK 保留，新接入请改用 observeResourceList.contains。当本字段非空且 observeResourceList 未填时，等价于 observeResourceList.contains=[observeResourceInstanceId]', 'type' => 'string', 'deprecated' => true, 'example' => 'i-bp1abcxxxxxxxx'], + 'severityLevels' => ['$ref' => '#/components/schemas/SeverityLevelsFilter'], + 'notifyStrategyId' => ['$ref' => '#/components/schemas/NotifyStrategyIdFilter'], + 'partitionKey' => ['$ref' => '#/components/schemas/PartitionKeyFilter'], + ], + ], + 'QueryAlertRulesInput' => [ + 'title' => '查询告警规则请求', 'type' => 'object', 'properties' => [ - 'endIncidentState' => [ - 'description' => '结束事件状态', + 'filter' => ['$ref' => '#/components/schemas/QueryAlertRulesFilter'], + 'pagination' => ['$ref' => '#/components/schemas/Pagination'], + 'workspace' => ['title' => '工作空间（可选）。不传时按 callerUserId + callerRegionId 返回全量告警规则；传值时仅返回该 workspace 下的规则。', 'type' => 'string'], + ], + ], + 'QueryAlertRulesResult' => [ + 'title' => '查询告警规则响应 data', + 'type' => 'object', + 'properties' => [ + 'totalCount' => ['title' => '符合查询条件的总告警规则数', 'type' => 'integer', 'format' => 'int64'], + 'alertRules' => [ + 'title' => '告警规则列表', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/AlertRuleV2'], + ], + ], + ], + 'QueryConfigUnified' => [ + 'title' => '查询配置聚合（PROMETHEUS_SINGLE_QUERY / UMODEL_METRICSET_QUERY / UMODEL_LOGSET_QUERY / APM_MULTI_QUERY / CLOUD_MONITORING_QUERY / UMODEL_METRICSET_MULTI_QUERY / UNKNOWN_QUERY）', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'title' => '查询类型', 'type' => 'string', - 'example' => '"Resolved"', + 'required' => true, + 'enum' => ['PROMETHEUS_SINGLE_QUERY', 'UMODEL_METRICSET_QUERY', 'UMODEL_LOGSET_QUERY', 'APM_MULTI_QUERY', 'CLOUD_MONITORING_QUERY', 'UMODEL_METRICSET_MULTI_QUERY', 'UNKNOWN_QUERY'], + ], + 'expr' => ['title' => '查询表达式 / SPL 语句。type=PROMETHEUS_SINGLE_QUERY 时推荐填写；type=UMODEL_METRICSET_QUERY 时可选，用于自定义 SPL；type=UMODEL_LOGSET_QUERY 时必填，必须提供 SPL 查询语句（业务层会执行必填校验）', 'type' => 'string'], + 'promQl' => ['title' => '[已废弃] 旧版 Prometheus 查询语句字段，请改用 expr；本字段为兼容保留，后端会自动归一为 expr', 'type' => 'string', 'deprecated' => true], + 'enableDataCompleteCheck' => ['title' => '是否启用数据完整性检查（type=PROMETHEUS_SINGLE_QUERY；其它 type 不接受本字段，严格模式下会 400）', 'type' => 'boolean'], + 'metricSet' => ['title' => '指标集名称（type=UMODEL_METRICSET_QUERY）', 'type' => 'string'], + 'metric' => ['title' => '指标名称（type=UMODEL_METRICSET_QUERY）', 'type' => 'string'], + 'queries' => [ + 'title' => '多指标命名查询条目列表（type=UMODEL_METRICSET_MULTI_QUERY），每个条目包含 name、metricSet、metric 及可选的 labelFilters', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/MetricSetNamedQueryEntry'], + ], + 'logSet' => ['title' => '日志集名称（type=UMODEL_LOGSET_QUERY）', 'type' => 'string'], + 'windowSecs' => ['title' => '聚合时间窗口（秒），type=UMODEL_METRICSET_QUERY / UMODEL_LOGSET_QUERY 时使用；有效范围 [60, 86400]', 'type' => 'integer', 'format' => 'int64'], + 'offsetSecs' => ['title' => '查询时间偏移（秒），type=UMODEL_METRICSET_QUERY / UMODEL_LOGSET_QUERY 时使用；与 windowSecs 配合实现 [T - windowSecs - offsetSecs, T - offsetSecs] 的偏移查询；有效范围 [0, 86400]', 'type' => 'integer', 'format' => 'int64'], + 'aggregate' => [ + 'title' => '聚合函数，type=UMODEL_METRICSET_QUERY / UMODEL_LOGSET_QUERY 时使用', + 'type' => 'string', + 'enum' => ['AVG', 'MAX', 'MIN', 'SUM', 'LAST'], + ], + 'entityDomain' => ['title' => '实体所属域', 'type' => 'string'], + 'entityType' => ['title' => '实体类型', 'type' => 'string'], + 'entityFilters' => [ + 'title' => '实体过滤列表', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/UmodelEntityFilter'], + ], + 'labelFilters' => [ + 'title' => '标签过滤条件', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/UmodelLabelFilter'], + ], + 'entityFields' => [ + 'title' => '需要附带返回的实体字段', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/UmodelEntityField'], + ], + 'serviceIdList' => [ + 'title' => '服务 ID 列表（type=APM_MULTI_QUERY）', + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + 'filterList' => [ + 'title' => 'APM 过滤条件列表', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/ApmFilterConfig'], ], - 'repeatInterval' => [ - 'description' => '重复通知的时间间隔', + 'measureList' => [ + 'title' => 'APM 度量配置列表', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/ApmMeasureConfig'], + ], + 'namespace' => ['title' => '云监控 namespace（云产品名，type=CLOUD_MONITORING_QUERY）', 'type' => 'string'], + 'relationType' => [ + 'title' => '资源关联类型（type=CLOUD_MONITORING_QUERY）', 'type' => 'string', - 'example' => '5', + 'enum' => ['INSTANCE', 'GROUP', 'USER'], + ], + 'dimensions' => [ + 'title' => '维度列表（type=CLOUD_MONITORING_QUERY，每个 dimension 是 key/value 字符串映射）', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'additionalProperties' => ['type' => 'string'], + ], ], + 'groupId' => ['title' => '资源分组 ID（type=CLOUD_MONITORING_QUERY，relationType=GROUP 时使用）', 'type' => 'string'], + 'legacyType' => ['title' => '当 type=UNKNOWN_QUERY 时返回，用于标识本规则当前不可在新 API 上编辑；请提服务工单联系云监控产品团队', 'type' => 'string'], + 'legacyRaw' => ['title' => '当 type=UNKNOWN_QUERY 且为读路径解析失败兜底时返回的原始 V1 query JSON 字符串（含触发失败的字段值，例如 filter.operator=ABC）。前端见此字段非空时仅做只读展示。', 'type' => 'string'], + ], + ], + 'RepeatNotifySetting' => [ + 'description' => '循环通知设置对象', + 'type' => 'object', + 'properties' => [ + 'endIncidentState' => ['description' => '结束事件状态', 'type' => 'string', 'example' => '"Resolved"'], + 'repeatInterval' => ['description' => '重复通知的时间间隔', 'type' => 'string', 'example' => '5'], ], ], 'RumDnsResponse' => [ 'description' => 'RUM上报域名', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'domain' => [ - 'title' => 'RUM上报域名', - 'description' => 'RUM上报域名', + 'domain' => ['title' => 'RUM上报域名', 'description' => 'RUM上报域名', 'visibility' => 'Public', 'type' => 'string', 'example' => 'rum', 'backendName' => 'domain'], + 'result' => ['title' => '域名DNS初始化状态', 'description' => '域名DNS初始化状态', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'result'], + 'message' => ['title' => '初始化message（失败场景）', 'description' => '初始化message（失败场景）', 'visibility' => 'Public', 'type' => 'string', 'example' => '""', 'backendName' => 'message'], + ], + ], + 'ScheduleConfigUnified' => [ + 'title' => '调度配置聚合（FIXED / CRON）', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'title' => '调度类型', 'type' => 'string', - 'example' => 'rum', + 'required' => true, + 'enum' => ['FIXED'], ], - 'result' => [ - 'title' => '域名DNS初始化状态', - 'description' => '域名DNS初始化状态', - 'type' => 'boolean', - 'example' => 'true', + 'intervalSecs' => ['title' => '调度间隔（秒），type=FIXED 时使用', 'type' => 'integer', 'format' => 'int32'], + ], + ], + 'ServerResponseManageAlertRulesResult' => [ + 'title' => '服务器响应', + 'type' => 'object', + 'properties' => [ + 'data' => ['$ref' => '#/components/schemas/ManageAlertRulesResult'], + 'code' => ['title' => '响应码', 'type' => 'string'], + 'success' => ['title' => '是否成功', 'type' => 'boolean'], + 'requestId' => ['title' => '请求 ID', 'type' => 'string'], + 'message' => ['title' => '错误消息', 'type' => 'string'], + 'total' => ['title' => '总数', 'type' => 'integer', 'format' => 'int32'], + 'pageSize' => ['title' => '每页大小', 'type' => 'integer', 'format' => 'int32'], + 'pageNumber' => ['title' => '页码', 'type' => 'integer', 'format' => 'int32'], + 'nextToken' => ['title' => '分页 Token', 'type' => 'string'], + ], + ], + 'ServerResponseQueryAlertRulesResult' => [ + 'title' => '服务器响应', + 'type' => 'object', + 'properties' => [ + 'data' => ['$ref' => '#/components/schemas/QueryAlertRulesResult'], + 'code' => ['type' => 'string'], + 'success' => ['type' => 'boolean'], + 'requestId' => ['type' => 'string'], + 'message' => ['type' => 'string'], + 'total' => ['type' => 'integer', 'format' => 'int32'], + 'pageSize' => ['type' => 'integer', 'format' => 'int32'], + 'pageNumber' => ['type' => 'integer', 'format' => 'int32'], + 'nextToken' => ['type' => 'string'], + ], + ], + 'SeverityLevelsFilter' => [ + 'title' => '严重等级过滤（contains 语义；多值时按 OR 命中：规则覆盖的等级集合包含数组中任一即可；可选 CRITICAL/ERROR/WARNING/INFO，大小写不敏感，可含别名 WARN/P1）', + 'type' => 'object', + 'properties' => [ + 'contains' => [ + 'title' => '命中条件：规则覆盖的严重等级集合至少包含数组中任一等级（OR 语义）', + 'type' => 'array', + 'items' => ['type' => 'string'], ], - 'message' => [ - 'title' => '初始化message（失败场景）', - 'description' => '初始化message（失败场景）', + ], + ], + 'StatusFilter' => [ + 'title' => '告警状态过滤', + 'type' => 'object', + 'properties' => [ + 'eq' => [ 'type' => 'string', - 'example' => '""', + 'enum' => ['Alarm', 'Ok'], + ], + ], + ], + 'SubscriptionAndNotifyStrategyForListView' => [ + 'title' => '订阅与通知策略详情视图', + 'description' => '聚合实体的输出视图：自身关联字段（notifyStrategyUuid / subscriptionUuid / migrationBatchId / version 等）'."\n" + .'+ 运行时填充的子实体快照（notifyStrategy / subscription / subscriptions / responsePlan）。'."\n", + 'type' => 'object', + 'properties' => [ + 'uuid' => ['title' => '聚合实体 uuid', 'type' => 'string'], + 'name' => ['title' => '名称', 'type' => 'string'], + 'description' => ['title' => '描述', 'type' => 'string'], + 'enabled' => ['title' => '是否启用', 'type' => 'boolean'], + 'notifyStrategyUuid' => ['title' => '关联的 notifyStrategy uuid（与 responsePlan uuid 共享）', 'type' => 'string'], + 'subscriptionUuid' => ['title' => '直接绑定的主订阅 uuid（NOTIFY 形态下的 1:1 关联）', 'type' => 'string'], + 'migrationBatchId' => ['title' => '迁移批次 ID（用户自建为空；迁移产物有值）', 'type' => 'string'], + 'migrationMeta' => ['title' => '迁移元数据 JSON 字符串', 'type' => 'string'], + 'version' => ['title' => '乐观锁版本号', 'type' => 'integer', 'format' => 'int32'], + 'workspace' => ['title' => '工作空间标识', 'type' => 'string'], + 'userId' => ['title' => '所有者 userId', 'type' => 'string'], + 'createTime' => ['title' => '创建时间', 'type' => 'string'], + 'updateTime' => ['title' => '更新时间', 'type' => 'string'], + 'notifyStrategy' => ['$ref' => '#/components/schemas/NotifyStrategyForSNSView'], + ], + ], + 'SubscriptionAndNotifyStrategyForModify' => [ + 'title' => '订阅与通知策略修改入参', + 'description' => '聚合实体的写入载荷，用于 Create/Update。'."\n" + .'- Create：notifyStrategy 必填，subscription（单条主订阅）二选一与 subscriptions 互斥'."\n" + .'- Update：uuid + version 必填；只传哪个子字段就只更新哪个子实体；批量调整成员订阅时使用 subscriptions（SubscriptionOp 数组）'."\n", + 'type' => 'object', + 'properties' => [ + 'uuid' => ['title' => '聚合实体 uuid', 'description' => 'Update 必填，Create 可省略由后端生成', 'type' => 'string'], + 'version' => ['title' => '乐观锁版本号', 'description' => 'Update 必填，与后端记录一致才能写入；不一致返回 OPTIMISTIC_LOCK_FAILED', 'type' => 'integer', 'format' => 'int32'], + 'name' => ['title' => '名称', 'description' => '可省略，后端会从 notifyStrategy 派生', 'type' => 'string'], + 'description' => ['title' => '描述', 'type' => 'string'], + 'enabled' => ['title' => '是否启用（创建时默认启用）', 'type' => 'boolean'], + 'notifyStrategy' => ['$ref' => '#/components/schemas/NotifyStrategyForSNSModify'], + 'subscription' => ['$ref' => '#/components/schemas/SubscriptionForSNSModify'], + 'subscriptions' => [ + 'title' => '成员订阅批量操作', + 'description' => 'Update 专用，对成员订阅做 create/update/remove 批量调整', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/SubscriptionOp'], + ], + 'responsePlan' => ['$ref' => '#/components/schemas/IncidentResponsePlanForSNSModify'], + ], + ], + 'SubscriptionAndNotifyStrategyForView' => [ + 'title' => '订阅与通知策略详情视图', + 'description' => '聚合实体的输出视图：自身关联字段（notifyStrategyUuid / subscriptionUuid / migrationBatchId / version 等）'."\n" + .'+ 运行时填充的子实体快照（notifyStrategy / subscription / subscriptions / responsePlan）。'."\n", + 'type' => 'object', + 'properties' => [ + 'uuid' => ['title' => '聚合实体 uuid', 'type' => 'string'], + 'name' => ['title' => '名称', 'type' => 'string'], + 'description' => ['title' => '描述', 'type' => 'string'], + 'enabled' => ['title' => '是否启用', 'type' => 'boolean'], + 'notifyStrategyUuid' => ['title' => '关联的 notifyStrategy uuid（与 responsePlan uuid 共享）', 'type' => 'string'], + 'subscriptionUuid' => ['title' => '直接绑定的主订阅 uuid（NOTIFY 形态下的 1:1 关联）', 'type' => 'string'], + 'migrationBatchId' => ['title' => '迁移批次 ID（用户自建为空；迁移产物有值）', 'type' => 'string'], + 'migrationMeta' => ['title' => '迁移元数据 JSON 字符串', 'type' => 'string'], + 'version' => ['title' => '乐观锁版本号', 'type' => 'integer', 'format' => 'int32'], + 'workspace' => ['title' => '工作空间标识', 'type' => 'string'], + 'userId' => ['title' => '所有者 userId', 'type' => 'string'], + 'createTime' => ['title' => '创建时间', 'type' => 'string'], + 'updateTime' => ['title' => '更新时间', 'type' => 'string'], + 'subscription' => ['$ref' => '#/components/schemas/SubscriptionForSNSView'], + 'responsePlan' => ['$ref' => '#/components/schemas/IncidentResponsePlanForSNSView'], + 'notifyStrategy' => ['$ref' => '#/components/schemas/NotifyStrategyForSNSView'], + 'subscriptions' => [ + 'title' => '全部成员订阅（含主订阅，反查得出）', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/SubscriptionForView'], ], ], ], @@ -5518,71 +4427,76 @@ 'description' => '用于查看的实体。', 'type' => 'object', 'properties' => [ - 'description' => [ - 'title' => '描述', - 'description' => '描述', - 'type' => 'string', - 'example' => 'workspace test', - ], - 'subscriptionName' => [ - 'title' => '名称', - 'description' => '名称', - 'type' => 'string', - 'required' => true, - 'example' => '测试订阅', - ], - 'notifyStrategyId' => [ - 'title' => '通知策略UUID', - 'description' => '通知策略UUID', - 'type' => 'string', - 'example' => '123123', - ], - 'filterSetting' => [ - 'description' => '筛选设置', - '$ref' => '#/components/schemas/FilterSetting', - ], + 'description' => ['title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'workspace test'], + 'subscriptionName' => ['title' => '名称', 'description' => '名称', 'type' => 'string', 'required' => true, 'example' => '测试订阅'], + 'notifyStrategyId' => ['title' => '通知策略UUID', 'description' => '通知策略UUID', 'type' => 'string', 'example' => '123123'], + 'filterSetting' => ['description' => '筛选设置', '$ref' => '#/components/schemas/FilterSetting'], 'pushingSetting' => [ 'title' => '推送设置', 'description' => '推送设置', 'type' => 'object', 'properties' => [ - 'templateUuid' => [ - 'title' => '模板UUID', - 'description' => '模板UUID', - 'type' => 'string', - 'example' => '123123123', - ], + 'templateUuid' => ['title' => '模板UUID', 'description' => '模板UUID', 'type' => 'string', 'example' => '123123123'], 'alertActionIds' => [ 'title' => '报警推送行动计划ID列表', 'description' => '报警推送行动计划ID列表', 'type' => 'array', - 'items' => [ - 'description' => '行动集成ID', - 'type' => 'string', - 'example' => '123123123', - ], + 'items' => ['description' => '行动集成ID', 'type' => 'string', 'example' => '123123123'], ], 'restoreActionIds' => [ 'title' => '恢复推送行动计划ID列表', 'description' => '行动集成计划ID列表', 'type' => 'array', - 'items' => [ - 'description' => '行动集成计划ID', - 'type' => 'string', - 'example' => '123123123', - ], - ], - 'responsePlanId' => [ - 'title' => '行动计划ID', - 'description' => '行动计划ID', - 'type' => 'string', - 'example' => '123123123', + 'items' => ['description' => '行动集成计划ID', 'type' => 'string', 'example' => '123123123'], ], + 'responsePlanId' => ['title' => '行动计划ID', 'description' => '行动计划ID', 'type' => 'string', 'example' => '123123123'], ], ], - 'workspaceFilterSetting' => [ - '$ref' => '#/components/schemas/WorkspaceFilterSetting', + 'workspaceFilterSetting' => ['$ref' => '#/components/schemas/WorkspaceFilterSetting'], + 'agentConfig' => [ + 'type' => 'object', + 'properties' => [ + 'agentUuid' => ['type' => 'string'], + 'routes' => [ + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/NotifyRouteForSubscription'], + ], + ], ], + 'subscribeLegacyEvent' => ['title' => '是否订阅老产品事件', 'description' => '是否订阅老产品事件（workspace=null 的 cms 1.0 / ARMS / SLS 事件）：true=订阅，false 或 null=不订阅', 'type' => 'boolean'], + ], + ], + 'SubscriptionForSNSModify' => [ + 'title' => 'SNS 内嵌的订阅入参', + 'description' => '用于 SubscriptionAndNotifyStrategy 聚合接口的 subscription 子实体入参。'."\n" + .'后端 readonly 字段不暴露：'."\n" + .'- uuid（自动生成）/ name（默认与 SNS 主名同名 D9）'."\n" + .'- regionId / mode（BundleStrategy）/ subscriptionType（强制 NORMAL；D10 拒绝 AI_AGENT）'."\n" + .'- agentConfig（强制 null）/ notifyStrategyUuid（自动绑定）/ syncFromType（强制 OBS）/ enabled'."\n", + 'type' => 'object', + 'properties' => [ + 'filterSetting' => ['title' => 'filter 配置', '$ref' => '#/components/schemas/FilterSetting'], + 'workspaceFilterSetting' => ['title' => 'workspace filter 配置', '$ref' => '#/components/schemas/WorkspaceFilterSetting'], + ], + ], + 'SubscriptionForSNSView' => [ + 'title' => 'SNS 内嵌的订阅查看视图', + 'type' => 'object', + 'properties' => [ + 'uuid' => ['type' => 'string'], + 'name' => ['type' => 'string'], + 'enable' => ['type' => 'boolean'], + 'userId' => ['type' => 'string'], + 'workspace' => ['type' => 'string'], + 'regionId' => ['type' => 'string'], + 'notifyStrategyUuid' => ['title' => '反向关联到 SNS（= snsUuid）', 'type' => 'string'], + 'syncFromType' => ['type' => 'string'], + 'mode' => ['type' => 'string'], + 'subscriptionType' => ['type' => 'string'], + 'filterSetting' => ['$ref' => '#/components/schemas/FilterSetting'], + 'workspaceFilterSetting' => ['$ref' => '#/components/schemas/WorkspaceFilterSetting'], + 'createTime' => ['type' => 'string'], + 'updateTime' => ['type' => 'string'], ], ], 'SubscriptionForView' => [ @@ -5590,314 +4504,229 @@ 'description' => '用于查看的实体。', 'type' => 'object', 'properties' => [ - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58Z', - ], - 'description' => [ - 'title' => '描述', - 'description' => '描述', - 'type' => 'string', - 'example' => 'workspace test', - ], - 'enable' => [ - 'title' => '是否启用', - 'description' => '是否启用', - 'type' => 'boolean', - 'example' => 'false', - ], - 'subscriptionName' => [ - 'title' => '名称', - 'description' => '名称', - 'type' => 'string', - 'required' => true, - 'example' => '订阅测试', - ], - 'notifyStrategyId' => [ - 'title' => '通知策略UUID', - 'description' => '通知策略UUID', - 'type' => 'string', - 'example' => '23123123', - ], - 'updateTime' => [ - 'title' => '更新时间', - 'description' => '更新时间', - 'type' => 'string', - 'example' => '2025-05-23T02:29:02Z', - ], - 'userId' => [ - 'title' => '用户id', - 'description' => '用户id', - 'type' => 'string', - 'example' => '123123123', - ], - 'subscriptionId' => [ - 'title' => 'UUID', - 'description' => 'UUID', - 'type' => 'string', - 'example' => '123123123123', - ], - 'workspace' => [ - 'title' => 'workspace', - 'description' => 'workspace', - 'type' => 'string', - 'example' => 'workspace-test', - ], - 'filterSetting' => [ - 'description' => '筛选设置', - '$ref' => '#/components/schemas/FilterSetting', - ], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-03-11T08:21:58Z'], + 'description' => ['title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'workspace test'], + 'enable' => ['title' => '是否启用', 'description' => '是否启用', 'type' => 'boolean', 'example' => 'false'], + 'subscriptionName' => ['title' => '名称', 'description' => '名称', 'type' => 'string', 'required' => true, 'example' => '订阅测试'], + 'notifyStrategyId' => ['title' => '通知策略UUID', 'description' => '通知策略UUID', 'type' => 'string', 'example' => '23123123'], + 'updateTime' => ['title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2025-05-23T02:29:02Z'], + 'userId' => ['title' => '用户id', 'description' => '用户id', 'type' => 'string', 'example' => '123123123'], + 'subscriptionId' => ['title' => 'UUID', 'description' => 'UUID', 'type' => 'string', 'example' => '123123123123'], + 'workspace' => ['title' => 'workspace', 'description' => 'workspace', 'type' => 'string', 'example' => 'workspace-test'], + 'filterSetting' => ['description' => '筛选设置', '$ref' => '#/components/schemas/FilterSetting'], 'pushingSetting' => [ 'title' => '推送设置', 'description' => '推送设置', 'type' => 'object', 'properties' => [ - 'templateUuid' => [ - 'title' => '模板UUID', - 'description' => '模板UUID', - 'type' => 'string', - 'example' => '123123123', - ], + 'templateUuid' => ['title' => '模板UUID', 'description' => '模板UUID', 'type' => 'string', 'example' => '123123123'], 'alertActionIds' => [ 'title' => '报警推送行动计划ID列表', 'description' => '报警推送行动集成ID列表', 'type' => 'array', - 'items' => [ - 'description' => '行动集成Id', - 'type' => 'string', - 'example' => '123123123', - ], + 'items' => ['description' => '行动集成Id', 'type' => 'string', 'example' => '123123123'], ], 'restoreActionIds' => [ 'title' => '恢复推送行动计划ID列表', 'description' => '恢复推送行动集成ID列表', 'type' => 'array', - 'items' => [ - 'description' => '行动集成Id', - 'type' => 'string', - 'example' => '123123123', - ], - ], - 'responsePlanId' => [ - 'title' => '行动计划ID', - 'description' => '行动计划ID', - 'type' => 'string', - 'example' => '123123123', + 'items' => ['description' => '行动集成Id', 'type' => 'string', 'example' => '123123123'], ], + 'responsePlanId' => ['title' => '行动计划ID', 'description' => '行动计划ID', 'type' => 'string', 'example' => '123123123'], ], ], - 'syncFromType' => [ - 'description' => '同步策略来源类型', + 'syncFromType' => ['description' => '同步策略来源类型', 'type' => 'string', 'example' => '"ARMS"'], + 'workspaceFilterSetting' => ['$ref' => '#/components/schemas/WorkspaceFilterSetting'], + 'subscriptionType' => [ 'type' => 'string', - 'example' => '"ARMS"', + 'example' => 'NORMAL', + 'default' => 'NORMAL', + 'enum' => ['NORMAL', 'AI_AGENT'], + ], + 'agentConfig' => [ + 'type' => 'object', + 'properties' => [ + 'agentUuid' => ['type' => 'string'], + 'routes' => [ + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/NotifyRouteForSubscription'], + ], + ], ], - 'workspaceFilterSetting' => [ - '$ref' => '#/components/schemas/WorkspaceFilterSetting', + 'subscribeLegacyEvent' => ['title' => '是否订阅老产品事件', 'description' => '是否订阅老产品事件（workspace=null 的 cms 1.0 / ARMS / SLS 事件）：true=订阅，false 或 null=不订阅', 'type' => 'boolean'], + ], + ], + 'SubscriptionOp' => [ + 'title' => '订阅批量操作单元', + 'description' => 'Update 接口中用于批量增删改成员订阅的操作描述。'."\n" + .'- op=create：必填 payload，uuid 由后端生成'."\n" + .'- op=update：必填 uuid + payload'."\n" + .'- op=remove：必填 uuid，payload 忽略'."\n", + 'type' => 'object', + 'properties' => [ + 'op' => [ + 'title' => '操作类型', + 'type' => 'string', + 'enum' => ['create', 'update', 'remove'], ], + 'uuid' => ['title' => '目标订阅 uuid', 'description' => 'update/remove 必填', 'type' => 'string'], + 'payload' => ['title' => '订阅完整载荷', 'description' => 'create/update 必填', '$ref' => '#/components/schemas/SubscriptionForModify'], ], ], 'Tag' => [ - 'title' => '标签', 'description' => '标签', 'type' => 'object', 'properties' => [ - 'key' => [ - 'title' => '标签键', - 'description' => '标签键', + 'key' => ['description' => '标签键', 'type' => 'string', 'example' => 'env', 'maxLength' => 128, 'title' => '标签键'], + 'value' => ['description' => '标签值', 'type' => 'string', 'example' => 'test', 'maxLength' => 256, 'title' => '标签值'], + ], + 'title' => '标签', + ], + 'TagCondition' => [ + 'title' => '标签过滤条件', + 'description' => '基于 tag key/value 的过滤单元', + 'type' => 'object', + 'properties' => [ + 'key' => ['title' => '标签键', 'type' => 'string'], + 'op' => [ + 'title' => '操作符', 'type' => 'string', - 'example' => 'env', - 'maxLength' => 128, + 'enum' => ['EQ', 'EQI', 'START_WITH', 'END_WITH', 'CONTAIN', 'NOT_CONTAIN', 'IN', 'NOT_IN', 'EXIST'], ], - 'value' => [ - 'title' => '标签值', - 'description' => '标签值', + 'value' => ['title' => '标签值', 'type' => 'string'], + ], + ], + 'TagSelector' => [ + 'title' => '标签选择器', + 'description' => '基于 tag 的选择器：conditions + relation + 自定义表达式三选一组合', + 'type' => 'object', + 'properties' => [ + 'conditions' => [ + 'title' => '标签过滤条件列表', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/TagCondition'], + ], + 'relation' => [ + 'title' => '条件关系', 'type' => 'string', - 'example' => 'test', - 'maxLength' => 256, + 'default' => 'AND', + 'enum' => ['AND', 'OR'], ], + 'expression' => ['title' => '自定义表达式（高级模式，覆盖 conditions+relation）', 'type' => 'string'], ], ], 'TransformAction' => [ 'description' => '转换配置', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'mapping' => [ 'description' => 'Mapping配置。', + 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => '严重级别Mapping配置。', - 'type' => 'string', - 'example' => '{"warning":"WARNING"}', - ], - ], - 'variable' => [ - 'description' => '变量名', - 'type' => 'string', - 'example' => 'var1', - ], - 'filterSetting' => [ - 'description' => '筛选配置', - '$ref' => '#/components/schemas/FilterSetting', - ], - 'source' => [ - 'description' => '引用路径', - 'type' => 'string', - 'example' => 'data.subject', - ], - 'labelKey' => [ - 'description' => '标签名', - 'type' => 'string', - 'example' => 'labelkey1', - ], - 'type' => [ - 'description' => '转换类型', - 'type' => 'string', - 'example' => 'SET_FIELD', - ], - 'value' => [ - 'description' => '设置的值', - 'type' => 'string', - 'example' => 'value1', - ], - 'regExp' => [ - 'description' => '正则表达式', - 'type' => 'string', - 'example' => '(.*):(.*)', - ], - 'target' => [ - 'description' => '目标位置', - 'type' => 'string', - 'example' => 'SUBJECT', + 'additionalProperties' => ['description' => '严重级别Mapping配置。', 'visibility' => 'Public', 'type' => 'string', 'example' => '{"warning":"WARNING"}'], + 'backendName' => 'mapping', ], + 'variable' => ['description' => '变量名', 'visibility' => 'Public', 'type' => 'string', 'example' => 'var1', 'backendName' => 'variable'], + 'filterSetting' => ['description' => '筛选配置', 'visibility' => 'Public', 'backendName' => 'filterSetting', '$ref' => '#/components/schemas/FilterSetting'], + 'source' => ['description' => '引用路径', 'visibility' => 'Public', 'type' => 'string', 'example' => 'data.subject', 'backendName' => 'source'], + 'labelKey' => ['description' => '标签名', 'visibility' => 'Public', 'type' => 'string', 'example' => 'labelkey1', 'backendName' => 'labelKey'], + 'type' => ['description' => '转换类型', 'visibility' => 'Public', 'type' => 'string', 'example' => 'SET_FIELD', 'backendName' => 'type'], + 'value' => ['description' => '设置的值', 'visibility' => 'Public', 'type' => 'string', 'example' => 'value1', 'backendName' => 'value'], + 'regExp' => ['description' => '正则表达式', 'visibility' => 'Public', 'type' => 'string', 'example' => '(.*):(.*)', 'backendName' => 'regExp'], + 'target' => ['description' => '目标位置', 'visibility' => 'Public', 'type' => 'string', 'example' => 'SUBJECT', 'backendName' => 'target'], ], ], 'TransformerForModify' => [ 'title' => 'A short description of struct', 'description' => '数据转换器。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'sortId' => [ - 'title' => '排序数', - 'description' => '排序数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'quitAfterMatch' => [ - 'title' => '匹配处理后退出', - 'description' => '匹配处理后退出', - 'type' => 'boolean', - 'example' => 'true', - ], - 'description' => [ - 'title' => '描述', - 'description' => '描述', - 'type' => 'string', - 'example' => 'workspace test', - ], - 'filterSetting' => [ - 'description' => '筛选条件', - '$ref' => '#/components/schemas/FilterSetting', - ], - 'transformerName' => [ - 'title' => '名称', - 'description' => '名称', - 'type' => 'string', - 'required' => true, - 'example' => 'name', - ], + 'sortId' => ['title' => '排序数', 'description' => '排序数', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'backendName' => 'sortId'], + 'quitAfterMatch' => ['title' => '匹配处理后退出', 'description' => '匹配处理后退出', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'quitAfterMatch'], + 'description' => ['title' => '描述', 'description' => '描述', 'visibility' => 'Public', 'type' => 'string', 'example' => 'workspace test', 'backendName' => 'description'], + 'filterSetting' => ['description' => '筛选条件', 'visibility' => 'Public', 'backendName' => 'filterSetting', '$ref' => '#/components/schemas/FilterSetting'], + 'transformerName' => ['title' => '名称', 'description' => '名称', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'name', 'backendName' => 'transformerName'], 'actions' => [ 'title' => '转换操作', 'description' => '转换操作', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '处理行动', - '$ref' => '#/components/schemas/TransformAction', - ], + 'items' => ['description' => '处理行动', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/TransformAction'], + 'backendName' => 'actions', ], ], ], 'TransformerForView' => [ 'title' => 'A short description of struct', 'description' => '数据转换器。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'workspace' => [ - 'title' => 'workspace', - 'description' => 'workspace', - 'type' => 'string', - 'example' => 'workspace-test', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58Z', - ], - 'enable' => [ - 'title' => '是否启用', - 'description' => '是否启用', - 'type' => 'boolean', - 'example' => 'false', - ], - 'sortId' => [ - 'title' => '排序数', - 'description' => '排序数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'transformerId' => [ - 'title' => 'transformer Id', - 'description' => 'transformer Id', - 'type' => 'string', - 'example' => '1123123123123', - ], - 'quitAfterMatch' => [ - 'title' => '匹配处理后退出', - 'description' => '匹配处理后退出', - 'type' => 'boolean', - 'example' => 'false', - ], - 'description' => [ - 'title' => '描述', - 'description' => '描述', - 'type' => 'string', - 'example' => 'workspace test', - ], - 'filterSetting' => [ - 'description' => '筛选设置', - '$ref' => '#/components/schemas/FilterSetting', - ], - 'updateTime' => [ - 'title' => '更新时间', - 'description' => '更新时间', - 'type' => 'string', - 'example' => '2025-01-16T02:27:01Z', - ], - 'transformerName' => [ - 'title' => '名称', - 'description' => '名称', - 'type' => 'string', - 'required' => true, - 'example' => '测试处理流', - ], + 'workspace' => ['title' => 'workspace', 'description' => 'workspace', 'visibility' => 'Public', 'type' => 'string', 'example' => 'workspace-test', 'backendName' => 'workspace'], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'visibility' => 'Public', 'type' => 'string', 'example' => '2025-03-11T08:21:58Z', 'backendName' => 'createTime'], + 'enable' => ['title' => '是否启用', 'description' => '是否启用', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'false', 'backendName' => 'enabled'], + 'sortId' => ['title' => '排序数', 'description' => '排序数', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'backendName' => 'sortId'], + 'transformerId' => ['title' => 'transformer Id', 'description' => 'transformer Id', 'visibility' => 'Public', 'type' => 'string', 'example' => '1123123123123', 'backendName' => 'transformerId'], + 'quitAfterMatch' => ['title' => '匹配处理后退出', 'description' => '匹配处理后退出', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'false', 'backendName' => 'quitAfterMatch'], + 'description' => ['title' => '描述', 'description' => '描述', 'visibility' => 'Public', 'type' => 'string', 'example' => 'workspace test', 'backendName' => 'description'], + 'filterSetting' => ['description' => '筛选设置', 'visibility' => 'Public', 'backendName' => 'filterSetting', '$ref' => '#/components/schemas/FilterSetting'], + 'updateTime' => ['title' => '更新时间', 'description' => '更新时间', 'visibility' => 'Public', 'type' => 'string', 'example' => '2025-01-16T02:27:01Z', 'backendName' => 'updateTime'], + 'transformerName' => ['title' => '名称', 'description' => '名称', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => '测试处理流', 'backendName' => 'transformerName'], 'actions' => [ 'title' => '转换操作', 'description' => '转换操作', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '处理行动', - '$ref' => '#/components/schemas/TransformAction', - ], + 'items' => ['description' => '处理行动', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/TransformAction'], + 'backendName' => 'actions', + ], + 'userId' => ['title' => '用户id', 'description' => '用户id', 'visibility' => 'Public', 'type' => 'string', 'example' => '123123123**', 'backendName' => 'userId'], + ], + ], + 'UmodelEntityField' => [ + 'title' => 'UModel 实体字段透出配置', + 'type' => 'object', + 'properties' => [ + 'field' => ['title' => '实体字段名', 'type' => 'string'], + 'value' => ['title' => '字段别名或展示值', 'type' => 'string'], + ], + ], + 'UmodelEntityFilter' => [ + 'title' => 'UModel 实体过滤条件', + 'type' => 'object', + 'properties' => [ + 'field' => ['title' => '过滤字段名', 'type' => 'string'], + 'operator' => [ + 'title' => '过滤操作符，仅支持 = 或 !=', + 'type' => 'string', + 'enum' => ['=', '!='], ], - 'userId' => [ - 'title' => '用户id', - 'description' => '用户id', + 'value' => ['title' => '过滤值', 'type' => 'string'], + ], + ], + 'UmodelLabelFilter' => [ + 'title' => 'UModel 标签过滤条件', + 'type' => 'object', + 'properties' => [ + 'name' => ['title' => '标签名', 'type' => 'string'], + 'value' => ['title' => '标签值', 'type' => 'string'], + 'operator' => [ + 'title' => '标签过滤操作符，仅支持 = 或 !=', 'type' => 'string', - 'example' => '123123123**', + 'enum' => ['=', '!='], + ], + ], + ], + 'UuidFilter' => [ + 'title' => 'UUID 过滤', + 'type' => 'object', + 'properties' => [ + 'eq' => ['type' => 'string'], + 'in' => [ + 'type' => 'array', + 'items' => ['type' => 'string'], ], ], ], @@ -5905,172 +4734,201 @@ 'description' => '工作空间过滤设置对象', 'type' => 'object', 'properties' => [ - 'tagSelector' => [ - 'description' => '标签筛选器', - '$ref' => '#/components/schemas/FilterSetting', - ], + 'tagSelector' => ['description' => '标签筛选器', '$ref' => '#/components/schemas/FilterSetting'], 'workspaceUuids' => [ 'description' => '工作空间 UUID 列表', 'type' => 'array', - 'items' => [ - 'description' => '工作空间 UUID', - 'type' => 'string', - 'example' => '"ws-abc123"', - ], + 'items' => ['description' => '工作空间 UUID', 'type' => 'string', 'example' => '"ws-abc123"'], ], ], ], ], ], 'apis' => [ - 'PutWorkspace' => [ - 'summary' => '创建工作空间。', - 'path' => '/workspace/{workspaceName}', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'AddContexts' => [ + 'path' => '/workspace/{workspace}/contextstore/{contextStoreName}/context', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'maxLength' => 64, 'minLength' => 2], + ], + [ + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => '上下文库名称', 'type' => 'string', 'required' => true, 'example' => 'test-context-store', 'maxLength' => 64, 'minLength' => 2], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => 'body参数', - 'description' => 'body参数', + 'description' => '请求 Body', 'type' => 'object', 'properties' => [ - 'displayName' => [ - 'title' => '', - 'description' => '工作空间展示名称', - 'type' => 'string', - 'required' => false, - 'example' => 'workspace-test', - 'maxLength' => 256, - ], - 'description' => [ - 'title' => '工作空间描述', - 'description' => '工作空间描述', - 'type' => 'string', - 'required' => false, - 'example' => 'workspace test', - 'maxLength' => 256, - 'pattern' => '', - 'default' => '', - ], - 'slsProject' => [ - 'title' => '日志服务项目名称', - 'description' => '日志服务项目名称', - 'type' => 'string', + 'contextType' => ['description' => '上下文类型', 'type' => 'string', 'required' => true, 'example' => 'memory'], + 'memoryType' => ['description' => '记忆类型', 'type' => 'string', 'required' => false, 'example' => 'short'], + 'items' => [ + 'description' => '上下文信息', + 'type' => 'array', + 'items' => [ + 'description' => '上下文信息', + 'type' => 'object', + 'properties' => [ + 'messages' => [ + 'description' => '消息', + 'type' => 'array', + 'items' => [ + 'description' => '消息', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'any', 'example' => '{"content":"xxxx","role":"xxxx"}', 'description' => '消息'], + ], + 'required' => false, + ], + 'content' => ['description' => '内容', 'type' => 'string', 'required' => false, 'example' => 'You are a conversation assistant.'], + 'userId' => ['description' => '用户Id', 'type' => 'string', 'required' => false, 'example' => 'test_user_001'], + 'agentId' => ['description' => '应用的 agentId', 'type' => 'string', 'required' => false, 'example' => '952730733889060865'], + 'appId' => ['description' => '应用Id', 'type' => 'string', 'required' => false, 'example' => 'mm_480d961a1b5e4efe84603f4cbc0f'], + 'runId' => ['description' => '运行 id', 'type' => 'string', 'required' => false, 'example' => 'jr-80ded1d6953c64ea'], + 'labels' => [ + 'description' => '标签', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'example' => '{"key":"xxxx","value":"xxxx"}', 'description' => '标签'], + ], + 'metadata' => ['description' => '元数据', 'type' => 'object', 'required' => false, 'example' => '{"sessionId":"test_session_001"}'], + 'infer' => ['description' => '推断', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'customInstructions' => ['description' => '自定义指令', 'type' => 'string', 'required' => false, 'example' => 'Your custom instructions here'], + 'timestamp' => ['description' => '时间戳', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1774578167'], + 'categories' => [ + 'description' => '分类', + 'type' => 'array', + 'items' => ['description' => '分类', 'type' => 'string', 'required' => false, 'example' => '[]'], + 'required' => false, + ], + 'immutable' => ['description' => '可变属性', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'expirationDate' => ['description' => '过期时间', 'type' => 'string', 'required' => false, 'example' => '1731231212334396'], + 'triggerCondition' => ['description' => '触发条件', 'type' => 'string', 'required' => false, 'example' => 'Identify and troubleshoot SLs issues'], + 'experience' => ['description' => '经验', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "taskType": "troubleshooting",'."\n" + .' "complexity": "medium",'."\n" + .' "confidence": 0.95'."\n" + .'}'], + ], + 'required' => false, + ], 'required' => true, - 'example' => 'sls-project-test-001', - 'maxLength' => 128, - 'minLength' => 1, - 'default' => '', ], ], 'required' => false, ], ], - [ - 'name' => 'workspaceName', - 'in' => 'path', - 'schema' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test-001', - 'maxLength' => 56, - 'minLength' => 1, - ], - ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '响应数据', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'workspaceName' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'example' => 'workspace-test-001', + 'requestId' => ['description' => '请求Id', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8'], + 'results' => [ + 'description' => '返回值', + 'type' => 'array', + 'items' => [ + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'contextId' => ['title' => '写入生成的记录ID或事件ID', 'description' => '写入生成的记录ID或事件ID', 'type' => 'string', 'example' => '897294a7-67a4-4f60-976c-e136edc5f97e'], + 'status' => ['title' => '写入状态，例如 accepted、queued、created', 'description' => '写入状态，例如 accepted、queued、created', 'type' => 'string', 'example' => 'accepted'], + ], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '写入上下文', + 'summary' => '写入上下文', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"workspaceName\\": \\"workspace-test-001\\"\\n}","type":"json"}]', - 'title' => '创建修改工作空间', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8\\",\\n \\"results\\": [\\n {\\n \\"contextId\\": \\"897294a7-67a4-4f60-976c-e136edc5f97e\\",\\n \\"status\\": \\"accepted\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'GetWorkspace' => [ - 'summary' => '获取工作空间。', - 'path' => '/workspace/{workspaceName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'AddMemories' => [ + 'path' => '/workspace/{workspace}/memorystore/{memoryStoreName}/memory', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ - 'name' => 'workspaceName', + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'maxLength' => 64, 'minLength' => 2], + ], + [ + 'name' => 'memoryStoreName', 'in' => 'path', + 'schema' => ['description' => '记忆库名称。', 'type' => 'string', 'required' => true, 'example' => 'test-memory-store', 'maxLength' => 64, 'minLength' => 2], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '实例 ID。', - 'description' => '实例 ID', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test-001', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'timestamp' => ['type' => 'integer', 'format' => 'int64', 'example' => '12312314214'], + 'asyncMode' => ['description' => '异步模式', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'messages' => [ + 'description' => '消息', + 'type' => 'array', + 'items' => [ + 'description' => '消息', + 'type' => 'object', + 'properties' => [ + 'content' => ['description' => '内容', 'type' => 'string', 'required' => false, 'example' => 'My name is Zhang San and I live in Hangzhou.'], + 'role' => ['description' => '角色', 'type' => 'string', 'required' => false, 'example' => 'user'], + ], + 'required' => false, + ], + 'required' => false, + ], + 'userId' => ['description' => '用户Id', 'type' => 'string', 'required' => false, 'example' => 'test_user_001'], + 'agentId' => ['description' => '应用的agentId', 'type' => 'string', 'required' => false, 'example' => '952730733889060865'], + 'appId' => ['description' => '应用Id', 'type' => 'string', 'required' => false, 'example' => 'mm_480d961a1b5e4efe84603f4cbc0f'], + 'runId' => ['description' => '运行id', 'type' => 'string', 'required' => false, 'example' => 'jr-80ded1d6953c64ea'], + 'infer' => ['description' => '推断', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'customInstructions' => ['description' => '自定义指令', 'type' => 'string', 'required' => false, 'example' => 'Your custom instructions here'], + 'metadata' => ['description' => '元数据', 'type' => 'object', 'required' => false, 'example' => '{"sessionId":"test_session_001"}'], + ], + 'required' => false, ], ], ], @@ -6078,511 +4936,521 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '响应数据', 'type' => 'object', 'properties' => [ - 'createTime' => [ - 'description' => '创建时间', - 'type' => 'string', - 'format' => 'iso8601_normal', - 'example' => '2025-03-11T08:21:58Z', - ], - 'description' => [ - 'title' => '工作空间描述', - 'description' => '工作空间描述', - 'type' => 'string', - 'example' => 'workspace test', - 'pattern' => '', - 'default' => '', - ], - 'lastModifyTime' => [ - 'description' => '更新时间', - 'type' => 'string', - 'format' => 'iso8601_normal', - 'example' => '2025-03-11T08:21:58Z', - ], - 'regionId' => [ - 'title' => '地域ID', - 'description' => '地域 ID', - 'type' => 'string', - 'example' => 'cn-heyuan', - 'pattern' => '', - 'default' => '', - ], - 'requestId' => [ - 'description' => '请求 ID', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'slsProject' => [ - 'title' => '日志服务项目名称', - 'description' => '日志服务项目名称', - 'type' => 'string', - 'example' => 'sls-project-test-001', - 'pattern' => '', - 'default' => '', - ], - 'workspaceName' => [ - 'title' => '工作空间名称', - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test-001', - 'pattern' => '', - 'default' => '', - ], - 'displayName' => [ - 'description' => '工作空间展示名称', - 'type' => 'string', - 'example' => 'workspace-test', + 'requestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'results' => [ + 'description' => '请求结果', + 'type' => 'array', + 'items' => [ + 'description' => '请求结果', + 'type' => 'object', + 'properties' => [ + 'message' => ['description' => '详细信息。', 'type' => 'string', 'example' => 'Memory processing has been queued for background execution'], + 'status' => ['description' => '处理状态', 'type' => 'string', 'example' => 'Pending'], + 'eventId' => ['description' => '事件ID', 'type' => 'string', 'example' => '897294a7-67a4-4f60-976c-e136edc5f97e'], + ], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"createTime\\": \\"2025-03-11T08:21:58Z\\",\\n \\"description\\": \\"workspace test\\",\\n \\"lastModifyTime\\": \\"2025-03-11T08:21:58Z\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"slsProject\\": \\"sls-project-test-001\\",\\n \\"workspaceName\\": \\"workspace-test-001\\",\\n \\"displayName\\": \\"workspace-test\\"\\n}","type":"json"}]', - 'title' => '获取工作空间', - ], - 'ListWorkspaces' => [ - 'summary' => '获取工作空间列表。', - 'path' => '/workspace', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '添加记忆', + 'summary' => '向用户的记忆存储中添加新的事实、消息或元数据。“添加记忆”端点接受原始文本或对话回合，并异步提交它们，以便记忆准备好用于后续的搜索、检索和图查询。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:AddMemories', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'MemoryStore', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/memorystore/{#memoryStore}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"results\\": [\\n {\\n \\"message\\": \\"Memory processing has been queued for background execution\\",\\n \\"status\\": \\"Pending\\",\\n \\"eventId\\": \\"897294a7-67a4-4f60-976c-e136edc5f97e\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ChangeResourceGroup' => [ + 'summary' => '修改资源所属资源组', + 'path' => '/resourcegroup', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcms5OJOSH', - ], - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'workspaceName', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '工作空间名称，模糊查找', - 'type' => 'string', + 'description' => '请求体', + 'type' => 'object', + 'properties' => [ + 'resourceType' => ['description' => '资源类型', 'type' => 'string', 'required' => false, 'example' => 'Service'], + 'resourceId' => ['description' => '资源ID', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'resourceGroupId' => ['description' => '资源组ID', 'type' => 'string', 'required' => false, 'example' => 'rg-ae******ey'], + ], 'required' => false, - 'example' => 'workspace-test-001', ], ], - [ - 'name' => 'nextToken', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '分页 Token', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxxxxxxx', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改资源组', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + ], + 'CreateAddonRelease' => [ + 'path' => '/integration-policies/{policyId}/addon-releases', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'maxResults', - 'in' => 'query', - 'schema' => [ - 'description' => '分页大小'."\n" - .'默认值:'."\n" - .' 50'."\n" - .'最大值:'."\n" - .' 50', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '200', - 'minimum' => '0', - 'example' => '10', - 'default' => '100', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'workspaceNameList', - 'in' => 'query', - 'style' => 'simple', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '工作空间名称，精确查找', - 'type' => 'array', - 'items' => [ - 'description' => '工作空间名称，精确查找', - 'type' => 'string', - 'required' => false, - 'example' => 'workspace-test-001', + 'title' => '请求体参数。', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'addonName' => ['title' => '需要接入监控的组件 Addon 名称。', 'description' => '需要接入监控的组件 Addon 名称。', 'type' => 'string', 'required' => true, 'example' => 'cs-gpu'], + 'aliyunLang' => [ + 'title' => '组件的语言类型。', + 'description' => '组件的语言类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['en' => '英语', 'zh' => '中文'], + 'example' => 'zh', + ], + 'dryRun' => [ + 'title' => '是否试运行，默认为 false。', + 'description' => '是否试运行，默认为 false。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => ['true' => '试运行', 'false' => '不试运行'], + 'example' => 'false', + ], + 'envType' => [ + 'title' => '环境类型。如果 Policy 类型为 CS 和 ECS，对应使用，其他类型统一为 Cloud。', + 'description' => '环境类型。如果 Policy 类型为 CS 和 ECS，对应使用，其他类型统一为 Cloud。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['CS' => '容器环境', 'ECS' => 'ECS环境', 'Cloud' => '云服务环境'], + 'example' => 'CS', + ], + 'parentAddonReleaseId' => ['title' => '父级 AddonReleaseId。', 'description' => '父级 AddonReleaseId。', 'type' => 'string', 'required' => false, 'example' => 'policy-xxxxxxxxxxx'], + 'releaseName' => ['title' => '接入后的插件名称，如果不指定则生成默认规则名称。', 'description' => '接入后的插件名称。如果不指定则生成默认规则名称。', 'type' => 'string', 'required' => false, 'example' => 'test-gpu-integration-name'], + 'values' => ['title' => '输入的元数据。', 'description' => '输入的元数据。', 'type' => 'string', 'required' => false, 'example' => '{"install":{"mode":"auto-install","listenPort":"9400"},"discoverMode":"instances","discover":{"instances":"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44"},"scrapeInterval":"15","enableSecuritecs-nodeyGroupInjection":"true","metricTags":""}'], + 'version' => ['title' => '需要接入监控的组件 Addon 版本。', 'description' => '需要接入监控的组件 Addon 版本。', 'type' => 'string', 'required' => true, 'example' => '0.0.2'], + 'workspace' => ['title' => '安装组件资源的工作空间名称。'."\n", 'description' => '安装组件资源的工作空间名称。'."\n", 'type' => 'string', 'required' => false, 'example' => 'default'], + 'entityRules' => ['title' => '实体发现规则。', 'description' => '字段规则', 'required' => false, '$ref' => '#/components/schemas/EntityDiscoverRule'], ], 'required' => false, - 'example' => 'workspace-test-001', ], ], [ - 'name' => 'region', - 'in' => 'query', - 'schema' => [ - 'description' => '地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-heyuan', - ], + 'name' => 'policyId', + 'in' => 'path', + 'schema' => ['title' => '环境策略 ID。', 'description' => '环境策略 ID。', 'type' => 'string', 'required' => true, 'example' => 'policy-yyyyyyyyyy'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '返回数据。', + 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'maxResults' => [ - 'description' => '分页大小'."\n" - .'默认值:'."\n" - .' 50'."\n" - .'最大值:'."\n" - .' 50', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'nextToken' => [ - 'description' => '分页 Token', - 'type' => 'string', - 'example' => 'xxxxxxxxxx', - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求 ID'."\n" - ."\n", - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'total' => [ - 'title' => '当总结果个数大于MaxResults时，用于翻页的token。', - 'description' => '总数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'workspaces' => [ - 'title' => '数组，返回示例目录。', - 'description' => '工作空间列表', - 'type' => 'array', - 'items' => [ - 'title' => 'WorkspaceItemType', - 'description' => 'WorkspaceItemType', - 'type' => 'object', - 'properties' => [ - 'createTime' => [ - 'description' => '创建时间', - 'type' => 'string', - 'format' => 'iso8601_normal', - 'example' => '2025-03-11T08:21:58Z', - ], - 'displayName' => [ - 'description' => '工作空间展示名称', - 'type' => 'string', - 'example' => 'workspace-test', - ], - 'description' => [ - 'title' => '工作空间描述', - 'description' => '工作空间描述', - 'type' => 'string', - 'example' => 'workspace test', - 'pattern' => '', - 'default' => '', - ], - 'lastModifyTime' => [ - 'description' => '更新时间', - 'type' => 'string', - 'format' => 'iso8601_normal', - 'example' => '2025-03-11T08:21:58Z', - ], - 'regionId' => [ - 'title' => '地域ID', - 'description' => '地域 ID', - 'type' => 'string', - 'example' => 'cn-heyuan', - 'pattern' => '', - 'default' => '', - ], - 'slsProject' => [ - 'title' => '日志服务项目名称', - 'description' => '日志服务项目名称', - 'type' => 'string', - 'example' => 'sls-project-test-001', - 'pattern' => '', - 'default' => '', - ], - 'workspaceName' => [ - 'title' => '工作空间名称', - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test-001', - 'pattern' => '', - 'default' => '', + 'release' => [ + 'title' => '接入组件信息。', + 'description' => '接入组件信息。', + 'type' => 'object', + 'properties' => [ + 'addonName' => ['title' => '接入监控的组件 Addon 名称。', 'description' => '接入监控的组件 Addon 名称。', 'type' => 'string', 'example' => 'cs-gpu'], + 'alertRuleCount' => ['title' => '告警组数量。', 'description' => '告警组数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '6'], + 'conditions' => [ + 'title' => '组件安装阶段信息。', + 'description' => '组件安装阶段信息。', + 'type' => 'array', + 'items' => [ + 'description' => '操作符，支持精确匹配、前缀匹配、正则表达式三种方式。', + 'type' => 'object', + 'properties' => [ + 'firstTransitionTime' => ['title' => '第一次转换时间。', 'description' => '第一次转换时间。', 'type' => 'string', 'example' => '2024-11-04T16:10:22+08:00'], + 'lastTransitionTime' => ['title' => '最后一次转换时间。', 'description' => '最后一次转换时间。', 'type' => 'string', 'example' => '2024-11-04T16:10:22+08:00'], + 'message' => ['title' => '详细信息。', 'description' => '详细信息。', 'type' => 'string', 'example' => 'The addon loaded successfully'], + 'status' => ['title' => '阶段状态。', 'description' => '阶段状态。', 'type' => 'string', 'example' => '{\'phase\': \'Created\', \'executionDetails\': [], \'invocations\': [], \'latestExecError\': {\'message\': \'\', \'code\': \'\', \'requestId\': \'\', \'extraInfo\': \'\', \'title\': \'\'}}'], + 'type' => ['title' => '阶段类型。', 'description' => '阶段类型。', 'type' => 'string', 'example' => 'Loaded'], + ], ], ], + 'config' => ['title' => '组件配置。', 'description' => '组件配置。', 'type' => 'string', 'example' => '{"install":{"mode":"auto-install","listenPort":"9400"},"discoverMode":"instances","discover":{"instances":"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44"},"scrapeInterval":"15","enableSecuritecs-nodeyGroupInjection":"true","metricTags":""}'], + 'createTime' => ['title' => '接入时间。', 'description' => '接入时间。', 'type' => 'string', 'example' => '2024-11-05T15:21:30+08:00'], + 'dashboardCount' => ['title' => '大盘数量。', 'description' => '大盘数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'environmentId' => ['title' => '环境 ID。', 'description' => '环境 ID。', 'type' => 'string', 'example' => 'policy-xxxxxxxxxxx'], + 'exporterCount' => ['title' => '插件数量。', 'description' => '插件数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'haveConfig' => ['title' => '是否有配置。', 'description' => '是否有配置。', 'type' => 'boolean', 'example' => 'true'], + 'installUserId' => ['title' => '安装的用户 ID。', 'description' => '安装的用户 ID。', 'type' => 'string', 'example' => '1654218965xxxxxx'], + 'language' => ['title' => '语言。', 'description' => '语言。', 'type' => 'string', 'example' => 'zh'], + 'managed' => ['title' => '是否为托管组件。', 'description' => '是否为托管组件。', 'type' => 'boolean', 'example' => 'true'], + 'parentAddonReleaseId' => ['title' => '父级 AddonReleaseId。', 'description' => '父级 AddonReleaseId。', 'type' => 'string', 'example' => 'policy-xxxxxxxxxxx'], + 'policyId' => ['title' => '策略环境 ID。', 'description' => '策略环境 ID。', 'type' => 'string', 'example' => 'policy-xxxxxxxxxx'], + 'regionId' => ['title' => '地域 ID。', 'description' => '地域 ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'releaseId' => ['title' => '安装后的 ReleaseID。', 'description' => '安装后的 ReleaseID。', 'type' => 'string', 'example' => '2e898e60-5e6a-46d1-a994-xxxxxxxxxx'], + 'releaseName' => ['title' => 'Release 的名称。', 'description' => 'Release 的名称。', 'type' => 'string', 'example' => 'test-gpu-integration-name'], + 'scene' => ['title' => '组件场景。', 'description' => '组件场景。', 'type' => 'string', 'example' => '1'], + 'status' => ['title' => '组件状态。', 'description' => '组件状态。', 'type' => 'string', 'example' => '200'], + 'updateTime' => ['title' => '更新时间。', 'description' => '更新时间。', 'type' => 'string', 'example' => '2024-09-13T02:21:02Z'], + 'userId' => ['title' => '所属用户 ID。', 'description' => '所属用户 ID。', 'type' => 'string', 'example' => '165421896xxxxxx'], + 'version' => ['title' => '组件版本。', 'description' => '组件版本。', 'type' => 'string', 'example' => '1.0.0'], + 'envType' => ['title' => '环境类型。', 'description' => '环境类型。', 'type' => 'string', 'example' => 'CS'], + 'workspace' => ['title' => '工作空间。', 'description' => '工作空间。', 'type' => 'string', 'example' => 'default'], + 'entityRules' => ['title' => '实体详情。', 'description' => '实体详情。', '$ref' => '#/components/schemas/EntityGroupBase'], ], ], + 'requestId' => ['title' => '请求 ID。', 'description' => '请求 ID。', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"maxResults\\": 10,\\n \\"nextToken\\": \\"xxxxxxxxxx\\",\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"total\\": 1,\\n \\"workspaces\\": [\\n {\\n \\"createTime\\": \\"2025-03-11T08:21:58Z\\",\\n \\"displayName\\": \\"workspace-test\\",\\n \\"description\\": \\"workspace test\\",\\n \\"lastModifyTime\\": \\"2025-03-11T08:21:58Z\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"slsProject\\": \\"sls-project-test-001\\",\\n \\"workspaceName\\": \\"workspace-test-001\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取工作空间列表', - ], - 'DeleteWorkspace' => [ - 'summary' => '删除工作空间。', - 'path' => '/workspace/{workspaceName}', - 'methods' => [ - 'delete', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '安装接入组件', + 'summary' => '安装接入组件，代表进行一次接入', + 'description' => '用于创建一个站点监控任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '210', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAddonRelease'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateAddonRelease', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'AddonRelease', 'arn' => 'acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#PolicyId}/addonrelease/*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"release\\": {\\n \\"addonName\\": \\"cs-gpu\\",\\n \\"alertRuleCount\\": 6,\\n \\"conditions\\": [\\n {\\n \\"firstTransitionTime\\": \\"2024-11-04T16:10:22+08:00\\",\\n \\"lastTransitionTime\\": \\"2024-11-04T16:10:22+08:00\\",\\n \\"message\\": \\"The addon loaded successfully\\",\\n \\"status\\": \\"{\'phase\': \'Created\', \'executionDetails\': [], \'invocations\': [], \'latestExecError\': {\'message\': \'\', \'code\': \'\', \'requestId\': \'\', \'extraInfo\': \'\', \'title\': \'\'}}\\",\\n \\"type\\": \\"Loaded\\"\\n }\\n ],\\n \\"config\\": \\"{\\\\\\"install\\\\\\":{\\\\\\"mode\\\\\\":\\\\\\"auto-install\\\\\\",\\\\\\"listenPort\\\\\\":\\\\\\"9400\\\\\\"},\\\\\\"discoverMode\\\\\\":\\\\\\"instances\\\\\\",\\\\\\"discover\\\\\\":{\\\\\\"instances\\\\\\":\\\\\\"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44\\\\\\"},\\\\\\"scrapeInterval\\\\\\":\\\\\\"15\\\\\\",\\\\\\"enableSecuritecs-nodeyGroupInjection\\\\\\":\\\\\\"true\\\\\\",\\\\\\"metricTags\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"createTime\\": \\"2024-11-05T15:21:30+08:00\\",\\n \\"dashboardCount\\": 3,\\n \\"environmentId\\": \\"policy-xxxxxxxxxxx\\",\\n \\"exporterCount\\": 2,\\n \\"haveConfig\\": true,\\n \\"installUserId\\": \\"1654218965xxxxxx\\",\\n \\"language\\": \\"zh\\",\\n \\"managed\\": true,\\n \\"parentAddonReleaseId\\": \\"policy-xxxxxxxxxxx\\",\\n \\"policyId\\": \\"policy-xxxxxxxxxx\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"releaseId\\": \\"2e898e60-5e6a-46d1-a994-xxxxxxxxxx\\",\\n \\"releaseName\\": \\"test-gpu-integration-name\\",\\n \\"scene\\": \\"1\\",\\n \\"status\\": \\"200\\",\\n \\"updateTime\\": \\"2024-09-13T02:21:02Z\\",\\n \\"userId\\": \\"165421896xxxxxx\\",\\n \\"version\\": \\"1.0.0\\",\\n \\"envType\\": \\"CS\\",\\n \\"workspace\\": \\"default\\",\\n \\"entityRules\\": {\\n \\"workspace\\": \\"default-cms-1654218***343050-cn-hangzhou\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"entityQueries\\": [\\n {\\n \\"entityType\\": \\"acs.ecs.instance\\",\\n \\"spl\\": \\".entity with(type=\'acs.ecs.instance\') | where region_id in (\'cn-beijing\')\\"\\n }\\n ],\\n \\"description\\": \\"ECS 实例\\",\\n \\"entityGroupId\\": \\"eg-1234567890\\",\\n \\"entityRules\\": {\\n \\"ipMatchRule\\": [\\n {\\n \\"ipFieldKey\\": \\"hostIp\\",\\n \\"ipCIDR\\": \\"192.168.0.1/10\\"\\n }\\n ],\\n \\"instanceIds\\": [\\n \\"i-bp1gj8wyq4fxk28k6iy2\\"\\n ],\\n \\"fieldRules\\": [\\n {\\n \\"op\\": \\"in\\",\\n \\"fieldKey\\": \\"instanceId\\",\\n \\"fieldValues\\": [\\n \\"i-bp1gj8wyq4fxk28k6iy2\\"\\n ]\\n }\\n ],\\n \\"annotations\\": [\\n {\\n \\"op\\": \\"in\\",\\n \\"tagKey\\": \\"instanceId\\",\\n \\"tagValues\\": [\\n \\"i-bp1gj8wyq4fxk28k6iy2\\\\n\\"\\n ]\\n }\\n ],\\n \\"resourceGroupId\\": \\"rg-acfm2m7atreujs1\\",\\n \\"entityTypes\\": [\\n \\"acs.ecs.instance\\"\\n ],\\n \\"regionIds\\": [\\n \\"cn-shanghai\\"\\n ],\\n \\"tags\\": [\\n {\\n \\"op\\": \\"in\\",\\n \\"tagKey\\": \\"project\\",\\n \\"tagValues\\": [\\n \\"demo\\"\\n ]\\n }\\n ],\\n \\"labels\\": [\\n {\\n \\"op\\": \\"in\\",\\n \\"tagKey\\": \\"project\\",\\n \\"tagValues\\": [\\n \\"demo\\"\\n ]\\n }\\n ]\\n },\\n \\"entityGroupName\\": \\"ECS 全部实体\\",\\n \\"userId\\": \\"1654218***343050\\"\\n }\\n },\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', + ], + 'CreateAggTaskGroup' => [ + 'summary' => '创建聚合任务组。', + 'path' => '/prometheus-instances/{instanceId}/agg-task-groups', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'workspaceName', + 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'title' => '实例 ID。', - 'description' => '工作空间名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test-001', - ], + 'schema' => ['title' => '聚合任务组的源 Prometheus 实例 id', 'description' => '聚合任务组的源 Prometheus 实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pq4apob9jm'], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '入参结构体', + 'description' => '入参结构体。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求 ID', + 'aggTaskGroupConfig' => ['title' => '聚合任务组配置。目前仅支持 “RecordingRuleYaml” 格式，要求符合开源 Prometheus 的 RecordingRule 的格式要求', 'description' => '聚合任务组配置。'."\n" + .'目前仅支持 “RecordingRuleYaml” 格式，要求符合开源 Prometheus 的 RecordingRule 的格式要求。', 'type' => 'string', 'required' => true, 'example' => 'groups:'."\n" + .'- name: "node.rules"'."\n" + .' interval: "60s"'."\n" + .' rules:'."\n" + .' - record: "node_namespace_pod:kube_pod_info:"'."\n" + .' expr: "max(label_replace(kube_pod_info{job=\\"kubernetes-pods-kube-state-metrics\\"\\'."\n" + .' }, \\"pod\\", \\"$1\\", \\"pod\\", \\"(.*)\\")) by (node, namespace, pod, cluster)"'."\n"], + 'aggTaskGroupConfigType' => ['title' => '聚合任务组配置类型，默认 “RecordingRuleYaml”（开源 Prometheus 的 RecordingRule 格式）', 'description' => '聚合任务组配置类型，默认 “RecordingRuleYaml”（开源 Prometheus 的 RecordingRule 格式）。', 'type' => 'string', 'required' => false, 'example' => 'RecordingRuleYaml', 'default' => 'RecordingRuleYaml'], + 'aggTaskGroupName' => ['title' => '聚合任务组名称', 'description' => '聚合任务组名称。', 'type' => 'string', 'required' => true, 'example' => 'test-group'], + 'cronExpr' => ['title' => '调度模式选择“Cron”情况下，具体的调度表达式。例如“0/1 * * * *”，表示从 0 分开始，每隔 1 分钟调度一次', 'description' => '调度模式选择“Cron”情况下，具体的调度表达式。例如“0/1 * * * *”，表示从 0 分开始，每隔 1 分钟调度一次。', 'type' => 'string', 'required' => false, 'example' => '0/1 * * * *'], + 'delay' => ['title' => '调度的固定延迟时间，单位：秒，默认 30 ', 'description' => '调度的固定延迟时间。单位：秒，默认30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '120', 'minimum' => '0', 'example' => '30', 'default' => '30'], + 'description' => ['title' => '聚合任务组描述', 'description' => '聚合任务组描述。', 'type' => 'string', 'required' => false, 'example' => 'desc'], + 'fromTime' => ['title' => '调度开始时间对应的的秒级时间戳', 'description' => '调度开始时间对应的的秒级时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1724996015'], + 'maxRetries' => ['title' => '执行聚合任务的最大重试次数，默认 20', 'description' => '执行聚合任务的最大重试次数，默认 20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'default' => '20'], + 'maxRunTimeInSeconds' => ['title' => '执行聚合任务的最大重试时间，单位：秒，默认 600', 'description' => '执行聚合任务的最大重试时间，单位：秒，默认 600。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '600', 'default' => '600'], + 'precheckString' => ['title' => '预检测配置，默认不配置。输入的字符串需要能被正确 JSON 解析', 'description' => '预检测配置，默认不配置。输入的字符串需要能被正确 JSON 解析。', 'type' => 'string', 'required' => false, 'example' => '{"policy":"skip","prometheusId":"xxx","query":"scalar(sum(count_over_time(up{job=\\"_arms/kubelet/cadvisor\\"}[15s])) / 21)","threshold":0.5,"timeout":15,"type":"promql"}'], + 'scheduleMode' => [ + 'title' => '调度模式，“Cron” 或 “FixedRate”，默认 “FixedRate”', + 'description' => '调度模式，“Cron” 或 “FixedRate”，默认 “FixedRate”。', 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', + 'required' => false, + 'enumValueTitles' => ['FixedRate' => '固定周期', 'Cron' => 'Cron表达式'], + 'example' => 'FixedRate', + 'default' => 'FixedRate', + 'enum' => ['FixedRate', 'Cron'], ], + 'scheduleTimeExpr' => ['title' => '调度时间表达式，推荐 “@s” 或者 “@m”，表示调度时间窗口对齐的粒度，默认 “@m”', 'description' => '调度时间表达式，推荐 “@s” 或者 “@m”，表示调度时间窗口对齐的粒度，默认 “@m”。', 'type' => 'string', 'required' => false, 'example' => '@m', 'default' => '@m'], + 'status' => [ + 'title' => '聚合任务组状态，“Running” 或者 “Stopped”。默认 Running', + 'description' => '聚合任务组状态，“Running” 或者 “Stopped”。默认 Running。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['Stopped' => '已禁用', 'Running' => '已启动'], + 'example' => 'Running', + 'default' => 'Running', + 'enum' => ['Running', 'Stopped'], + ], + 'tags' => [ + 'title' => '资源组标签', + 'description' => '资源组标签。', + 'type' => 'array', + 'items' => [ + 'description' => '资源标签value值。', + 'type' => 'object', + 'properties' => [ + 'key' => ['title' => '资源组标签的键', 'description' => '资源组标签的键。', 'type' => 'string', 'required' => false, 'example' => 'key1'], + 'value' => ['title' => '资源组标签的值', 'description' => '资源组标签的值。', 'type' => 'string', 'required' => false, 'example' => 'value1'], + ], + 'required' => false, + ], + 'required' => false, + ], + 'targetPrometheusId' => ['title' => '聚合任务组的目标 Prometheus 实例 id', 'description' => '聚合任务组的目标 Prometheus 实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rw-pq4apob9jm'], + 'toTime' => ['title' => '调度结束时间对应的秒级时间戳，0 表示不停止调度', 'description' => '调度结束时间对应的秒级时间戳，0 表示不停止调度。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], ], + 'required' => false, ], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', - 'title' => '删除工作空间', - ], - 'CreateCloudResource' => [ - 'summary' => '创建云资源中心', - 'path' => '/cloudresource', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'overrideIfExists', + 'in' => 'query', + 'schema' => ['title' => '创建聚合任务组时，存在同名资源是否覆盖更新', 'description' => '创建聚合任务组时，存在同名资源是否覆盖更新。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '出参结构体', + 'description' => '出参结构体。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '请求 ID', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], + 'aggTaskGroupConfigHash' => ['title' => '聚合任务组配置的摘要', 'description' => '聚合任务组配置的摘要。', 'type' => 'string', 'example' => 'a54136014dc386a92c83a6ef1e97ff22'], + 'aggTaskGroupId' => ['title' => '聚合任务组 id', 'description' => '聚合任务组ID。', 'type' => 'string', 'example' => 'aggTaskGroup-f4b8e50525cf41c894488c0c71ec483f'], + 'aggTaskGroupName' => ['title' => '聚合任务组名称', 'description' => '聚合任务组名称。', 'type' => 'string', 'example' => 'pipeline-aggtask-group'], + 'requestId' => ['title' => '请求 id', 'description' => '请求ID。', 'type' => 'string', 'example' => '16C0A6D6-C3E7-511D-A60B-A87FD85F5BA7'], + 'sourcePrometheusId' => ['title' => '聚合任务组的源 Prometheus 实例 id', 'description' => '聚合任务组的源 Prometheus 实例ID。', 'type' => 'string', 'example' => 'rw-ecc04af14729b1a16e40a0d10068'], + 'status' => ['title' => '聚合任务组的当前状态', 'description' => '聚合任务组的当前状态。', 'type' => 'string', 'example' => 'Pending2Running'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', - 'title' => '创建云资源中心', - ], - 'GetCloudResource' => [ - 'summary' => '查询云资源中心', - 'path' => '/cloudresource', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"aggTaskGroupConfigHash\\": \\"a54136014dc386a92c83a6ef1e97ff22\\",\\n \\"aggTaskGroupId\\": \\"aggTaskGroup-f4b8e50525cf41c894488c0c71ec483f\\",\\n \\"aggTaskGroupName\\": \\"pipeline-aggtask-group\\",\\n \\"requestId\\": \\"16C0A6D6-C3E7-511D-A60B-A87FD85F5BA7\\",\\n \\"sourcePrometheusId\\": \\"rw-ecc04af14729b1a16e40a0d10068\\",\\n \\"status\\": \\"Pending2Running\\"\\n}","type":"json"}]', + 'title' => '创建聚合任务组', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAggTaskGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateAggTaskGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'AggTaskGroup', 'arn' => 'acs:cms:{#regionId}:{#accountId}:prometheusinstance/{#sourcePrometheusId}/aggtaskgroup/*'], + ], + ], + ], ], + ], + 'CreateAlertWebhook' => [ + 'summary' => '创建Webhook', + 'path' => '/webhook', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcms5OJOSH', - ], - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [], - 'responses' => [ - 200 => [ + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ + 'description' => '请求参数。', 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'description' => '区域 ID', + 'contentType' => [ + 'description' => '数据内容类型，支持：'."\n" + .'- JSON(默认)'."\n" + .'- FORM', 'type' => 'string', - 'example' => 'cn-heyuan', + 'required' => false, + 'example' => 'JSON', + 'default' => 'JSON', + 'enum' => ['JSON', 'FORM'], + ], + 'headers' => [ + 'description' => 'headers', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'example' => 'test', 'description' => 'header'], ], - 'requestId' => [ - 'description' => '请求 ID', + 'lang' => [ + 'description' => '语言。支持：'."\n" + .'- zh_CN'."\n" + .'- en_US', 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', + 'required' => false, + 'example' => 'zh_CN', + 'enum' => ['zh_CN', 'en_US'], ], + 'method' => [ + 'description' => '请求方法。'."\n" + .'- GET'."\n" + .'- POST', + 'type' => 'string', + 'required' => false, + 'example' => 'GET', + 'default' => 'POST', + 'enum' => ['GET', 'POST'], + ], + 'name' => ['description' => 'webhook名称。', 'type' => 'string', 'required' => true, 'example' => 'test'], + 'url' => ['description' => '报警回调的URL地址。', 'type' => 'string', 'required' => true, 'example' => 'https://aliyun.com/test'], + 'webhookId' => ['description' => 'webhook唯一标识。', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'workspace' => ['title' => 'workspace', 'type' => 'string', 'example' => 'my-workspace'], ], + 'required' => false, ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结果。', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'alertWebhookId' => ['description' => 'webhook唯一标识。', 'type' => 'string', 'example' => 'test'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', - 'title' => '获取云资源中心属性', - ], - 'GetCloudResourceData' => [ - 'summary' => '查询云资源中心数据', - 'path' => '/cloudresource/data', - 'methods' => [ - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resource already exist .', 'description' => '资源已经存在。'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.', 'description' => '参数%s缺失或不合法。'], + ], + 500 => [ + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => '服务运行错误。'], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建报警webhook', + 'description' => '创建一个webhook通知对象。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"alertWebhookId\\": \\"test\\"\\n}","type":"json"}]', + ], + 'CreateBizTrace' => [ + 'path' => '/bizTrace', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'from', - 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间点。'."\n" - ."\n" - .'Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1721767203', - ], - ], - [ - 'name' => 'to', - 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间点。'."\n" - ."\n" - .'Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1721767203', - ], - ], - [ - 'name' => 'query', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '查询语句', - 'type' => 'string', - 'required' => true, - 'example' => '.entity with(domain=\'acs\', type=\'acs.k8s.node\') | limit 0, 10', + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'workspace' => ['description' => '工作空间。', 'type' => 'string', 'required' => false, 'example' => 'default-cms-xxxxxxx-cn-hangzhou'], + 'bizTraceCode' => ['description' => '业务链路标识，仅使用字母、数字和下划线（_），且首字母需要小写', 'type' => 'string', 'required' => false, 'example' => 'label_env'], + 'bizTraceName' => ['description' => '业务链路名称', 'type' => 'string', 'required' => false, 'example' => 'just test'], + 'ruleConfig' => ['description' => '配置规则列表', 'type' => 'string', 'required' => false, 'example' => '[{"entrancePid":"xxx@d9w3jd9j3","rpcMatcher":{"matchType":"EQUALS","pattern":"/"},"characteristics":{"operation":"OR","rules":[{"target":"CUSTOM_EXTRACT","id":"oi0b3bb7","key":"biz.test","matcher":{"matchType":"CONTAINS","pattern":["1"]}}]}}]'."\n"], + 'advancedConfig' => ['description' => '高级配置', 'type' => 'string', 'required' => false, 'example' => '{"sample":{"strategy":"BY_APP"}}'], + ], + 'required' => false, ], ], ], @@ -6593,274 +5461,238 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'data' => [ - 'description' => '返回数据列表总和', - 'type' => 'array', - 'items' => [ - 'description' => '请求头对应的数据列表', - 'type' => 'array', - 'items' => [ - 'description' => '请求头对应的数据', - 'type' => 'string', - 'example' => 'data1', - ], - ], - ], - 'header' => [ - 'description' => '请求头列表', - 'type' => 'array', - 'items' => [ - 'description' => '请求头', - 'type' => 'string', - 'example' => 'headerKey', - ], - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求 ID', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], + 'requestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'bizTraceId' => ['description' => '业务链路id', 'type' => 'string', 'example' => 'e339260ed64c95d'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建业务链路', + 'summary' => '创建业务链路', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n [\\n \\"data1\\"\\n ]\\n ],\\n \\"header\\": [\\n \\"headerKey\\"\\n ],\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', - 'title' => '查询云资源中心数据', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"bizTraceId\\": \\"e339260ed64c95d\\"\\n}","type":"json"}]', ], - 'DeleteCloudResource' => [ - 'summary' => '删除云资源中心', + 'CreateCloudResource' => [ 'path' => '/cloudresource', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '请求 ID', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], + 'requestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建云资源中心', + 'summary' => '创建云资源中心', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', - 'title' => '删除云资源中心', ], - 'CreateEntityStore' => [ - 'summary' => '创建EntityStore相关存储', - 'path' => '/workspace/{workspaceName}/entitystore', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateContextStore' => [ + 'summary' => '创建上下文库', + 'path' => '/workspace/{workspace}/contextstore', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ - 'name' => 'workspaceName', + 'name' => 'workspace', 'in' => 'path', + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'maxLength' => 64, 'minLength' => 2], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '工作空间名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test-001', + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'contextStoreName' => ['description' => '上下文库名称', 'type' => 'string', 'required' => true, 'example' => 'test-context-store'], + 'contextType' => ['description' => '上下文类型', 'type' => 'string', 'required' => true, 'example' => 'memory'], + 'description' => ['description' => '描述', 'type' => 'string', 'required' => false, 'example' => 'desc'], + 'config' => [ + 'description' => '配置信息', + 'type' => 'object', + 'properties' => [ + 'source' => [ + 'description' => '配置源', + 'type' => 'object', + 'properties' => [ + 'project' => ['description' => '日志服务Project名称', 'type' => 'string', 'required' => false, 'example' => 'sls-test-project'], + 'logstore' => ['description' => '日志服务Logstore名称', 'type' => 'string', 'required' => false, 'example' => 'sls-test-logstore'], + 'startTime' => ['description' => '生效开始时间', 'type' => 'string', 'format' => 'iso8601_normal', 'required' => false, 'example' => '1751508233000'], + ], + 'required' => false, + ], + 'metadataField' => [ + 'description' => '元数据字段', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'description' => '元数据字段', 'example' => ' {'."\n" + .' "project": "attributes.project",'."\n" + .' "logstore": "attributes.logstore",'."\n" + .' "agentId": "attributes.agent_id",'."\n" + .' "scene": "attributes.scene"'."\n" + .' }'], + ], + ], + 'required' => false, + ], + 'dataset' => [ + 'description' => '数据集', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => '数据集名称', 'type' => 'string', 'required' => false, 'example' => 'test_dataset'], + ], + 'required' => false, + ], + ], + 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '响应数据', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '请求 ID', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'workspaceName' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'example' => 'workspace-test-001', - ], + 'requestId' => ['description' => '请求Id', 'type' => 'string', 'example' => 'E5B1D3D4-BB28-5996-8AD2-***********'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建上下文库', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"workspaceName\\": \\"workspace-test-001\\"\\n}","type":"json"}]', - 'title' => '创建EntityStore', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E5B1D3D4-BB28-5996-8AD2-***********\\"\\n}","type":"json"}]', ], - 'GetEntityStore' => [ - 'summary' => '获取EntityStore相关存储信息', - 'path' => '/workspace/{workspaceName}/entitystore', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CreateContextStoreAPIKey' => [ + 'summary' => '创建 API Key', + 'path' => '/workspace/{workspace}/contextstore/{contextStoreName}/apikey', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'workspaceName', + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => 'workspace-test'], + ], + [ + 'name' => 'contextStoreName', 'in' => 'path', + 'schema' => ['description' => '上下文库名称', 'type' => 'string', 'required' => true, 'example' => 'test-context-store'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '工作空间名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test-001', + 'description' => '请求 Body', + 'type' => 'object', + 'properties' => [ + 'name' => ['title' => 'API Key 的显示名称，用于标识用途', 'description' => 'API Key 的显示名称，用于标识用途', 'type' => 'string', 'required' => true, 'example' => 'Production Service Key'], + ], + 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '响应数据', + 'description' => '响应数据', 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'description' => '区域 ID', - 'type' => 'string', - 'example' => 'cn-heyuan', - ], - 'requestId' => [ - 'description' => '请求 ID', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'."\n", - ], - 'workspaceName' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'example' => 'workspace-test-001', - ], + 'requestId' => ['title' => '请求Id', 'description' => '请求Id', 'type' => 'string', 'example' => '3B311FD9-A60B-55E0-A896-A0C73*********'], + 'apiKey' => ['title' => '完整的 API Key 值', 'description' => '完整的 API Key 值', 'type' => 'string', 'example' => 'sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'], + 'name' => ['title' => 'API Key 的名称', 'description' => 'API Key 的名称', 'type' => 'string', 'example' => 'Production Service Key'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建 API Key', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\\\n\\",\\n \\"workspaceName\\": \\"workspace-test-001\\"\\n}","type":"json"}]', - 'title' => '获取EntityStore', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3B311FD9-A60B-55E0-A896-A0C73*********\\",\\n \\"apiKey\\": \\"sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\\",\\n \\"name\\": \\"Production Service Key\\"\\n}","type":"json"}]', ], - 'GetEntityStoreData' => [ - 'summary' => '查询指定Workspace下的实体和关系数据，返回结果显示某时间区间中的实体数据。', - 'path' => '/workspace/{workspace}/entitiesAndRelations', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateDataset' => [ + 'summary' => '创建数据集', + 'path' => '/workspace/{workspace}/dataset', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'acceptEncoding', - 'in' => 'header', - 'schema' => [ - 'description' => '压缩算法内容编码类型', - 'type' => 'string', - 'required' => false, - 'example' => 'gzip', - 'default' => 'gzip', - ], - ], - [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test-001', - ], + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'maxLength' => 64, 'minLength' => 2], ], [ 'name' => 'body', @@ -6870,29 +5702,13 @@ 'description' => '请求 Body', 'type' => 'object', 'properties' => [ - 'from' => [ - 'description' => '查询开始时间点。'."\n" - ."\n" - .'Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1721767203', - ], - 'query' => [ - 'description' => '查询语句。', - 'type' => 'string', - 'required' => true, - 'example' => '.entity with(domain=\'acs\', type=\'acs.k8s.node\') | limit 0, 10', - ], - 'to' => [ - 'description' => '查询结束时间点。'."\n" - ."\n" - .'Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', - 'type' => 'integer', - 'format' => 'int32', + 'datasetName' => ['description' => '数据集名称', 'type' => 'string', 'required' => true, 'example' => 'test_dataset', 'maxLength' => 64, 'minLength' => 2], + 'description' => ['description' => '描述', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'schema' => [ + 'description' => '表结构', + 'type' => 'object', 'required' => true, - 'example' => '1721767283', + 'additionalProperties' => ['$ref' => '#/components/schemas/IndexKey', 'description' => '表结构'], ], ], 'required' => false, @@ -6902,138 +5718,186 @@ 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应数据', 'type' => 'object', 'properties' => [ - 'data' => [ - 'description' => '返回数据列表总和', + 'requestId' => ['title' => 'Id of the request', 'description' => '请求Id', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建数据集', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', + ], + 'CreateDeliveryTask' => [ + 'summary' => '创建数据投递任务，将指定数据源的指标数据投递至目标存储或消息队列，支持 Prometheus Remote Write、Kafka、MaxCompute 三种投递类型。支持通过标签过滤指定投递的指标范围，以及为投递指标附加自定义标签。', + 'path' => '/delivery-tasks', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体', + 'type' => 'object', + 'properties' => [ + 'taskName' => ['description' => '任务名称，支持中文、英文、下划线、中划线', 'type' => 'string', 'required' => true, 'example' => 'my-task'], + 'dataSourceId' => ['description' => '数据源 ID（Prometheus 实例 ID）', 'type' => 'string', 'required' => true, 'example' => 'rw-xxxxxx'], + 'taskDescription' => ['description' => '任务描述', 'type' => 'string', 'required' => false, 'example' => 'my delivery task'], + 'labelFiltersType' => [ + 'description' => '指标过滤模式', + 'type' => 'string', + 'required' => false, + 'example' => 'Allow', + 'enum' => ['Allow', 'Deny'], + ], + 'labelFilters' => [ + 'description' => '指标过滤条件，配合 labelFiltersType 使用，key 为指标 label 名，value 为匹配值', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'example' => '__name__: up', 'description' => 'filterKey → filterValue，例如 __name__ → up，job → my_job'], + ], + 'externalLabels' => [ + 'description' => '为所有投递指标附加的额外 label，key 为 label 名，value 为 label 值', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'description' => 'externalLabelsKey → externalLabelsValue，例如 region → cn-hangzhou', 'example' => 'region: cn-hangzhou'], + ], + 'sinkList' => [ + 'description' => '投递目标列表', 'type' => 'array', 'items' => [ - 'description' => '请求头对应的数据列表', - 'type' => 'array', - 'items' => [ - 'description' => '请求头对应的数据', - 'type' => 'string', - 'example' => 'data1', + 'description' => '投递目标配置', + 'type' => 'object', + 'properties' => [ + 'sinkType' => [ + 'description' => '投递目标类型', + 'type' => 'string', + 'required' => true, + 'example' => 'Prometheus', + 'enum' => ['Prometheus', 'AcsMaxCompute', 'AcsKafka'], + ], + 'sinkConfigs' => [ + 'description' => '投递目标详细配置，key/value 含义因 sinkType 不同而不同（见下方说明）', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'example' => 'Url: http://xxxx/api/v1/write', 'description' => '各 sinkType 支持的配置项（见下方说明）'], + ], ], + 'required' => true, ], + 'required' => true, ], - 'header' => [ - 'description' => '请求头列表', + 'resourceGroupId' => ['description' => '资源组id', 'type' => 'string', 'required' => false, 'example' => 'rg-ae******ey'], + 'tags' => [ + 'description' => '资源标签', 'type' => 'array', 'items' => [ - 'description' => '请求头', - 'type' => 'string', - 'example' => 'headerKey', - ], - ], - 'requestId' => [ - 'description' => '请求 ID', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'responseStatus' => [ - 'description' => '结果状态', - 'type' => 'object', - 'properties' => [ - 'result' => [ - 'description' => '执行结果', - 'type' => 'string', - 'example' => 'Success,PartialSuccess,Error', - ], - 'retryPolicy' => [ - 'description' => '重试策略', - 'type' => 'string', - 'example' => 'None,Once,Continuous', - ], - 'level' => [ - 'description' => '状态级别', - 'type' => 'string', - 'example' => 'Info,Warn,Error', - ], - 'statusItem' => [ - 'description' => '详细的状态信息列表', - 'type' => 'array', - 'items' => [ - 'description' => '详细的状态信息', - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'description' => '状态码', - 'type' => 'string', - 'example' => 'Success,ExecuteTimeout,UModelNotExist', - ], - 'level' => [ - 'description' => '状态级别', - 'type' => 'string', - 'example' => 'Info,Warn,Error', - ], - 'message' => [ - 'description' => '计算执行信息', - 'type' => 'string', - 'example' => 'Query execution timeout after 30 seconds', - ], - 'suggestion' => [ - 'description' => '执行错误时的建议', - 'type' => 'string', - 'example' => 'Try to reduce the query scope or increase timeout limit, then retry', - ], - ], - ], - ], - 'executionStates' => [ - 'description' => '执行过程中的信息', - 'type' => 'string', - 'example' => '{}', + 'description' => '资源标签', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => '资源组标签的键。', 'type' => 'string', 'required' => false, 'example' => '_cms_workspace'], + 'value' => ['description' => '资源组标签的值。', 'type' => 'string', 'required' => false, 'example' => 'test'], ], + 'required' => false, ], + 'required' => false, ], ], + 'required' => false, ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => '4CB23A2E-B426-5D4B-9AA2-6C7A508D954B'], + 'taskId' => ['description' => '投递任务 ID', 'type' => 'string', 'example' => '98e367d8fb8cc83b'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n [\\n \\"data1\\"\\n ]\\n ],\\n \\"header\\": [\\n \\"headerKey\\"\\n ],\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"responseStatus\\": {\\n \\"result\\": \\"Success,PartialSuccess,Error\\",\\n \\"retryPolicy\\": \\"None,Once,Continuous\\",\\n \\"level\\": \\"Info,Warn,Error\\",\\n \\"statusItem\\": [\\n {\\n \\"code\\": \\"Success,ExecuteTimeout,UModelNotExist\\",\\n \\"level\\": \\"Info,Warn,Error\\",\\n \\"message\\": \\"Query execution timeout after 30 seconds\\",\\n \\"suggestion\\": \\"Try to reduce the query scope or increase timeout limit, then retry\\"\\n }\\n ],\\n \\"executionStates\\": \\"{}\\"\\n }\\n}","type":"json"}]', - 'title' => '查询实体和关系数据', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建数据投递任务', + 'requestParamsDescription' => '### sinkConfigs 配置项说明'."\n" + ."\n" + .'**sinkType = Prometheus**'."\n" + ."\n" + .'| key | 是否必填 | 说明 | 示例值 | 枚举值 |'."\n" + .'| --- | --- | --- | --- | --- |'."\n" + .'| Url | 是 | Remote Write 写入地址 | `http://xxxx/api/v1/write` | |'."\n" + .'| Network | 否 | 网络类型 | `PublicNetwork` | - PublicNetwork（公网）<br>- PrivateNetwork（私网/VPC） |'."\n" + .'| VpcId | 否 | VPC ID，Network 为 PrivateNetwork 时填写 | `vpc-xxxxxx` | |'."\n" + .'| VSwtichId | 否 | VSwitch ID | `vsw-xxxxxx` | |'."\n" + .'| SecurityGroupId | 否 | 安全组 ID | `sg-xxxxxx` | |'."\n" + .'| Header | 否 | 自定义 HTTP Header，需为 JSON 格式的 Map 字符串 | `{"aaa":"bbb","ccc":"ddd"}` | |'."\n" + .'| AuthType | 否 | 认证类型 | `BasicAuth` | - BasicAuth<br>- None |'."\n" + .'| Username | 否 | BasicAuth 用户名，AuthType 为 BasicAuth 时填写 | `admin` | |'."\n" + .'| Password | 否 | BasicAuth 密码，AuthType 为 BasicAuth 时填写 | `xxxxxx` | |'."\n" + ."\n" + .'**sinkType = AcsKafka**'."\n" + ."\n" + .'| key | 是否必填 | 说明 | 示例值 |'."\n" + .'| --- | --- | --- | --- |'."\n" + .'| InstanceId | 是 | Kafka 实例 ID | `alikafka_xxxxx` |'."\n" + .'| Topic | 是 | Kafka Topic 名称 | `my-topic` |'."\n" + ."\n" + .'**sinkType = AcsMaxCompute**'."\n" + ."\n" + .'| key | 是否必填 | 说明 | 示例值 |'."\n" + .'| --- | --- | --- | --- |'."\n" + .'| ServiceName | 是 | MaxCompute 服务名 | `my-mc-service` |', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4CB23A2E-B426-5D4B-9AA2-6C7A508D954B\\",\\n \\"taskId\\": \\"98e367d8fb8cc83b\\"\\n}","type":"json"}]', ], - 'DeleteEntityStore' => [ - 'summary' => '删除EntityStore相关存储', + 'CreateEntityStore' => [ 'path' => '/workspace/{workspaceName}/entitystore', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspaceName', 'in' => 'path', - 'schema' => [ - 'description' => '工作空间名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test-001', - ], + 'schema' => ['description' => '工作空间名称。', 'type' => 'string', 'required' => true, 'example' => 'workspace-test-001'], ], ], 'responses' => [ @@ -7041,73 +5905,94 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '请求 ID', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], + 'requestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'workspaceName' => ['description' => '工作空间名称', 'type' => 'string', 'example' => 'workspace-test-001'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', - 'title' => '删除EntityStore', - ], - 'CreateUmodel' => [ - 'summary' => '创建Umodel配置。', - 'path' => '/workspace/{workspace}/umodel', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建EntityStore', + 'summary' => '创建EntityStore相关存储', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEntityStore'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateEntityStore', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'EntityStore', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#WorkspaceName}/entitystore'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"workspaceName\\": \\"workspace-test-001\\"\\n}","type":"json"}]', + ], + 'CreateIntegrationPolicy' => [ + 'summary' => '创建接入中心策略', + 'path' => '/integration-policies', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'workspace', - 'in' => 'path', - 'schema' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - ], - ], - [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求 Body', + 'description' => '请求body。', 'type' => 'object', 'properties' => [ - 'description' => [ - 'description' => 'Umodel描述', - 'type' => 'string', + 'entityGroup' => [ + 'description' => '用于创建策略的实体组，可以通过实体组快速创建，clusterId和vpcId是互相独立的。', + 'type' => 'object', + 'properties' => [ + 'clusterEntityType' => ['description' => '集群实体类型，acs.ack.cluster/acs.one.cluster/acs.asi.cluster或其他。', 'type' => 'string', 'required' => false, 'example' => 'acs.ack.cluster'], + 'clusterId' => ['description' => '集群ID。', 'type' => 'string', 'required' => false, 'example' => 'na61prod3-na61cloudhdfsssd'], + 'entityUserId' => ['description' => '集群归属用户ID。', 'type' => 'string', 'required' => false, 'example' => '12xxxx'], + 'entityGroupId' => ['description' => '实体组ID。', 'type' => 'string', 'required' => false, 'example' => 'eg-b79f65d11fb94e779867cf937c3a3002'], + 'vpcId' => ['description' => '专有网络ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp18fgg3ffxa9czna40xt'], + 'disablePolicyShare' => ['description' => '是否禁用 Policy 唯一绑定，如果开启则可以为一个容器集群创建多个Policy', 'type' => 'boolean', 'required' => false, 'example' => 'ture'], + 'clusterNamespace' => ['title' => '', 'type' => 'string', 'required' => false, 'description' => ''], + ], + 'required' => false, + ], + 'policyName' => ['title' => '策略名称', 'description' => '策略名称。', 'type' => 'string', 'required' => false, 'example' => 'prod-database'], + 'policyType' => ['title' => '策略类型：CS/ECS/Cloud', 'description' => '策略类型：CS/ECS/Cloud', 'type' => 'string', 'required' => true, 'example' => 'CS'], + 'resourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-aekz2km4kmhtbii'], + 'tags' => [ + 'description' => '资源标签。', + 'type' => 'array', + 'items' => [ + 'description' => '资源标签。', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => '标签`key`值。', 'type' => 'string', 'required' => false, 'example' => 'use'], + 'value' => ['description' => '标签`value`值。', 'type' => 'string', 'required' => false, 'example' => 'database'], + ], + 'required' => false, + ], 'required' => false, - 'example' => 'workspace test', ], + 'workspace' => ['title' => '工作空间，不填则创建或使用默认工作空间。', 'description' => '工作空间。', 'type' => 'string', 'required' => false, 'example' => 'prometheus'], ], 'required' => false, ], @@ -7118,159 +6003,166 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => '123-0F43-23423-AC43-34234', - ], - 'workspace' => [ - 'description' => '工作空间名称。', - 'type' => 'string', - 'example' => 'workspace-test', + 'policy' => [ + 'description' => '上传策略。', + 'type' => 'object', + 'properties' => [ + 'entityGroupId' => ['description' => '实体组ID。', 'type' => 'string', 'example' => 'eg-b79f65d11fb94e779867cf937c3a3002'], + 'policyId' => ['title' => '策略id', 'description' => '策略ID。', 'type' => 'string', 'example' => 'policy-14c8e9a29b0a46da843f8781471062ff'], + 'policyName' => ['title' => '策略名称', 'description' => '策略名称。', 'type' => 'string', 'example' => 'metrics-inner-manage'], + 'policyType' => ['title' => '策略类型', 'description' => '策略类型。', 'type' => 'string', 'example' => 'CS'], + 'regionId' => ['title' => 'region', 'description' => '地域。', 'type' => 'string', 'example' => 'cn-heyuan'], + 'userId' => ['title' => '用户id', 'description' => '用户ID。', 'type' => 'string', 'example' => 'u1234567'], + 'workspace' => ['title' => 'Policy所在的工作空间。', 'description' => 'Policy所在的工作空间。', 'type' => 'string', 'example' => 'prometheus'], + ], ], + 'requestId' => ['title' => '', 'description' => '请求 ID。', 'type' => 'string', 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5'], + 'created' => ['description' => '是否创建。', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建接入中心策略', + 'description' => '本接口用于支持用户创建事件集成', + 'changeSet' => [ + ['createdAt' => '2025-10-28T08:08:20.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-10-13T07:13:42.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"123-0F43-23423-AC43-34234\\",\\n \\"workspace\\": \\"workspace-test\\"\\n}","type":"json"}]', - 'title' => '创建 Umodel', - 'description' => '在指定工作空间里创建 Umodel配置', - ], - 'GetUmodel' => [ - 'summary' => '获取Umodel配置信息。', - 'path' => '/workspace/{workspace}/umodel', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIntegrationPolicy'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateIntegrationPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"policy\\": {\\n \\"entityGroupId\\": \\"eg-b79f65d11fb94e779867cf937c3a3002\\",\\n \\"policyId\\": \\"policy-14c8e9a29b0a46da843f8781471062ff\\",\\n \\"policyName\\": \\"metrics-inner-manage\\",\\n \\"policyType\\": \\"CS\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"userId\\": \\"u1234567\\",\\n \\"workspace\\": \\"prometheus\\"\\n },\\n \\"requestId\\": \\"CD8BA7D6-995D-578D-9941-78B0FECD14B5\\",\\n \\"created\\": true\\n}","type":"json"}]', + ], + 'CreateMemoryStore' => [ + 'path' => '/workspace/{workspace}/memorystore', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => true], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - ], + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'maxLength' => 64, 'minLength' => 2], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ + 'description' => '请求 Body', 'type' => 'object', 'properties' => [ - 'commonSchemaRef' => [ - 'description' => '目前无需填充该字段内容', + 'memoryStoreName' => ['description' => '记忆库名称', 'type' => 'string', 'required' => true, 'example' => 'test-memory-store'], + 'description' => ['description' => '描述', 'type' => 'string', 'required' => false, 'example' => 'Test memory store for demonstration.'], + 'shortTermTtl' => ['description' => '短期记忆保存时间', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'], + 'extractionStrategies' => [ + 'description' => '提取策略，支持 "Episodic", "Summary", "Fact"。', 'type' => 'array', - 'items' => [ - 'description' => '目前无需填充该字段内容', - 'type' => 'object', - 'properties' => [ - 'group' => [ - 'description' => '公共Umodel Schema group', - 'type' => 'string', - 'example' => 'test-job-123123', - ], - 'version' => [ - 'description' => '版本', - 'type' => 'string', - 'example' => '5', - ], - ], - ], - ], - 'description' => [ - 'description' => 'Umodel描述', - 'type' => 'string', - 'example' => 'workspace test', - ], - 'regionId' => [ - 'description' => '所在地域', - 'type' => 'string', - 'example' => 'cn-heyuan', + 'items' => ['description' => '策略数组', 'type' => 'string', 'required' => false, 'example' => 'Fact'], + 'required' => false, ], - 'requestId' => [ - 'description' => '请求 ID', - 'type' => 'string', - 'example' => '123-123123-sdf-435-3123', + 'customExtractionStrategies' => [ + 'description' => '自定义提取策略。', + 'type' => 'array', + 'items' => ['description' => '策略数组', 'required' => false, '$ref' => '#/components/schemas/CustomExtractionStrategy'], + 'required' => false, ], - 'workspace' => [ - 'description' => '工作空间名称。', - 'type' => 'string', - 'example' => 'workspace-test', + 'sourceType' => ['type' => 'string', 'example' => 'None/Trace'], + 'traceSourceConfig' => [ + 'type' => 'object', + 'properties' => [ + 'workspace' => ['type' => 'string', 'example' => 'test-workspace'], + 'query' => ['type' => 'string', 'example' => '(serviceName : "langchain-rag" or serviceName : "agentscope-code-correction") and hostname = frontend-proxy-999c48c8d-hvk6c '], + 'includeOutput' => ['type' => 'boolean'], + ], ], ], + 'required' => false, + 'title' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应数据', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => '请求Id', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"commonSchemaRef\\": [\\n {\\n \\"group\\": \\"test-job-123123\\",\\n \\"version\\": \\"5\\"\\n }\\n ],\\n \\"description\\": \\"workspace test\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"requestId\\": \\"123-123123-sdf-435-3123\\",\\n \\"workspace\\": \\"workspace-test\\"\\n}","type":"json"}]', - 'title' => '获取 Umodel', - 'description' => '获取Umodel配置信息', - ], - 'UpdateUmodel' => [ - 'summary' => '更新Umodel配置信息。', - 'path' => '/workspace/{workspace}/umodel', - 'methods' => [ - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建记忆库', + 'summary' => '创建记忆库', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateMemoryStore', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'MemoryStore', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#WorkspaceName}/memorystore/{#MemoryStoreName}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + ], + 'CreatePipeline' => [ + 'path' => '/workspace/{workspace}/pipeline', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => '工作空间名称', 'type' => 'string', 'required' => false, 'example' => 'workspace-test'], ], [ 'name' => 'body', @@ -7280,11 +6172,101 @@ 'description' => '请求 Body', 'type' => 'object', 'properties' => [ - 'description' => [ - 'description' => '描述', - 'type' => 'string', + 'pipelineName' => ['description' => '流水线名称', 'type' => 'string', 'required' => false, 'example' => 'pipeline-name-1'], + 'description' => ['description' => '描述', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'pipeline' => [ + 'description' => '流水线信息', + 'type' => 'object', + 'properties' => [ + 'nodes' => [ + 'description' => '节点', + 'type' => 'array', + 'items' => [ + 'description' => '节点', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => '节点Id', 'type' => 'string', 'required' => false, 'example' => 'node_1'], + 'type' => ['description' => '节点类型', 'type' => 'string', 'required' => false, 'example' => 'dedup-fuzzy'], + 'parameters' => [ + 'description' => '参数', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'any', 'example' => '{'."\n" + .' "output": "ID,key_0,key_2,key_3,key_4",'."\n" + .' "workspace": "workspace-test-dataset",'."\n" + .' "field": "key_0",'."\n" + .' "global": true,'."\n" + .' "dataset": "dataset_1"'."\n" + .' }', 'description' => '参数'], + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'source' => [ + 'description' => '数据源', + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => '数据源类型', 'type' => 'string', 'required' => false, 'example' => 'logstore'], + 'logstore' => [ + 'description' => '日志服务Logstore信息', + 'type' => 'object', + 'properties' => [ + 'project' => ['description' => '日志服务Project名称', 'type' => 'string', 'required' => false, 'example' => 'test-project'], + 'logstore' => ['description' => '日志服务Logstore名称', 'type' => 'string', 'required' => false, 'example' => 'test-logstore'], + 'query' => ['description' => '过滤语句', 'type' => 'string', 'required' => false, 'example' => 'status:500 and method:GET'], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'sink' => [ + 'description' => '输出目标', + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => '输出目标类型', 'type' => 'string', 'required' => false, 'example' => 'dataset'], + 'dataset' => [ + 'description' => '数据集信息', + 'type' => 'object', + 'properties' => [ + 'workspace' => ['description' => '工作空间ID', 'type' => 'string', 'required' => false, 'example' => 'workspace-test'], + 'dataset' => ['description' => '数据集', 'type' => 'string', 'required' => false, 'example' => 'dataset_1'], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'executePolicy' => [ + 'description' => '执行策略', + 'type' => 'object', + 'properties' => [ + 'mode' => ['description' => '执行模式', 'type' => 'string', 'required' => false, 'example' => 'runOnce'], + 'runOnce' => [ + 'description' => '只执行一次时的配置', + 'type' => 'object', + 'properties' => [ + 'fromTime' => ['description' => '开始时间时间戳', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1772519013'], + 'toTime' => ['description' => '结束时间时间戳', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1772519013'], + ], + 'required' => false, + ], + 'scheduled' => [ + 'description' => '定时执行时的配置', + 'type' => 'object', + 'properties' => [ + 'interval' => ['description' => '时间间隔', 'type' => 'string', 'required' => false, 'example' => '86400'], + 'fromTime' => ['description' => '开始时间时间戳', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1772519013'], + ], + 'required' => false, + ], + ], 'required' => false, - 'example' => 'workspace test', ], ], 'required' => false, @@ -7294,65 +6276,143 @@ 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应数据', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '请求 ID', - 'type' => 'string', - 'example' => '234324-123-123-123-23423', - ], - 'workspace' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'example' => 'workspace-test', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求Id', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-***'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建流水线', + 'summary' => '创建流水线', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"234324-123-123-123-23423\\",\\n \\"workspace\\": \\"workspace-test\\"\\n}","type":"json"}]', - 'title' => '更新 Umodel', - 'description' => '更新Umodel配置信息', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-***\\"\\n}","type":"json"}]', ], - 'DeleteUmodel' => [ - 'summary' => '删除Umodel配置信息。', - 'path' => '/workspace/{workspace}/umodel', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'CreatePrometheusInstance' => [ + 'summary' => '创建Prometheus监控实例', + 'path' => '/prometheus-instances', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'workspace', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '工作空间名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', + 'description' => '请求结构。', + 'type' => 'object', + 'properties' => [ + 'archiveDuration' => [ + 'title' => '存储到期后，自动归档保存的天数，0表示不归档保存。归档天数取值范围：'."\n" + .'V1：1~365天。仅按指标写入量支持。'."\n" + .'V2：1~3650天（3650表示永久保存）。', + 'description' => '存储到期后，自动归档保存的天数。0表示不归档保存。归档天数取值范围：'."\n" + .'* V1：60~365天。'."\n" + .'* V2：60~3650天（3650表示永久保存）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + 'enum' => [], + ], + 'authFreeReadPolicy' => ['description' => '免密读策略（支持IP段和VpcId）。', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "SourceIp": ['."\n" + .' "192.168.1.0/24",'."\n" + .' "172.168.2.22"'."\n" + .' ],'."\n" + .' "SourceVpc": ['."\n" + .' "vpc-xx1",'."\n" + .' "vpc-xx2"'."\n" + .' ]'."\n" + .'}'], + 'authFreeWritePolicy' => ['description' => '免密写策略', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "SourceIp": ['."\n" + .' "192.168.1.0/24",'."\n" + .' "172.168.2.22"'."\n" + .' ],'."\n" + .' "SourceVpc": ['."\n" + .' "vpc-xx1",'."\n" + .' "vpc-xx2"'."\n" + .' ]'."\n" + .'}'], + 'enableAuthFreeRead' => ['description' => '是否开启免密读（仅V2版本支持）。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'enableAuthFreeWrite' => ['description' => '是否开启免密写（仅V2版本支持）。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'enableAuthToken' => ['description' => '是否开启授权Token（仅V1版本支持）。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'prometheusInstanceName' => ['description' => '实例名称。', 'type' => 'string', 'required' => true, 'example' => 'name1'], + 'resourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-aekz5qqvjyatgoy'], + 'status' => [ + 'description' => '实例状态。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['Running' => 'Running', 'Stoped' => 'Stoped'], + 'example' => 'Running', + 'default' => 'Running', + 'enum' => ['Running'], + ], + 'storageDuration' => [ + 'title' => '存储时长（天）：'."\n" + .'按写入量：90、180'."\n" + .'按指标上报量：15、30、60、90、180', + 'description' => '存储时长（天）：'."\n" + .'* 按写入量：90、180。'."\n" + .'* 按指标上报量：15、30、60、90、180。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [15 => '15天', 30 => '30天', 60 => '60天', 90 => '90天', 180 => '180天'], + 'example' => '90', + 'enum' => ['15', '30', '60', '90', '180'], + ], + 'tags' => [ + 'description' => '标签值。', + 'type' => 'array', + 'items' => [ + 'description' => '标签值。', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => '标签Key。', 'type' => 'string', 'required' => false, 'example' => 'key1'], + 'value' => ['description' => '标签Value。', 'type' => 'string', 'required' => false, 'example' => '110109200001214284'], + ], + 'required' => false, + ], + 'required' => false, + ], + 'workspace' => ['title' => '默认值：default-cms-{userId}-{regionId}', 'description' => '归属工作空间，默认值：default-cms-{userId}-{regionId}。', 'type' => 'string', 'required' => false, 'example' => 'wokspace1'], + 'paymentType' => [ + 'title' => '计费方式：'."\n" + .'POSTPAY：按指标上报量后付费。'."\n" + .'POSTPAY_GB：按指标写入量后付费。'."\n" + .'空：则使用用户的默认计费方式配置。若用户未配置默认值，则系统默认是按指标上报量计费。', + 'description' => '计费方式：'."\n" + .'* POSTPAY：按指标上报量后付费。'."\n" + .'* POSTPAY_GB：按指标写入量后付费。'."\n" + .'注，空值则使用用户的默认计费方式配置。若用户未配置默认值，则系统默认是按指标上报量计费。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['POSTPAY' => '上报量', 'POSTPAY_GB' => '写入量'], + 'example' => 'POSTPAY', + 'enum' => ['POSTPAY', 'POSTPAY_GB'], + ], + ], + 'required' => false, ], ], ], @@ -7361,234 +6421,193 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '请求 ID', - 'type' => 'string', - 'example' => '123123-3213-345-9941-345345345', - ], + 'prometheusInstanceId' => ['title' => '集群id', 'description' => '实例id。', 'type' => 'string', 'example' => 'rw-abc123'], + 'requestId' => ['description' => 'Id of the request', 'type' => 'string', 'example' => '264C3E89-BE6E-5F82-A484-CE9C2196C7DC'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"123123-3213-345-9941-345345345\\"\\n}","type":"json"}]', - 'title' => '删除 Umodel', - 'description' => '删除指定 workspace 下的Umodel', - ], - 'GetUmodelData' => [ - 'summary' => '获取相关联的 Umodel 图数据。', - 'path' => '/workspace/{workspace}/umodel/graph', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusInstanceId\\": \\"rw-abc123\\",\\n \\"requestId\\": \\"264C3E89-BE6E-5F82-A484-CE9C2196C7DC\\"\\n}","type":"json"}]', + 'title' => '创建Prometheus实例', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePrometheusInstance'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreatePrometheusInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'PrometheusInstance', 'arn' => 'acs:cms:{#regionId}:{#accountId}:prometheusinstance/*'], + ], + ], + ], ], + ], + 'CreatePrometheusView' => [ + 'summary' => '创建prometheus视图', + 'path' => '/prometheus-views', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'workspace', - 'in' => 'path', - 'schema' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - ], - ], - [ - 'name' => 'method', - 'in' => 'query', - 'schema' => [ - 'description' => '方法', - 'type' => 'string', - 'required' => true, - 'example' => 'ListData', - ], - ], - [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求 Body', - 'type' => 'object', - 'properties' => [ - 'content' => [ - 'description' => '查询条件', - 'type' => 'any', - 'required' => false, - 'example' => '{'."\n" - .' "filter": {'."\n" - .' "domains": []'."\n" - .' },'."\n" - .' "offset": 0,'."\n" - .' "size": 100000'."\n" - .'}', - ], - ], - 'required' => false, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '返回结果', + 'description' => '请求Body', 'type' => 'object', 'properties' => [ - 'nodes' => [ - 'description' => '节点列表', - 'type' => 'array', - 'items' => [ - 'description' => '节点。', - 'type' => 'any', - 'example' => '{}', - ], - ], - 'links' => [ - 'description' => '节点 link 关系列表', + 'authFreeReadPolicy' => ['description' => '暂未启用', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "SourceIp": ['."\n" + .' "192.168.1.0/24",'."\n" + .' "172.168.2.22"'."\n" + .' ],'."\n" + .' "SourceVpc": ['."\n" + .' "vpc-xx1",'."\n" + .' "vpc-xx2"'."\n" + .' ]'."\n" + .'}'], + 'enableAuthFreeRead' => ['title' => '是否支持免密读', 'description' => '是否支持免密读', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'enableAuthToken' => ['title' => '是否支持authToken', 'description' => '是否支持authToken。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'prometheusInstances' => [ + 'description' => 'Prometheus 实例列表。', 'type' => 'array', 'items' => [ - 'description' => '节点 link 关系', - 'type' => 'any', - 'example' => '{}', + 'type' => 'object', + 'properties' => [ + 'prometheusInstanceId' => ['description' => '实例id。', 'type' => 'string', 'required' => false, 'example' => 'arms-1d581fac20a462dcde743d9628'], + 'regionId' => ['description' => '地域 ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-wulanchabu'], + 'userId' => ['description' => '用户ID。', 'type' => 'string', 'required' => false, 'example' => '167271234567890'], + ], + 'required' => false, + 'description' => '', ], + 'required' => true, ], - 'totalNodesCount' => [ - 'description' => '总节点数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'totalLinksCount' => [ - 'description' => '总节点 link 关系数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', + 'prometheusViewName' => ['description' => 'Prometheus 视图名称。', 'type' => 'string', 'required' => true, 'example' => 'test-prom-view-name'], + 'resourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-acfm3gn5i6bigbi'], + 'status' => [ + 'description' => '暂未启用。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['Running' => '运行'], + 'example' => 'null', + 'default' => 'Running', + 'enum' => ['Running'], ], - 'errors' => [ - 'description' => '错误信息', + 'tags' => [ + 'description' => '执行的操作。', 'type' => 'array', 'items' => [ - 'description' => '错误信息', + 'description' => '标签Key。', 'type' => 'object', 'properties' => [ - 'message' => [ - 'description' => '详细信息', - 'type' => 'string', - 'example' => 'ok', - ], - 'type' => [ - 'description' => '错误类型', - 'type' => 'string', - 'example' => 'external', - ], + 'key' => ['description' => '标签Key。', 'type' => 'string', 'required' => false, 'example' => 'test-key'], + 'value' => ['description' => '标签Value。', 'type' => 'string', 'required' => false, 'example' => 'test-value'], ], + 'required' => false, ], + 'required' => false, ], - 'requestId' => [ - 'description' => '请求 ID', + 'version' => [ + 'title' => 'V1：老版本(global-view)'."\n" + .'V2：新版本(prom-view)', + 'description' => '- V1：老版本'."\n" + .'- V2：新版本', 'type' => 'string', - 'example' => '123-123-234-345-123', + 'required' => true, + 'enumValueTitles' => ['V1' => 'V1版本', 'V2' => 'V2版本'], + 'example' => 'V2', + 'enum' => ['V1', 'V2'], ], + 'workspace' => ['title' => '默认值：default-cms-{userId}-{regionId}', 'description' => '默认值：default-cms-{userId}-{regionId}', 'type' => 'string', 'required' => false, 'example' => 'cms-monitor-test-aysls-pub-cn-zhangjiakou-spe-monitor'], ], + 'required' => false, ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'prometheusViewId' => ['description' => 'Prometheus 视图 ID。', 'type' => 'string', 'example' => 'cd5237f7dbd574cf9bbd648ff9efb16cd'], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"nodes\\": [\\n \\"{}\\"\\n ],\\n \\"links\\": [\\n \\"{}\\"\\n ],\\n \\"totalNodesCount\\": 0,\\n \\"totalLinksCount\\": 0,\\n \\"errors\\": [\\n {\\n \\"message\\": \\"ok\\",\\n \\"type\\": \\"external\\"\\n }\\n ],\\n \\"requestId\\": \\"123-123-234-345-123\\"\\n}","type":"json"}]', - 'title' => '获取 Umodel Data', - 'description' => '查找Umodel', - ], - 'UpsertUmodelData' => [ - 'summary' => '写入 Umodel Elements。', - 'path' => '/workspace/{workspace}/umodel/data', - 'methods' => [ - 'patch', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusViewId\\": \\"cd5237f7dbd574cf9bbd648ff9efb16cd\\",\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + 'title' => '创建prometheus视图', + 'description' => '用于创建一个站点监控任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePrometheusView'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreatePrometheusView', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'PrometheusView', 'arn' => 'acs:cms:{#regionId}:{#accountId}:prometheusview/*'], + ], + ], + ], ], + ], + 'CreatePrometheusVirtualInstance' => [ + 'path' => '/virtual-instances', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'workspace', - 'in' => 'path', - 'schema' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - ], - ], - [ - 'name' => 'method', - 'in' => 'query', - 'schema' => [ - 'description' => '方法', - 'type' => 'string', - 'required' => false, - 'example' => 'Upsert', - ], - ], - [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '元素列表', + 'description' => '请求体。', 'type' => 'object', 'properties' => [ - 'elements' => [ - 'description' => '元素内容', - 'type' => 'array', - 'items' => [ - 'description' => '元素内容', - 'type' => 'any', - 'required' => false, - 'example' => '{}', - ], - 'required' => false, - ], + 'namespace' => ['title' => '每个云产品在每个Regin只能创建一个虚拟实例', 'description' => '每个云产品在每个Regin只能创建一个虚拟实例。', 'type' => 'string', 'required' => true, 'example' => 'cms_prometheus'], + 'tenantId' => ['type' => 'string'], ], 'required' => false, ], @@ -7599,88 +6618,114 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '请求 ID', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', + 'requestId' => ['description' => 'Id of the request', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-************'], + 'instance' => [ + 'title' => '实例ID', + 'description' => '实例ID', + 'type' => 'object', + 'properties' => [ + 'instanceId' => ['title' => '地域ID', 'description' => '地域ID', 'type' => 'string', 'example' => 'rw-e815960b4c9ebc5c3d89790c7e82'], + 'regionId' => ['title' => '用户ID', 'description' => '用户ID', 'type' => 'string', 'example' => 'cn-zhengzhou-jva'], + 'userId' => ['title' => '用户ID', 'description' => '用户ID', 'type' => 'string', 'example' => '167212345678'], + 'namespace' => ['title' => '云产品', 'description' => '云产品', 'type' => 'string', 'example' => 'ack-csi-fuse'], + 'httpApiUrl' => ['title' => 'HTTP API查询地址', 'description' => 'HTTP API查询地址', 'type' => 'string', 'example' => 'http://xxxxxxx'], + 'createdAt' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '1751520976660'], + ], ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', - 'title' => '添加或覆盖Umodel（元素）', - ], - 'DeleteUmodelData' => [ - 'summary' => '删除 Umodel Elements。', - 'path' => '/workspace/{workspace}/umodel/data', - 'methods' => [ - 'delete', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建Prometheus监控虚拟实例', + 'summary' => '创建Prometheus监控虚拟实例', + 'description' => '创建Prometheus监控虚拟实例。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePrometheusVirtualInstance'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreatePrometheusVirtualInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-************\\",\\n \\"instance\\": {\\n \\"instanceId\\": \\"rw-e815960b4c9ebc5c3d89790c7e82\\",\\n \\"regionId\\": \\"cn-zhengzhou-jva\\",\\n \\"userId\\": \\"167212345678\\",\\n \\"namespace\\": \\"ack-csi-fuse\\",\\n \\"httpApiUrl\\": \\"http://xxxxxxx\\",\\n \\"createdAt\\": \\"1751520976660\\"\\n }\\n}","type":"json"}]', + ], + 'CreateService' => [ + 'summary' => '创建应用可观测服务', + 'path' => '/workspace/{workspace}/service', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'workspace', - 'in' => 'path', - 'schema' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - ], - ], - [ - 'name' => 'domain', - 'in' => 'query', - 'schema' => [ - 'description' => '可以指定特定Umodel data 的name，不传代表全部', - 'type' => 'string', - 'required' => false, - 'example' => 'apm', - ], - ], - [ - 'name' => 'name', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '可以指定特定Umodel data 的name，不传代表全部', - 'type' => 'string', + 'description' => '请求体', + 'type' => 'object', + 'properties' => [ + 'serviceName' => ['title' => '应用资源名称', 'description' => '服务名称', 'type' => 'string', 'required' => true, 'example' => 'mag_test'], + 'serviceType' => [ + 'title' => '类型：TRACE（应用监控）/ RUM（用户体验监控）/ XTRACE（OT版）', + 'description' => '服务类型', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => ['TRACE' => '应用性能监控', 'RUM' => '用户体验监控', 'XTRACE' => 'OpenTelemtry链路追踪'], + 'example' => 'TRACE', + ], + 'displayName' => ['title' => '别名', 'description' => '显示名称，仅当serviceType=RUM时有效。', 'type' => 'string', 'required' => false, 'example' => 'Mag test application'], + 'description' => ['title' => '应用描述信息。', 'description' => '服务描述，仅当serviceType=RUM时有效。', 'type' => 'string', 'required' => false, 'example' => 'Mag test application'], + 'attributes' => ['title' => '特征信息，key:value格式', 'description' => '扩展属性。', 'type' => 'string', 'required' => false, 'example' => '{"language":"java"}'], + 'serviceStatus' => ['title' => '应用体验监控的服务状态，Running/Stopped/Created/Suspend', 'description' => '服务状态，创建服务无需指定。', 'type' => 'string', 'required' => false, 'example' => 'Created'], + 'pid' => ['title' => '对应ARMS应用pid', 'description' => '应用ID，一般无需指定', 'type' => 'string', 'required' => false, 'example' => 'bx3udsi5ie@ed2ba6beebdb6de'], + 'resourceGroupId' => ['title' => '资源组id', 'description' => '资源组id', 'type' => 'string', 'required' => false, 'example' => 'rg-xxxxxxx'], + 'tags' => [ + 'title' => '标签数组', + 'description' => '标签数组。', + 'type' => 'array', + 'items' => [ + 'title' => '标签', + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'key' => ['title' => '标签key', 'description' => '标签`key`值。', 'type' => 'string', 'required' => false, 'example' => 'env'], + 'value' => ['title' => '标签value', 'description' => '标签`value`值。', 'type' => 'string', 'required' => false, 'example' => 'prod'], + ], + 'required' => false, + ], + 'required' => false, + ], + ], 'required' => false, - 'example' => 'test', ], ], [ - 'name' => 'kind', - 'in' => 'query', - 'schema' => [ - 'description' => '可以指定特定Umodel data 的kind，不传代表全部', - 'type' => 'string', - 'required' => false, - 'example' => 'metric_set', - ], + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['title' => '工作空间', 'description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'default-cms-1793369865235921-cn-shenzhen'], ], ], 'responses' => [ @@ -7688,396 +6733,291 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => '111111-222-333-1111-33333', - ], + 'requestId' => ['title' => '请求id', 'description' => '请求ID。', 'type' => 'string', 'example' => '3A2FA9E9-9CF1-5CB1-A808-52828F14310D'], + 'serviceId' => ['title' => '应用服务id', 'description' => '服务ID', 'type' => 'string', 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb'], + 'pid' => ['title' => '对应ARMS应用pid', 'description' => '兼容历史的ARMS应用ID', 'type' => 'string', 'example' => 'cwzxvuc6uo@d60088ad4797d26'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"111111-222-333-1111-33333\\"\\n}","type":"json"}]', - 'title' => '删除Umodel Data', - 'description' => '删除指定工作空间下Umodel的 Data', - ], - 'GetUmodelCommonSchemaRef' => [ - 'summary' => '获取引用的公共Umodel Schema。', - 'path' => '/workspace/{workspace}/umodel/common-schema-ref', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3A2FA9E9-9CF1-5CB1-A808-52828F14310D\\",\\n \\"serviceId\\": \\"cwzxvuc6uo@4bc6b15ad81f166174ffb\\",\\n \\"pid\\": \\"cwzxvuc6uo@d60088ad4797d26\\"\\n}","type":"json"}]', + 'title' => '创建应用可观测服务', + 'requestParamsDescription' => '扩展属性attributes，'."\n" + .'serviceType=TRACE时，可选属性language，可选值java/python/golang；'."\n" + .'serviceType=XTRACE时，可选属性language，可选值参考开源值https://opentelemetry.io/docs/specs/semconv/registry/attributes/telemetry/。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateService'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Service', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#Workspace}/service/*'], + ], + ], + ], ], + ], + 'CreateServiceObservability' => [ + 'summary' => '创建应用可观测，完成接入前置资源准备等；', + 'path' => '/workspace/{workspace}/service-observability/{type}', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'default-cms-1654218965343050-cn-hangzhou'], + ], + [ + 'name' => 'type', + 'in' => 'path', 'schema' => [ - 'description' => '工作空间名称', + 'description' => '应用可观测类型', 'type' => 'string', 'required' => true, - 'example' => 'workspace-test', + 'enumValueTitles' => ['rum' => '用户体验监控', 'apm' => '应用性能监控'], + 'example' => 'apm', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'commonSchemaRef' => [ - 'description' => '引用的公共Umodel Schema。', - 'type' => 'array', - 'items' => [ - 'description' => '引用的公共Umodel Schema。', - 'type' => 'object', - 'properties' => [ - 'group' => [ - 'description' => '公共Umodel Schema group', - 'type' => 'string', - 'example' => 'apm-common', - ], - 'version' => [ - 'description' => '版本。', - 'type' => 'string', - 'example' => '0.1.0', - ], - ], - ], - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"commonSchemaRef\\": [\\n {\\n \\"group\\": \\"apm-common\\",\\n \\"version\\": \\"0.1.0\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取引用的公共Umodel Schema', - ], - 'DeleteUmodelCommonSchemaRef' => [ - 'summary' => '删除引用的公共Umodel Schema。', - 'path' => '/workspace/{workspace}/umodel/common-schema-ref', - 'methods' => [ - 'delete', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建应用可观测', + 'extraInfo' => '说明：'."\n" + ."\n" + .'- 资源初始化涉及较多动作可能存在延迟，接口发起成功即可；可以通过GetServiceObservability来获取状态，如果status返回running则表示资源初始化成功；'."\n" + ."\n" + .'- 应用性能监控，链路追踪OpenTelemetry以及用户体验监控需要单独进行资源初始化；', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateServiceObservability', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Workspace', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/service-observability/{#type}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + ], + 'CreateServiceRecord' => [ + 'path' => '/workspace/{workspace}/service/{serviceId}/record', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - ], + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'workspace-test'], ], [ - 'name' => 'group', - 'in' => 'query', + 'name' => 'serviceId', + 'in' => 'path', + 'schema' => ['description' => '服务ID', 'type' => 'string', 'required' => true, 'example' => 'em87vd@c2e25bcfe0e21ce0***'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'allowEmptyValue' => false, + 'style' => 'json', 'schema' => [ - 'description' => '公共Umodel Schema group', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'apm-common', + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'recordType' => [ + 'title' => '关联条目类型，目前支持:'."\n" + .'logCorrelation，标识应用日志关联', + 'description' => '关联条目类型，目前支持:'."\n" + .'logCorrelation，标识应用日志关联', + 'type' => 'string', + 'required' => true, + 'example' => 'logCorrelation', + 'enum' => ['logCorrelation'], + ], + 'recordContent' => ['title' => '条目内容，一般为JSON格式，不同的recordType的格式不同；'."\n" + .'当recordType=logCorreation时，recordContent的示例请求内容为：{"project":"proj-xtrace-16c988dcfe21fcb73c5e6f234927d998-cn-hangzhou","storeName":"app-biz-log","regionId":"cn-hangzhou","bindType":"logstore","traceIdRelateField":""}', 'description' => '条目内容，JSON字符串格式，不同的recordType的格式可能不同；', 'type' => 'string', 'required' => true, 'example' => '{'."\n" + .' "project": "proj-xtrace-16c988dcfe21fcb73c5e6f234927d998-cn-hangzhou",'."\n" + .' "storeName": "app-biz-log",'."\n" + .' "regionId": "cn-hangzhou",'."\n" + .' "bindType": "logstore",'."\n" + .' "traceIdRelateField": ""'."\n" + .'}'], + ], + 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建服务关联条目', + 'summary' => '创建服务关联条目，用于创建应用监控服务的关联配置，例如日志关联；', + 'extraInfo' => '当recordType=logCorrelation，支持两种日志绑定类型：'."\n" + .'bindType=logstore 标识日志存储'."\n" + .'bindType=storeview 标识storeview'."\n" + .'同时需要保证project, storeName对应的存储必须存在', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', - 'title' => '删除指定的公共Umodel Schema引用', ], - 'UpsertUmodelCommonSchemaRef' => [ - 'summary' => '更新引用的公共Umodel Schema。', - 'path' => '/workspace/{workspace}/umodel/common-schema-ref', - 'methods' => [ - 'patch', - ], - 'schemes' => [ - 'https', - ], + 'CreateTicket' => [ + 'summary' => '如果您需要将控制台页面免密分享给其他人或者嵌入到第三方系统，可以调用CreateTicket生成票据，然后拼接免密链接。', + 'path' => '/tickets', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'workspace', - 'in' => 'path', - 'schema' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - ], - ], - [ - 'name' => 'group', + 'name' => 'expirationTime', 'in' => 'query', - 'schema' => [ - 'description' => '公共Umodel Schema group', - 'type' => 'string', - 'required' => true, - 'example' => 'card-service-daily01', - ], + 'schema' => ['description' => '- 过期时间（秒），即内嵌页面URL链接过期时间，默认86400秒（一天），取值0~2592000秒（30天）。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '86400'], ], [ - 'name' => 'version', + 'name' => 'accessTokenExpirationTime', 'in' => 'query', - 'schema' => [ - 'description' => '版本号', - 'type' => 'string', - 'required' => true, - 'example' => '0.1.0', - ], + 'schema' => ['description' => '- 访问令牌过期时间（秒），即用户可以访问页面接口的过期时间，默认86400秒（一天），取值0~86400秒（一天）。'."\n" + .'- 访问令牌过期时间是accessTokenExpirationTime、expirationTime的最小值。'."\n" + .'- 若通过STS调用，访问令牌过期时间（即用户可以访问页面接口的时间）是accessTokenExpirationTime、expirationTime、STS过期时间的最小值。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '600'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '0B9377D9-C56B-5C2E-A8A4-************', - ], + 'ticket' => ['title' => 'Id of the request', 'description' => '免登录票据', 'type' => 'string', 'example' => 'eyJ***************.eyJ******************.KUT****************'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-************\\"\\n}","type":"json"}]', - 'title' => '引用指定的公共Umodel Schema', - ], - 'CreateChat' => [ - 'summary' => '创建对话。', - 'path' => '/chat', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建免登录票据', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTicket'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', - 'sse', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateTicket', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ticket\\": \\"eyJ***************.eyJ******************.KUT****************\\"\\n}","type":"json"}]', + ], + 'CreateUmodel' => [ + 'path' => '/workspace/{workspace}/umodel', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/octet-stream', - ], - 'produces' => [ - 'application/octet-stream', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'workspace-test'], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求结构体', + 'description' => '请求 Body', 'type' => 'object', 'properties' => [ - 'digitalEmployeeName' => [ - 'description' => '数字员工名称', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'threadId' => [ - 'description' => '会话线程ID', - 'type' => 'string', - 'required' => false, - 'example' => 'thread_id01', - ], - 'action' => [ - 'description' => '操作类型: create(默认), reconnect, stop', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'reconnect' => 'reconnect', - 'stop' => 'stop', - 'create' => 'create', - 'interact' => 'interact', - ], - 'example' => 'create', - ], - 'variables' => [ - 'description' => '变量列表', - 'type' => 'object', - 'required' => false, - 'example' => '{'."\n" - .' "workspace": "test",'."\n" - .' "region": "cn-beijing",'."\n" - .' "project": "test",'."\n" - .' "language": "zh",'."\n" - .' "timeZone": "Asia/Shanghai",'."\n" - .' "timeStamp": "1768893948",'."\n" - .' "startTime": 1768887171,'."\n" - .' "endTime": 1768890771,'."\n" - .' "skill": "trace"'."\n" - .'}', - ], - 'messages' => [ - 'description' => '消息列表', - 'type' => 'array', - 'items' => [ - 'description' => '消息', - 'type' => 'object', - 'properties' => [ - 'messageId' => [ - 'description' => '当前消息唯一标识', - 'type' => 'string', - 'required' => false, - 'example' => 'message_id02', - ], - 'role' => [ - 'description' => '消息的角色', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'system' => 'system', - 'assistant' => 'assistant', - 'user' => 'user', - 'tool' => 'tool', - ], - 'example' => 'system', - ], - 'contents' => [ - 'description' => '文本或多模态数组', - 'type' => 'array', - 'items' => [ - 'description' => '文本或多模态', - 'type' => 'object', - 'properties' => [ - 'type' => [ - 'description' => '内容类型', - 'type' => 'string', - 'required' => false, - 'example' => 'text', - ], - 'value' => [ - 'description' => '内容的值', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'tools' => [ - 'description' => '工具调用列表', - 'type' => 'array', - 'items' => [ - 'description' => '工具调用', - 'type' => 'object', - 'required' => false, - 'example' => '{'."\n" - .' "arguments": {'."\n" - .' "confidence": "high",'."\n" - .' "intent": "analyser",'."\n" - .' "is_new_turn": true,'."\n" - .' "language": "en",'."\n" - .' "title": "Root Cause of Alert"'."\n" - .' },'."\n" - .' "id": "IntentRecognition",'."\n" - .'}', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'description' => ['description' => 'Umodel描述', 'type' => 'string', 'required' => false, 'example' => 'workspace test'], ], 'required' => false, ], @@ -8086,1281 +7026,609 @@ 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'messages' => [ - 'title' => '会话的消息列表', - 'description' => '消息列表', - 'type' => 'array', - 'items' => [ - 'title' => '消息数据明细结构', - 'description' => '消息', - 'type' => 'object', - 'properties' => [ - 'version' => [ - 'title' => '消息版本号', - 'description' => '消息版本号', - 'type' => 'string', - 'example' => 'v0.1.0', - ], - 'parentCallId' => [ - 'title' => '上一层级执行ID', - 'description' => '父节点的调用 ID', - 'type' => 'string', - 'example' => 'sess_abc123', - ], - 'callId' => [ - 'title' => '当前执行ID', - 'description' => '当前节点的调用 ID', - 'type' => 'string', - 'example' => 'call_search_001', - ], - 'role' => [ - 'title' => '消息发起角色', - 'description' => '消息角色', - 'type' => 'string', - 'example' => 'tool', - ], - 'seq' => [ - 'title' => '消息序列号', - 'description' => '事件序列号，递增，用于保证事件顺序', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'timestamp' => [ - 'title' => 'timestamp / 纳秒', - 'description' => 'Unix 时间戳（秒）', - 'type' => 'string', - 'example' => '1765000005', - ], - 'type' => [ - 'title' => '消息具体类型', - 'description' => '特殊事件类型（如 done, error, heartbeat）', - 'type' => 'string', - 'example' => 'done', - ], - 'detail' => [ - 'title' => '消息明细', - 'description' => '详细信息（如工具进度描述）', - 'type' => 'string', - 'example' => 'test', - ], - 'contents' => [ - 'title' => '内容信息', - 'description' => '消息内容数组', - 'type' => 'array', - 'items' => [ - 'title' => '内容信息明细结构', - 'description' => '消息内容', - 'type' => 'object', - 'example' => '{'."\n" - .' "append": false,'."\n" - .' "lastChunk": false,'."\n" - .' "type": "text",'."\n" - .' "value": "result output chunk"'."\n" - .'}', - ], - ], - 'tools' => [ - 'title' => '工具使用列表', - 'description' => '工具调用数组', - 'type' => 'array', - 'items' => [ - 'title' => '工具明细结构', - 'description' => '工具调用', - 'type' => 'object', - 'example' => "\n" - .'{'."\n" - .' "arguments": {'."\n" - .' "confidence": "high",'."\n" - .' "intent": "analyser",'."\n" - .' "is_new_turn": true,'."\n" - .' "language": "en",'."\n" - .' "title": "Root Cause of Alert"'."\n" - .' },'."\n" - .' "id": "IntentRecognition",'."\n" - .' "name": "IntentRecognition",'."\n" - .' "status": "start",'."\n" - .' "toolCallId": "019bc1cb-adad"'."\n" - .'}', - ], - ], - 'agents' => [ - 'title' => '调用的Agent列表', - 'description' => '智能体列表', - 'type' => 'array', - 'items' => [ - 'title' => '调用的Agent详细内容', - 'description' => '智能体', - 'type' => 'object', - 'example' => '{'."\n" - .' "callId": "019bc1cb-adad",'."\n" - .' "id": "analyser",'."\n" - .' "inputs": ['."\n" - .' {'."\n" - .' "append": false,'."\n" - .' "lastChunk": false,'."\n" - .' "type": "text",'."\n" - .' "value": "Analyze this trace: TraceID=xxx"'."\n" - .' }'."\n" - .' ],'."\n" - .' "name": "analyser",'."\n" - .' "status": "start"'."\n" - .'}', - ], - ], - 'events' => [ - 'title' => '事件列表', - 'description' => '事件列表', - 'type' => 'array', - 'items' => [ - 'title' => '事件详细内容', - 'description' => '事件详细内容', - 'type' => 'object', - 'example' => '{'."\n" - .' "payload": {'."\n" - .' "error": {'."\n" - .' "code": "TASK_FAILED",'."\n" - .' "message": "Invalid task parameter",'."\n" - .' "suggestion": ""'."\n" - .' },'."\n" - .' "statistics": {'."\n" - .' "duration": 300000'."\n" - .' },'."\n" - .' "success": false'."\n" - .' },'."\n" - .' "type": "task_finished"'."\n" - .'}', - ], - ], - 'artifacts' => [ - 'title' => '产物产出信息', - 'description' => '产物产出信息', - 'type' => 'array', - 'items' => [ - 'title' => '产物明细的结构', - 'description' => '产物明细的结构', - 'type' => 'object', - 'example' => '{'."\n" - .' "artifactId": "019bc1cb-9600-703axxx",'."\n" - .' "name": "sql output",'."\n" - .' "description": "sql generation task result",'."\n" - .' "extensions": ["sql_generation_tool", "sql_diagnosis"],'."\n" - .' "metadata": {'."\n" - .' "model": "qwen3-coder-plus"'."\n" - .' },'."\n" - .' "parts": ['."\n" - .' {'."\n" - .' "text": "select * from table",'."\n" - .' "kind": "text"'."\n" - .' }'."\n" - .' ]'."\n" - .'}', - ], - ], - ], - ], - ], - 'traceId' => [ - 'title' => '当前message请求的id数据'."\n" - .'根数据中第一个追踪ID', - 'description' => '跟踪请求全局的标识符', - 'type' => 'string', - 'example' => '21504600000008405622576e3b48', - ], - 'requestId' => [ - 'title' => '当前message请求的id数据'."\n" - .'根数据中第一个RequestID', - 'description' => '请求唯一标识', - 'type' => 'string', - 'example' => '0CEC5375-XXXX-XXXX-XXXX-9A629907C1F0', - ], + 'requestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '123-0F43-23423-AC43-34234'], + 'workspace' => ['description' => '工作空间名称。', 'type' => 'string', 'example' => 'workspace-test'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建 Umodel', + 'summary' => '创建Umodel配置。', + 'description' => '在指定工作空间里创建 Umodel配置', + 'changeSet' => [ + ['createdAt' => '2025-08-12T02:41:41.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"messages\\": [\\n {\\n \\"version\\": \\"v0.1.0\\",\\n \\"parentCallId\\": \\"sess_abc123\\",\\n \\"callId\\": \\"call_search_001\\",\\n \\"role\\": \\"tool\\",\\n \\"seq\\": 1,\\n \\"timestamp\\": \\"1765000005\\",\\n \\"type\\": \\"done\\",\\n \\"detail\\": \\"test\\",\\n \\"contents\\": [\\n {\\n \\"append\\": false,\\n \\"lastChunk\\": false,\\n \\"type\\": \\"text\\",\\n \\"value\\": \\"result output chunk\\"\\n }\\n ],\\n \\"tools\\": [\\n {\\n \\"arguments\\": {\\n \\"confidence\\": \\"high\\",\\n \\"intent\\": \\"analyser\\",\\n \\"is_new_turn\\": true,\\n \\"language\\": \\"en\\",\\n \\"title\\": \\"Root Cause of Alert\\"\\n },\\n \\"id\\": \\"IntentRecognition\\",\\n \\"name\\": \\"IntentRecognition\\",\\n \\"status\\": \\"start\\",\\n \\"toolCallId\\": \\"019bc1cb-adad\\"\\n }\\n ],\\n \\"agents\\": [\\n {\\n \\"callId\\": \\"019bc1cb-adad\\",\\n \\"id\\": \\"analyser\\",\\n \\"inputs\\": [\\n {\\n \\"append\\": false,\\n \\"lastChunk\\": false,\\n \\"type\\": \\"text\\",\\n \\"value\\": \\"Analyze this trace: TraceID=xxx\\"\\n }\\n ],\\n \\"name\\": \\"analyser\\",\\n \\"status\\": \\"start\\"\\n }\\n ],\\n \\"events\\": [\\n {\\n \\"payload\\": {\\n \\"error\\": {\\n \\"code\\": \\"TASK_FAILED\\",\\n \\"message\\": \\"Invalid task parameter\\",\\n \\"suggestion\\": \\"\\"\\n },\\n \\"statistics\\": {\\n \\"duration\\": 300000\\n },\\n \\"success\\": false\\n },\\n \\"type\\": \\"task_finished\\"\\n }\\n ],\\n \\"artifacts\\": [\\n {\\n \\"artifactId\\": \\"019bc1cb-9600-703axxx\\",\\n \\"name\\": \\"sql output\\",\\n \\"description\\": \\"sql generation task result\\",\\n \\"extensions\\": [\\n \\"sql_generation_tool\\",\\n \\"sql_diagnosis\\"\\n ],\\n \\"metadata\\": {\\n \\"model\\": \\"qwen3-coder-plus\\"\\n },\\n \\"parts\\": [\\n {\\n \\"text\\": \\"select * from table\\",\\n \\"kind\\": \\"text\\"\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"traceId\\": \\"21504600000008405622576e3b48\\",\\n \\"requestId\\": \\"0CEC5375-XXXX-XXXX-XXXX-9A629907C1F0\\"\\n}","type":"json"}]', - 'title' => '发起会话', - 'description' => '用于创建一个站点监控任务', - ], - 'CreateDigitalEmployee' => [ - 'summary' => '创建DigitalEmployee。', - 'path' => '/digital-employee', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUmodel'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateUmodel', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Umodel', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/umodel'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"123-0F43-23423-AC43-34234\\",\\n \\"workspace\\": \\"workspace-test\\"\\n}","type":"json"}]', + ], + 'DeleteAddonRelease' => [ + 'path' => '/integration-policies/{policyId}/addon-releases', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'releaseName', + 'in' => 'query', + 'schema' => ['title' => 'AddonRelease 的名称。', 'description' => 'AddonRelease 的名称。', 'type' => 'string', 'required' => false, 'example' => 'test-gpu-integration-name'], + ], + [ + 'name' => 'force', + 'in' => 'query', 'schema' => [ - 'description' => '数字员工结构', - 'type' => 'object', - 'properties' => [ - 'defaultRule' => [ - 'description' => '默认规则', - 'type' => 'string', - 'deprecated' => false, - 'required' => false, - 'example' => 'test', - 'pattern' => '', - 'readOnly' => false, - 'default' => '', - ], - 'description' => [ - 'description' => '数字员工描述信息', - 'type' => 'string', - 'deprecated' => false, - 'required' => false, - 'example' => 'aaa', - 'pattern' => '', - 'readOnly' => false, - 'default' => '', - ], - 'displayName' => [ - 'description' => '数字员工显示名称', - 'type' => 'string', - 'deprecated' => false, - 'required' => false, - 'example' => 'digial-employee-test', - 'maxLength' => 128, - 'minLength' => 0, - 'pattern' => '', - 'readOnly' => false, - 'default' => '', - ], - 'roleArn' => [ - 'description' => '角色ARN', - 'type' => 'string', - 'deprecated' => false, - 'required' => true, - 'example' => 'acs:ram::12345678912:role/testrole', - 'pattern' => '', - 'readOnly' => false, - 'default' => '', - ], - 'name' => [ - 'description' => '数字员工名称', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - 'knowledges' => [ - 'description' => '知识库列表', - 'type' => 'object', - 'properties' => [ - 'bailian' => [ - 'description' => '百练知识库列表', - 'type' => 'array', - 'items' => [ - 'description' => '百练知识库', - 'type' => 'object', - 'properties' => [ - 'workspaceId' => [ - 'description' => '百练工作空间 ID', - 'type' => 'string', - 'required' => false, - 'example' => 'llm-xxxxx', - ], - 'indexId' => [ - 'description' => '百练索引 ID', - 'type' => 'string', - 'required' => false, - 'example' => 'index-xxxx', - ], - 'region' => [ - 'description' => '百练知识库地域', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], - 'attributes' => [ - 'description' => '知识库属性', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'sop' => [ - 'description' => 'SOP知识库列表', - 'type' => 'array', - 'items' => [ - 'description' => 'SOP 知识库', - 'type' => 'object', - 'required' => false, - 'example' => ' {'."\n" - .' "type": "oss",'."\n" - .' "basePath": "docs/",'."\n" - .' "region": "cn-hangzhou",'."\n" - .' "endpoint": "oss-cn-hangzhou.aliyuncs.com",'."\n" - .' "bucket": "my-sop-bucket",'."\n" - .' "description": "sls sop"'."\n" - .' }', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'resourceGroupId' => [ - 'title' => '资源组 ID', - 'description' => '资源组ID', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-ae******ey', - ], - 'tags' => [ - 'title' => '标签', - 'description' => '标签', - 'type' => 'array', - 'items' => [ - 'title' => '标签', - 'description' => '标签', - 'required' => false, - '$ref' => '#/components/schemas/Tag', - ], - 'required' => false, - ], - ], + 'title' => '是否硬性删除，默认 false。', + 'description' => '是否硬性删除，默认 false。', + 'type' => 'boolean', 'required' => false, + 'enumValueTitles' => ['true' => '是', 'false' => '否'], + 'example' => 'false', ], ], + [ + 'name' => 'policyId', + 'in' => 'path', + 'schema' => ['title' => '环境 ID。', 'description' => '环境 ID。', 'type' => 'string', 'required' => true, 'example' => 'policy-xxxxxxxxxxxxx'], + ], + [ + 'name' => 'addonName', + 'in' => 'query', + 'schema' => ['title' => 'Addon 名称，当 AddonName 赋值时，将忽略 ReleaseName 参数批量卸载所属于同一个 Addon 的所有 AddonRelease。', 'description' => 'Addon 名称。当 AddonName 赋值时，将忽略 ReleaseName 参数批量卸载所属于同一个 Addon 的所有 AddonRelease。', 'type' => 'string', 'required' => false, 'example' => 'cs-gpu'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '3B311FD9-A60B-55E0-A896-A0C73*********', - ], - 'name' => [ - 'description' => '数字员工名称', - 'type' => 'string', - 'example' => 'test', - ], + 'requestId' => ['title' => '请求 ID。', 'description' => '请求 ID', 'type' => 'string', 'example' => '264C3E89-BE6E-5F82-A484-CE9C2196C7DC'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3B311FD9-A60B-55E0-A896-A0C73*********\\",\\n \\"name\\": \\"test\\"\\n}","type":"json"}]', - 'title' => '创建数字员工', - 'description' => '用于创建一个站点监控任务', - ], - 'GetDigitalEmployee' => [ - 'summary' => '查询 DigitalEmployee。', - 'path' => '/digital-employee/{name}', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '卸载接入组件', + 'summary' => '删除addon release信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAddonRelease'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteAddonRelease', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'AddonRelease', 'arn' => 'acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#PolicyId}/addonrelease/*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-BE6E-5F82-A484-CE9C2196C7DC\\"\\n}","type":"json"}]', + ], + 'DeleteAggTaskGroup' => [ + 'path' => '/prometheus-instances/{instanceId}/agg-task-groups/{groupId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'name', + 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => '数字员工名称', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['title' => '聚合任务组所属的 Prometheus 实例的 id，聚合任务从这个实例中读取数据', 'description' => '聚合任务组所属的 Prometheus 实例ID，聚合任务从这个实例中读取数据。', 'type' => 'string', 'required' => true, 'example' => 'rw-pq4apob9jm'], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => ['title' => '聚合任务组 id', 'description' => '聚合任务组ID。', 'type' => 'string', 'required' => true, 'example' => 'aggTaskGroup-xxx'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '出参结构体', + 'description' => '出参结构体。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '0B9377D9-C56B-5C2E-A8A4-************', - ], - 'name' => [ - 'description' => '数字员工名称', - 'type' => 'string', - 'example' => 'test', - ], - 'defaultRule' => [ - 'description' => '默认规则', - 'type' => 'string', - 'deprecated' => false, - 'example' => 'test', - 'pattern' => '', - 'readOnly' => false, - 'default' => '', - ], - 'description' => [ - 'description' => '数字员工描述信息', - 'type' => 'string', - 'deprecated' => false, - 'example' => 'test', - 'pattern' => '', - 'readOnly' => false, - 'default' => '', - ], - 'createTime' => [ - 'description' => '创建时间', - 'type' => 'string', - 'format' => 'iso8601_normal', - 'deprecated' => false, - 'example' => '2025-03-11T08:21:58Z', - 'pattern' => '', - 'default' => '', - ], - 'displayName' => [ - 'description' => '数字员工显示名称', - 'type' => 'string', - 'deprecated' => false, - 'example' => 'test', - 'maxLength' => 128, - 'minLength' => 0, - 'pattern' => '', - 'readOnly' => false, - 'default' => '', - ], - 'updateTime' => [ - 'description' => '更新时间', - 'type' => 'string', - 'format' => 'iso8601_normal', - 'deprecated' => false, - 'example' => '2025-02-18T02:25:06Z', - 'pattern' => '', - 'default' => '', - ], - 'roleArn' => [ - 'description' => '角色ARN', - 'type' => 'string', - 'deprecated' => false, - 'example' => 'acs:ram::12345678912:role/testrole', - 'pattern' => '', - 'readOnly' => false, - 'default' => '', - ], - 'regionId' => [ - 'description' => '区域 ID', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'knowledges' => [ - 'description' => '知识库列表', - 'type' => 'object', - 'properties' => [ - 'bailian' => [ - 'description' => '百练知识库列表', - 'type' => 'array', - 'items' => [ - 'description' => '百练知识库列表', - 'type' => 'object', - 'properties' => [ - 'workspaceId' => [ - 'description' => '百练工作空间 ID', - 'type' => 'string', - 'example' => 'llm-xxxxx', - ], - 'indexId' => [ - 'description' => '百练索引 ID', - 'type' => 'string', - 'example' => 'index-xxxx', - ], - 'region' => [ - 'description' => '百练知识库地域', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'attributes' => [ - 'description' => '知识库属性', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], - 'sop' => [ - 'description' => 'SOP 知识库列表', - 'type' => 'array', - 'items' => [ - 'description' => 'SOP 知识库', - 'type' => 'object', - 'example' => ' {'."\n" - .' "type": "oss",'."\n" - .' "basePath": "docs/",'."\n" - .' "region": "cn-hangzhou",'."\n" - .' "endpoint": "oss-cn-hangzhou.aliyuncs.com",'."\n" - .' "bucket": "my-sop-bucket",'."\n" - .' "description": "sls sop"'."\n" - .' }', - ], - ], - ], - ], - 'employeeType' => [ - 'description' => '数字员工类型', - 'type' => 'string', - 'example' => 'custom', - ], - 'tags' => [ - 'title' => '标签', - 'description' => '标签', - 'type' => 'array', - 'items' => [ - 'title' => '标签', - 'description' => '标签', - '$ref' => '#/components/schemas/Tag', - ], - ], - 'resourceGroupId' => [ - 'title' => '资源组 ID', - 'description' => '资源组 ID', - 'type' => 'string', - 'example' => 'rg-ae******ey', - ], + 'requestId' => ['title' => '请求 id', 'description' => '请求ID。', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], ], ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDigitalEmployee.NotFound', - 'errorMessage' => 'The specified DigitalEmployee does not exist.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除聚合任务组', + 'summary' => '删除聚合任务组。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAggTaskGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteAggTaskGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'AggTaskGroup', 'arn' => 'acs:cms:{#regionId}:{#accountId}:prometheusinstance/{#sourcePrometheusId}/aggtaskgroup/{#aggTaskGroupId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-************\\",\\n \\"name\\": \\"test\\",\\n \\"defaultRule\\": \\"test\\",\\n \\"description\\": \\"test\\",\\n \\"createTime\\": \\"2025-03-11T08:21:58Z\\",\\n \\"displayName\\": \\"test\\",\\n \\"updateTime\\": \\"2025-02-18T02:25:06Z\\",\\n \\"roleArn\\": \\"acs:ram::12345678912:role/testrole\\",\\n \\"regionId\\": \\"cn-beijing\\",\\n \\"knowledges\\": {\\n \\"bailian\\": [\\n {\\n \\"workspaceId\\": \\"llm-xxxxx\\",\\n \\"indexId\\": \\"index-xxxx\\",\\n \\"region\\": \\"cn-beijing\\",\\n \\"attributes\\": \\"test\\"\\n }\\n ],\\n \\"sop\\": [\\n {\\n \\"type\\": \\"oss\\",\\n \\"basePath\\": \\"docs/\\",\\n \\"region\\": \\"cn-hangzhou\\",\\n \\"endpoint\\": \\"oss-cn-hangzhou.aliyuncs.com\\",\\n \\"bucket\\": \\"my-sop-bucket\\",\\n \\"description\\": \\"sls sop\\"\\n }\\n ]\\n },\\n \\"employeeType\\": \\"custom\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"test-key\\",\\n \\"value\\": \\"test-value\\"\\n }\\n ],\\n \\"resourceGroupId\\": \\"rg-ae******ey\\"\\n}","type":"json"}]', - 'title' => '获取数字员工', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', ], - 'UpdateDigitalEmployee' => [ - 'summary' => '更新UpdateDigitalEmployee。', - 'path' => '/digital-employee/{name}', - 'methods' => [ - 'patch', - ], - 'schemes' => [ - 'https', - ], + 'DeleteAlertWebhooks' => [ + 'path' => '/webhooks', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'name', - 'in' => 'path', + 'name' => 'webhookIds', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '数字员工名称', - 'type' => 'string', + 'description' => 'webhook唯一标识。', + 'type' => 'array', + 'items' => ['description' => 'webhook唯一标识。', 'type' => 'string', 'required' => false, 'example' => 'test'], 'required' => true, - 'example' => 'test', ], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '数字员工结构', + 'title' => 'Schema of Response', + 'description' => '响应内容结构', 'type' => 'object', 'properties' => [ - 'defaultRule' => [ - 'description' => '默认规则', - 'type' => 'string', - 'deprecated' => false, - 'required' => false, - 'example' => 'test', - 'pattern' => '', - 'readOnly' => false, - 'default' => '', - ], - 'description' => [ - 'description' => '描述信息', - 'type' => 'string', - 'deprecated' => false, - 'required' => false, - 'example' => 'test', - 'pattern' => '', - 'readOnly' => false, - 'default' => '', - ], - 'displayName' => [ - 'description' => '数字员工显示名称', - 'type' => 'string', - 'deprecated' => false, - 'required' => false, - 'example' => 'test', - 'maxLength' => 128, - 'minLength' => 0, - 'pattern' => '', - 'readOnly' => false, - 'default' => '', - ], - 'roleArn' => [ - 'description' => '角色ARN', - 'type' => 'string', - 'deprecated' => false, - 'required' => false, - 'example' => 'acs:ram::12345678912:role/testrole', - 'pattern' => '', - 'readOnly' => false, - 'default' => '', - ], - 'knowledges' => [ - 'description' => '知识库列表', - 'type' => 'object', - 'properties' => [ - 'bailian' => [ - 'description' => '百练知识库列表', - 'type' => 'array', - 'items' => [ - 'description' => '百练知识库列表', - 'type' => 'object', - 'properties' => [ - 'workspaceId' => [ - 'description' => '百练工作空间 ID', - 'type' => 'string', - 'required' => false, - 'example' => 'llm-xxxx', - ], - 'indexId' => [ - 'description' => '百练索引 ID', - 'type' => 'string', - 'required' => false, - 'example' => 'index-xxxx', - ], - 'region' => [ - 'description' => '百练知识库地域', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], - 'attributes' => [ - 'description' => '知识库属性', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'sop' => [ - 'description' => 'SOP 知识库列表', - 'type' => 'array', - 'items' => [ - 'description' => 'SOP 知识库', - 'type' => 'object', - 'required' => false, - 'example' => ' {'."\n" - .' "type": "oss",'."\n" - .' "basePath": "docs/",'."\n" - .' "region": "cn-hangzhou",'."\n" - .' "endpoint": "oss-cn-hangzhou.aliyuncs.com",'."\n" - .' "bucket": "my-sop-bucket",'."\n" - .' "description": "sls sop"'."\n" - .' }', - ], - 'required' => false, - ], - ], - 'required' => false, - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'E5B1D3D4-BB28-5996-8AD2-***********'], ], - 'required' => false, ], ], ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.', 'description' => '参数%s缺失或不合法。'], + ], + 500 => [ + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => '服务运行错误。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除报警webhook', + 'summary' => '删除Webhook', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E5B1D3D4-BB28-5996-8AD2-***********\\"\\n}","type":"json"}]', + ], + 'DeleteBizTrace' => [ + 'path' => '/bizTrace/{bizTraceId}', + 'methods' => ['delete'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'bizTraceId', + 'in' => 'path', + 'schema' => ['description' => '业务链路id', 'type' => 'string', 'required' => false, 'example' => 'e339260ed64c95d'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-***', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求 ID', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-***\\"\\n}","type":"json"}]', - 'title' => '更新数字员工', - ], - 'ListDigitalEmployees' => [ - 'summary' => '列出资源DigitalEmployee。', - 'path' => '/digital-employee', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除业务链路', + 'summary' => '删除业务链路', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + ], + 'DeleteCloudResource' => [ + 'path' => '/cloudresource', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + ], + 'description' => '', + ], + ], ], - 'produces' => [ - 'application/json', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除云资源中心', + 'summary' => '删除云资源中心', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', + ], + 'DeleteContext' => [ + 'path' => '/workspace/{workspace}/contextstore/{contextStoreName}/context/{contextId}', + 'methods' => ['delete'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'maxResults', - 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => '分页大小'."\n" - .'默认值:'."\n" - .' 20'."\n" - .'最大值:'."\n" - .' 100', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '10', - ], + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'maxLength' => 64, 'minLength' => 2], ], [ - 'name' => 'nextToken', - 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => '下一次查询的令牌。', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxxx', - ], + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => '上下文库名称', 'type' => 'string', 'required' => true, 'example' => 'test-context-store', 'maxLength' => 64, 'minLength' => 2], ], [ - 'name' => 'name', - 'in' => 'query', - 'schema' => [ - 'description' => '数字员工名称', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'name' => 'contextId', + 'in' => 'path', + 'schema' => ['description' => '写入生成的记录 ID 或事件 ID', 'type' => 'string', 'required' => true, 'example' => '897294a7-67a4-4f60-976c-e136edc5f97e', 'minLength' => 1], ], - [ - 'name' => 'employeeType', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '数字员工类型', - 'type' => 'string', - 'required' => false, - 'example' => 'custom', - 'enum' => [ - 'system', - 'custom', + 'description' => '响应数据', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => 'E5B1D3D4-BB28-5996-8AD2-***********'], + 'contextId' => ['description' => '写入生成的记录 ID 或事件 ID', 'type' => 'string', 'example' => '897294a7-67a4-4f60-976c-e136edc5f97e'], + 'status' => ['description' => '删除状态，例如 deleted', 'type' => 'string', 'example' => 'deleted'], ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除上下文', + 'summary' => '删除上下文', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E5B1D3D4-BB28-5996-8AD2-***********\\",\\n \\"contextId\\": \\"897294a7-67a4-4f60-976c-e136edc5f97e\\",\\n \\"status\\": \\"deleted\\"\\n}","type":"json"}]', + ], + 'DeleteContextStore' => [ + 'summary' => '删除上下文库', + 'path' => '/workspace/{workspace}/contextstore/{contextStoreName}', + 'methods' => ['delete'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'displayName', - 'in' => 'query', - 'schema' => [ - 'description' => '数字员工显示名称', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'tags', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '标签', - 'description' => '标签', - 'type' => 'array', - 'items' => [ - 'title' => '标签', - 'description' => '标签', - 'required' => false, - '$ref' => '#/components/schemas/Tag', - ], - 'required' => false, - ], + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'maxLength' => 64, 'minLength' => 2], ], [ - 'name' => 'resourceGroupId', - 'in' => 'query', - 'schema' => [ - 'title' => '资源组 ID', - 'description' => '资源组 ID', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-ae******ey', - ], + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => '上下文库名称', 'type' => 'string', 'required' => true, 'example' => 'test-context-store', 'maxLength' => 64, 'minLength' => 2], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '响应数据', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], - 'nextToken' => [ - 'description' => '下一次查询的令牌。', - 'type' => 'string', - 'example' => 'xxxxx', - ], - 'total' => [ - 'description' => '总记录数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '56', - ], - 'maxResults' => [ - 'description' => '最大返回结果数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'digitalEmployees' => [ - 'description' => '数字员工列表', - 'type' => 'array', - 'items' => [ - 'description' => '数字员工', - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'description' => '数字员工名称', - 'type' => 'string', - 'example' => 'test', - ], - 'defaultRule' => [ - 'description' => '默认规则', - 'type' => 'string', - 'deprecated' => false, - 'example' => 'test', - 'pattern' => '', - 'readOnly' => false, - 'default' => '', - ], - 'description' => [ - 'description' => '描述信息', - 'type' => 'string', - 'deprecated' => false, - 'example' => 'test', - 'pattern' => '', - 'readOnly' => false, - 'default' => '', - ], - 'createTime' => [ - 'description' => '创建时间', - 'type' => 'string', - 'format' => 'iso8601_normal', - 'deprecated' => false, - 'example' => '2025-11-04T08:08:57Z', - 'pattern' => '', - 'default' => '', - ], - 'displayName' => [ - 'description' => '数字员工显示名称', - 'type' => 'string', - 'deprecated' => false, - 'example' => 'test', - 'maxLength' => 128, - 'minLength' => 0, - 'pattern' => '', - 'readOnly' => false, - 'default' => '', - ], - 'updateTime' => [ - 'description' => '更新时间', - 'type' => 'string', - 'format' => 'iso8601_normal', - 'deprecated' => false, - 'example' => '2025-05-07T02:26:01Z', - 'pattern' => '', - 'default' => '', - ], - 'roleArn' => [ - 'description' => '角色ARN', - 'type' => 'string', - 'deprecated' => false, - 'example' => 'acs:ram::12345678912:role/testrole', - 'pattern' => '', - 'readOnly' => false, - 'default' => '', - ], - 'knowledges' => [ - 'description' => '知识库列表', - 'type' => 'object', - 'properties' => [ - 'bailian' => [ - 'description' => '百练知识库列表', - 'type' => 'array', - 'items' => [ - 'description' => '百练知识库', - 'type' => 'object', - 'properties' => [ - 'workspaceId' => [ - 'description' => '百练工作空间 ID', - 'type' => 'string', - 'example' => 'llm-xxxx', - ], - 'indexId' => [ - 'description' => '百练索引 ID', - 'type' => 'string', - 'example' => 'index-xxxx', - ], - 'region' => [ - 'description' => '百练知识库地域', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'attributes' => [ - 'description' => '知识库属性', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], - 'sop' => [ - 'description' => 'SOP 知识库列表', - 'type' => 'array', - 'items' => [ - 'description' => 'SOP 知识库', - 'type' => 'object', - 'example' => ' {'."\n" - .' "type": "oss",'."\n" - .' "basePath": "docs/",'."\n" - .' "region": "cn-hangzhou",'."\n" - .' "endpoint": "oss-cn-hangzhou.aliyuncs.com",'."\n" - .' "bucket": "my-sop-bucket",'."\n" - .' "description": "sls sop"'."\n" - .' }', - ], - ], - ], - ], - 'employeeType' => [ - 'description' => '数字员工类型', - 'type' => 'string', - 'example' => 'custom', - ], - 'resourceGroupId' => [ - 'title' => '资源组 ID', - 'description' => '资源组 ID', - 'type' => 'string', - 'example' => 'rg-ae******ey', - ], - 'tags' => [ - 'title' => '标签', - 'description' => '标签', - 'type' => 'array', - 'items' => [ - 'title' => '标签', - 'description' => '标签', - '$ref' => '#/components/schemas/Tag', - ], - ], - ], - ], - ], + 'requestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"nextToken\\": \\"xxxxx\\",\\n \\"total\\": 56,\\n \\"maxResults\\": 10,\\n \\"digitalEmployees\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"defaultRule\\": \\"test\\",\\n \\"description\\": \\"test\\",\\n \\"createTime\\": \\"2025-11-04T08:08:57Z\\",\\n \\"displayName\\": \\"test\\",\\n \\"updateTime\\": \\"2025-05-07T02:26:01Z\\",\\n \\"roleArn\\": \\"acs:ram::12345678912:role/testrole\\",\\n \\"knowledges\\": {\\n \\"bailian\\": [\\n {\\n \\"workspaceId\\": \\"llm-xxxx\\",\\n \\"indexId\\": \\"index-xxxx\\",\\n \\"region\\": \\"cn-beijing\\",\\n \\"attributes\\": \\"test\\"\\n }\\n ],\\n \\"sop\\": [\\n {\\n \\"type\\": \\"oss\\",\\n \\"basePath\\": \\"docs/\\",\\n \\"region\\": \\"cn-hangzhou\\",\\n \\"endpoint\\": \\"oss-cn-hangzhou.aliyuncs.com\\",\\n \\"bucket\\": \\"my-sop-bucket\\",\\n \\"description\\": \\"sls sop\\"\\n }\\n ]\\n },\\n \\"employeeType\\": \\"custom\\",\\n \\"resourceGroupId\\": \\"rg-ae******ey\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"test-key\\",\\n \\"value\\": \\"test-value\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', - 'title' => '列出数字员工', - ], - 'DeleteDigitalEmployee' => [ - 'summary' => '删除DigitalEmployee。', - 'path' => '/digital-employee/{name}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除上下文库', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + ], + 'DeleteContextStoreAPIKey' => [ + 'path' => '/workspace/{workspace}/contextstore/{contextStoreName}/apikey/{name}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => false, 'example' => 'workspace-test'], + ], + [ + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => '上下文库名称', 'type' => 'string', 'required' => false, 'example' => 'test-context-store'], + ], + [ 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'description' => '数字员工名称', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'API Key 的显示名称，用于标识用途', 'type' => 'string', 'required' => false, 'example' => 'Production Service Key'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应数据', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求Id', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', - 'title' => '删除数字员工', - ], - 'CreateThread' => [ - 'summary' => '创建会话。', - 'path' => '/digitalEmployee/{name}/thread', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除 API Key', + 'summary' => '删除 API Key', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', + ], + 'DeleteContexts' => [ + 'path' => '/workspace/{workspace}/contextstore/{contextStoreName}/context', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'name', + 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'description' => '数字员工名称', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'maxLength' => 64, 'minLength' => 2], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['title' => 'ContextStore名称，仅支持通过路径参数指定', 'description' => 'ContextStore名称，仅支持通过路径参数指定', 'type' => 'string', 'required' => true, 'example' => 'test-context-store', 'maxLength' => 64, 'minLength' => 2], + ], + [ + 'name' => 'contextIds', + 'in' => 'query', + 'schema' => ['title' => '逗号分隔的 context ID 列表，仅支持通过 query 参数指定', 'description' => '逗号分隔的 context ID 列表，仅支持通过 query 参数指定', 'type' => 'string', 'required' => false, 'example' => 'mem_long_01,mem_long_02'], + ], + [ + 'name' => 'filter', + 'in' => 'query', + 'schema' => ['title' => '过滤条件，语法同 SearchContext.filter，通过 query 中的 JSON 字符串传递', 'description' => '过滤条件，语法同 SearchContext.filter，通过 query 中的 JSON 字符串传递', 'type' => 'string', 'required' => false, 'example' => '{"userId":"u-10001"}'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '请求body。', 'type' => 'object', 'properties' => [ - 'title' => [ - 'description' => '会话标题', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'variables' => [ - 'description' => '会话属性', - 'type' => 'object', - 'properties' => [ - 'workspace' => [ - 'description' => '工作空间名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'workspace', - ], - 'project' => [ - 'description' => '日志服务项目名称', - 'type' => 'string', - 'required' => false, - 'example' => 'project', - ], - ], - 'required' => false, - ], + 'requestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'deletedCount' => ['description' => '成功删除数量', 'type' => 'integer', 'format' => 'int32', 'example' => '55'], ], - 'required' => false, + 'description' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '批量删除上下文', + 'summary' => '批量删除上下文', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"deletedCount\\": 55\\n}","type":"json"}]', + ], + 'DeleteDataset' => [ + 'summary' => '删除数据集', + 'path' => '/workspace/{workspace}/dataset/{datasetName}', + 'methods' => ['delete'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'maxLength' => 64, 'minLength' => 2], + ], + [ + 'name' => 'datasetName', + 'in' => 'path', + 'schema' => ['description' => '数据集名称', 'type' => 'string', 'required' => true, 'example' => 'test_dataset', 'maxLength' => 64, 'minLength' => 2], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '响应数据', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], - 'threadId' => [ - 'description' => '会话 id', - 'type' => 'string', - 'example' => 'thread_id01', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求 Id', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除数据集', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"threadId\\": \\"thread_id01\\"\\n}","type":"json"}]', - 'title' => '创建会话', - 'description' => '用于创建一个会话', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', ], - 'GetThread' => [ - 'summary' => '获取会话。', - 'path' => '/digitalEmployee/{name}/thread/{threadId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DeleteDeliveryTask' => [ + 'summary' => '删除数据投递任务', + 'path' => '/delivery-task/{taskId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'name', + 'name' => 'taskId', 'in' => 'path', - 'schema' => [ - 'description' => '数字员工名称', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - ], - [ - 'name' => 'threadId', - 'in' => 'path', - 'schema' => [ - 'description' => '会话 id', - 'type' => 'string', - 'required' => true, - 'example' => 'thread_id01', - ], + 'schema' => ['description' => '投递任务 ID', 'type' => 'string', 'required' => true, 'example' => '98e367d8fb8cc83b'], ], ], 'responses' => [ @@ -9370,894 +7638,454 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], - 'threadId' => [ - 'description' => '会话 id', - 'type' => 'string', - 'example' => 'thread_id01', - ], - 'digitalEmployeeName' => [ - 'description' => '数字员工名称', - 'type' => 'string', - 'example' => 'test', - ], - 'title' => [ - 'description' => '会话标题', - 'type' => 'string', - 'example' => 'testLive', - ], - 'status' => [ - 'description' => '会话状态', - 'type' => 'string', - 'example' => 'active', - ], - 'version' => [ - 'description' => '版本', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1231', - ], - 'createTime' => [ - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2025-12-19T15:19:55.040403272+08:00', - ], - 'updateTime' => [ - 'description' => '更新时间', - 'type' => 'string', - 'example' => '2025-12-19T15:19:55.040403272+08:00', - ], - 'variables' => [ - 'description' => '会话属性', - 'type' => 'object', - 'properties' => [ - 'workspace' => [ - 'description' => '工作空间名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'project' => [ - 'description' => 'SLS 项目名称', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除数据投递任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"threadId\\": \\"thread_id01\\",\\n \\"digitalEmployeeName\\": \\"test\\",\\n \\"title\\": \\"testLive\\",\\n \\"status\\": \\"active\\",\\n \\"version\\": 1231,\\n \\"createTime\\": \\"2025-12-19T15:19:55.040403272+08:00\\",\\n \\"updateTime\\": \\"2025-12-19T15:19:55.040403272+08:00\\",\\n \\"variables\\": {\\n \\"workspace\\": \\"test\\",\\n \\"project\\": \\"test\\"\\n }\\n}","type":"json"}]', - 'title' => '获取会话', - 'description' => '获取会话', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', ], - 'GetThreadData' => [ - 'summary' => '获取会话数据。', - 'path' => '/digitalEmployee/{name}/thread/{threadId}/data', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DeleteEntityStore' => [ + 'path' => '/workspace/{workspaceName}/entitystore', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'name', + 'name' => 'workspaceName', 'in' => 'path', + 'schema' => ['description' => '工作空间名称。', 'type' => 'string', 'required' => true, 'example' => 'workspace-test-001'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '数字员工名称', - 'type' => 'string', - 'required' => true, - 'example' => 'test', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除EntityStore', + 'summary' => '删除EntityStore相关存储', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEntityStore'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'threadId', - 'in' => 'path', - 'schema' => [ - 'description' => '会话 id', - 'type' => 'string', - 'required' => true, - 'example' => 'thread_id01', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteEntityStore', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'EntityStore', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspaceName}/entitystore'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', + ], + 'DeleteIntegrationPolicy' => [ + 'path' => '/integration-policies/{policyId}', + 'methods' => ['delete'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'nextToken', - 'in' => 'query', - 'schema' => [ - 'description' => '分页游标。', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxxxxxxx', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'maxResults', + 'name' => 'force', 'in' => 'query', - 'schema' => [ - 'description' => '返回会话数据最大数据，最大值:100', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '是否强制删除云原生一体机。'."\n" + .'默认值：`false`。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'policyId', + 'in' => 'path', + 'schema' => ['description' => '策略环境 ID。', 'type' => 'string', 'required' => true, 'example' => 'policy-273c360bed1948818c5fb861886bc405'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'maxResults' => [ - 'title' => '最大结果数量', - 'description' => '最大结果数量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'data' => [ - 'title' => '消息数据', - 'description' => '消息数据', - 'type' => 'array', - 'items' => [ - 'title' => '消息数据', - 'description' => '消息数据', - 'type' => 'object', - 'properties' => [ - 'traceId' => [ - 'title' => '当前message请求的id数据'."\n" - .'根数据中第一个追踪ID', - 'description' => '当前message请求的id数据'."\n" - .'根数据中第一个追踪ID', - 'type' => 'string', - 'example' => '3b5287b717636040171772050d0095', - ], - 'requestId' => [ - 'title' => '当前message请求的id数据'."\n" - .'根数据中第一个RequestID', - 'description' => '当前message请求的id数据'."\n" - .'根数据中第一个RequestID', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], - 'messages' => [ - 'title' => '会话的消息列表', - 'description' => '会话的消息列表', - 'type' => 'array', - 'items' => [ - 'title' => '消息数据明细结构', - 'description' => '消息数据明细结构', - 'type' => 'object', - 'properties' => [ - 'version' => [ - 'title' => '消息数据的版本号', - 'description' => '消息数据的版本号', - 'type' => 'string', - 'example' => 'v0.1.0', - ], - 'parentCallId' => [ - 'title' => '上一层级执行ID', - 'description' => '上一层级执行ID', - 'type' => 'string', - 'example' => '3b5287b7176360', - ], - 'callId' => [ - 'title' => '当前执行ID', - 'description' => '当前执行ID', - 'type' => 'string', - 'example' => '3b5287b7176360', - ], - 'role' => [ - 'title' => '消息发起角色', - 'description' => '消息发起角色', - 'type' => 'string', - 'example' => 'user', - ], - 'seq' => [ - 'title' => '消息序列号', - 'description' => '消息序列号', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'timestamp' => [ - 'title' => 'timestamp / 纳秒', - 'description' => 'timestamp / 纳秒', - 'type' => 'string', - 'example' => '1768702985000000000', - ], - 'type' => [ - 'title' => '消息具体类型', - 'description' => '消息具体类型', - 'type' => 'string', - 'example' => 'task_finished', - ], - 'detail' => [ - 'title' => '消息明细', - 'description' => '消息明细', - 'type' => 'string', - 'example' => 'context of model exceed', - ], - 'contents' => [ - 'title' => '内容信息', - 'description' => '内容信息', - 'type' => 'array', - 'items' => [ - 'title' => '内容信息明细结构', - 'description' => '内容信息明细结构', - 'type' => 'object', - 'example' => '{'."\n" - .' "append": false,'."\n" - .' "lastChunk": false,'."\n" - .' "type": "text",'."\n" - .' "value": "result output chunk"'."\n" - .'}', - ], - ], - 'tools' => [ - 'title' => '工具使用列表', - 'description' => '工具使用列表', - 'type' => 'array', - 'items' => [ - 'title' => '工具明细结构', - 'description' => '工具明细结构', - 'type' => 'object', - 'example' => '{'."\n" - .' "arguments": {'."\n" - .' "confidence": "high",'."\n" - .' "intent": "analyser",'."\n" - .' "is_new_turn": true,'."\n" - .' "language": "en",'."\n" - .' "title": "Root Cause of Alert"'."\n" - .' },'."\n" - .' "id": "IntentRecognition",'."\n" - .' "name": "IntentRecognition",'."\n" - .' "status": "start",'."\n" - .' "toolCallId": "019bc1cb-adad"'."\n" - .'}', - ], - ], - 'agents' => [ - 'title' => '调用的Agent列表', - 'description' => '调用的Agent列表', - 'type' => 'array', - 'items' => [ - 'title' => '调用的Agent详细内容', - 'description' => '调用的Agent详细内容', - 'type' => 'object', - 'example' => '{'."\n" - .' "callId": "019bc1cb-adad",'."\n" - .' "id": "analyser",'."\n" - .' "inputs": ['."\n" - .' {'."\n" - .' "append": false,'."\n" - .' "lastChunk": false,'."\n" - .' "type": "text",'."\n" - .' "value": "Analyze this trace: TraceID=xxx"'."\n" - .' }'."\n" - .' ],'."\n" - .' "name": "analyser",'."\n" - .' "status": "start"'."\n" - .'}', - ], - ], - 'events' => [ - 'title' => '事件列表', - 'description' => '事件列表', - 'type' => 'array', - 'items' => [ - 'title' => '事件详细内容', - 'description' => '事件详细内容', - 'type' => 'object', - 'example' => '{'."\n" - .' "payload": {'."\n" - .' "error": {'."\n" - .' "code": "TASK_FAILED",'."\n" - .' "message": "Invalid task parameter",'."\n" - .' "suggestion": ""'."\n" - .' },'."\n" - .' "statistics": {'."\n" - .' "duration": 300000'."\n" - .' },'."\n" - .' "success": false'."\n" - .' },'."\n" - .' "type": "task_finished"'."\n" - .'}', - ], - ], - 'artifacts' => [ - 'title' => '产物产出信息', - 'description' => '产物产出信息', - 'type' => 'array', - 'items' => [ - 'title' => '产物明细的结构', - 'description' => '产物明细的结构', - 'type' => 'object', - 'example' => '{'."\n" - .' "artifactId": "019bc1cb-9600-703axxx",'."\n" - .' "name": "sql output",'."\n" - .' "description": "sql generation task result",'."\n" - .' "extensions": ["sql_generation_tool", "sql_diagnosis"],'."\n" - .' "metadata": {'."\n" - .' "model": "qwen3-coder-plus"'."\n" - .' },'."\n" - .' "parts": ['."\n" - .' {'."\n" - .' "text": "select * from table",'."\n" - .' "kind": "text"'."\n" - .' }'."\n" - .' ]'."\n" - .'}', - ], - ], - ], - ], - ], - ], - ], - ], - 'nextToken' => [ - 'title' => '分页参数，下一页信息', - 'description' => '分页游标。', - 'type' => 'string', - 'example' => 'xxxxxxxxx', - ], - 'requestId' => [ - 'title' => '当前请求ID', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], - 'threadId' => [ - 'title' => '当前会话ID', - 'description' => '会话 id', - 'type' => 'string', - 'example' => 'thread_id01', - ], - 'digitalEmployeeName' => [ - 'title' => '当前数字员工信息', - 'description' => '数字员工名称', - 'type' => 'string', - 'example' => 'test', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"maxResults\\": 1,\\n \\"data\\": [\\n {\\n \\"traceId\\": \\"3b5287b717636040171772050d0095\\",\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"messages\\": [\\n {\\n \\"version\\": \\"v0.1.0\\",\\n \\"parentCallId\\": \\"3b5287b7176360\\",\\n \\"callId\\": \\"3b5287b7176360\\",\\n \\"role\\": \\"user\\",\\n \\"seq\\": 0,\\n \\"timestamp\\": \\"1768702985000000000\\",\\n \\"type\\": \\"task_finished\\",\\n \\"detail\\": \\"context of model exceed\\",\\n \\"contents\\": [\\n {\\n \\"append\\": false,\\n \\"lastChunk\\": false,\\n \\"type\\": \\"text\\",\\n \\"value\\": \\"result output chunk\\"\\n }\\n ],\\n \\"tools\\": [\\n {\\n \\"arguments\\": {\\n \\"confidence\\": \\"high\\",\\n \\"intent\\": \\"analyser\\",\\n \\"is_new_turn\\": true,\\n \\"language\\": \\"en\\",\\n \\"title\\": \\"Root Cause of Alert\\"\\n },\\n \\"id\\": \\"IntentRecognition\\",\\n \\"name\\": \\"IntentRecognition\\",\\n \\"status\\": \\"start\\",\\n \\"toolCallId\\": \\"019bc1cb-adad\\"\\n }\\n ],\\n \\"agents\\": [\\n {\\n \\"callId\\": \\"019bc1cb-adad\\",\\n \\"id\\": \\"analyser\\",\\n \\"inputs\\": [\\n {\\n \\"append\\": false,\\n \\"lastChunk\\": false,\\n \\"type\\": \\"text\\",\\n \\"value\\": \\"Analyze this trace: TraceID=xxx\\"\\n }\\n ],\\n \\"name\\": \\"analyser\\",\\n \\"status\\": \\"start\\"\\n }\\n ],\\n \\"events\\": [\\n {\\n \\"payload\\": {\\n \\"error\\": {\\n \\"code\\": \\"TASK_FAILED\\",\\n \\"message\\": \\"Invalid task parameter\\",\\n \\"suggestion\\": \\"\\"\\n },\\n \\"statistics\\": {\\n \\"duration\\": 300000\\n },\\n \\"success\\": false\\n },\\n \\"type\\": \\"task_finished\\"\\n }\\n ],\\n \\"artifacts\\": [\\n {\\n \\"artifactId\\": \\"019bc1cb-9600-703axxx\\",\\n \\"name\\": \\"sql output\\",\\n \\"description\\": \\"sql generation task result\\",\\n \\"extensions\\": [\\n \\"sql_generation_tool\\",\\n \\"sql_diagnosis\\"\\n ],\\n \\"metadata\\": {\\n \\"model\\": \\"qwen3-coder-plus\\"\\n },\\n \\"parts\\": [\\n {\\n \\"text\\": \\"select * from table\\",\\n \\"kind\\": \\"text\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"nextToken\\": \\"xxxxxxxxx\\",\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"threadId\\": \\"thread_id01\\",\\n \\"digitalEmployeeName\\": \\"test\\"\\n}","type":"json"}]', - 'title' => '获取会话数据', - 'description' => '获取会话数据', - ], - 'ListThreads' => [ - 'summary' => '列出会话', - 'path' => '/digitalEmployee/{name}/threads', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除接入中心策略', + 'summary' => '删除接入中心策略', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIntegrationPolicy'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteIntegrationPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'IntegrationPolicy', 'arn' => 'acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#integrationPolicyId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CD8BA7D6-995D-578D-9941-78B0FECD14B5\\"\\n}","type":"json"}]', + ], + 'DeleteMemories' => [ + 'summary' => '通过过滤属性删除记忆。至少需要设置一个过滤属性，若不设置任何过滤属性，则会返回验证错误提示。', + 'path' => '/workspace/{workspace}/memorystore/{memoryStoreName}/memory', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'name', + 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'description' => '数字员工名称', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'default-cms-1793369865235921-cn-shenzhen', 'maxLength' => 64, 'minLength' => 2], ], [ - 'name' => 'status', - 'in' => 'query', - 'schema' => [ - 'description' => '会话状态', - 'type' => 'string', - 'required' => false, - 'example' => 'active', - ], + 'name' => 'memoryStoreName', + 'in' => 'path', + 'schema' => ['description' => '记忆库名称。', 'type' => 'string', 'required' => true, 'example' => 'test-memory-store', 'maxLength' => 64, 'minLength' => 2], ], [ - 'name' => 'threadId', + 'name' => 'agentId', 'in' => 'query', - 'schema' => [ - 'description' => '会话 id', - 'type' => 'string', - 'required' => false, - 'example' => 'thread-123123', - ], + 'schema' => ['description' => '应用的agentId', 'type' => 'string', 'required' => false, 'example' => '952730733889060865'], ], [ - 'name' => 'maxResults', + 'name' => 'userId', 'in' => 'query', - 'schema' => [ - 'description' => '最大返回结果数，最大值200', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => '用户Id', 'type' => 'string', 'required' => false, 'example' => 'test_user_001'], ], [ - 'name' => 'nextToken', + 'name' => 'runId', 'in' => 'query', - 'schema' => [ - 'description' => '分页 Token', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxxx', - ], + 'schema' => ['description' => '运行id', 'type' => 'string', 'required' => false, 'example' => 'jr-dd7c645fd6fe50d4'], ], [ - 'name' => 'filter', + 'name' => 'appId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '查询的过滤条件，若不输入则查询该实例下所有的主题。', - 'type' => 'array', - 'items' => [ - 'description' => '查询的过滤条件，若不输入则查询该实例下所有的主题。', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => '过滤 key，当前支持 title、workspace、project', - 'type' => 'string', - 'required' => true, - 'example' => 'title', - ], - 'value' => [ - 'description' => '设置的值', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['description' => '应用Id', 'type' => 'string', 'required' => false, 'example' => '98ea19fe-128b-4841-b318-0359bec3c65d'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '响应数据', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'CD8BA7D6-995D-578D-9941-xxxx', - ], - 'threadId' => [ - 'description' => '会话 id', - 'type' => 'string', - 'example' => 'thread-123123', - ], - 'total' => [ - 'description' => '总数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'maxResults' => [ - 'description' => '最大返回结果数，最大值200', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'threads' => [ - 'description' => '会话', - 'type' => 'array', - 'items' => [ - 'description' => '会话', - 'type' => 'object', - 'properties' => [ - 'threadId' => [ - 'description' => '会话 id', - 'type' => 'string', - 'example' => 'thread-123123', - ], - 'digitalEmployeeName' => [ - 'description' => '数字员工名称', - 'type' => 'string', - 'example' => 'test', - ], - 'title' => [ - 'description' => '会话标题', - 'type' => 'string', - 'example' => 'test', - ], - 'status' => [ - 'description' => '会话状态', - 'type' => 'string', - 'example' => 'active', - ], - 'version' => [ - 'description' => '版本号', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123123', - ], - 'variables' => [ - 'description' => '会话属性', - 'type' => 'object', - 'properties' => [ - 'workspace' => [ - 'description' => '工作空间。', - 'type' => 'string', - 'example' => 'workspace', - ], - 'project' => [ - 'description' => 'SLS project。', - 'type' => 'string', - 'example' => 'project', - ], - ], - ], - 'createTime' => [ - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2025-12-19T15:19:55.040403272+08:00', - ], - 'updateTime' => [ - 'description' => '更新时间', - 'type' => 'string', - 'example' => '2025-12-19T15:19:55.040403272+08:00', - ], - ], - ], - ], - 'nextToken' => [ - 'description' => '分页 Token', - 'type' => 'string', - 'example' => 'xxxxxxxxxx', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求Id', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '批量删除记忆', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CD8BA7D6-995D-578D-9941-xxxx\\",\\n \\"threadId\\": \\"thread-123123\\",\\n \\"total\\": 1,\\n \\"maxResults\\": 20,\\n \\"threads\\": [\\n {\\n \\"threadId\\": \\"thread-123123\\",\\n \\"digitalEmployeeName\\": \\"test\\",\\n \\"title\\": \\"test\\",\\n \\"status\\": \\"active\\",\\n \\"version\\": 123123,\\n \\"variables\\": {\\n \\"workspace\\": \\"workspace\\",\\n \\"project\\": \\"project\\"\\n },\\n \\"createTime\\": \\"2025-12-19T15:19:55.040403272+08:00\\",\\n \\"updateTime\\": \\"2025-12-19T15:19:55.040403272+08:00\\"\\n }\\n ],\\n \\"nextToken\\": \\"xxxxxxxxxx\\"\\n}","type":"json"}]', - 'title' => '列出会话', - 'description' => '列出会话', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', ], - 'UpdateThread' => [ - 'summary' => '更新会话。', - 'path' => '/digitalEmployee/{name}/thread/{threadId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'DeleteMemory' => [ + 'summary' => '删除单个记忆。', + 'path' => '/workspace/{workspace}/memorystore/{memoryStoreName}/memory/{memoryId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'name', + 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'description' => '数字员工名称', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => '工作空间名称。', 'type' => 'string', 'required' => true, 'example' => 'default-cms-xxxxxx-cn-beijing', 'maxLength' => 64, 'minLength' => 2], ], [ - 'name' => 'threadId', + 'name' => 'memoryStoreName', 'in' => 'path', - 'schema' => [ - 'description' => '会话 id', - 'type' => 'string', - 'required' => true, - 'example' => 'thread-12313', - ], + 'schema' => ['description' => '记忆库名称。', 'type' => 'string', 'required' => true, 'example' => 'test-memory-store', 'maxLength' => 64, 'minLength' => 2], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'memoryId', + 'in' => 'path', + 'schema' => ['description' => '记忆Id', 'type' => 'string', 'required' => true, 'example' => '019ca1e5-7307-7d50-b943-5e628326a8ed', 'minLength' => 1], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '请求 body', + 'title' => 'Schema of Response', + 'description' => '响应数据', 'type' => 'object', 'properties' => [ - 'title' => [ - 'description' => '会话标题', - 'type' => 'string', - 'required' => false, - 'example' => 'title', - ], - 'status' => [ - 'description' => '会话状态', - 'type' => 'string', - 'required' => false, - 'example' => 'active', - 'enum' => [ - 'active', - 'archived', - 'failed', - 'suspended', - 'cancelled', - 'unknown', - ], - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求 Id', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-************'], ], - 'required' => false, ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除单个记忆', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-************\\"\\n}","type":"json"}]', + ], + 'DeleteMemoryStore' => [ + 'summary' => '删除记忆库', + 'path' => '/workspace/{workspace}/memorystore/{memoryStoreName}', + 'methods' => ['delete'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'maxLength' => 64, 'minLength' => 2], + ], + [ + 'name' => 'memoryStoreName', + 'in' => 'path', + 'schema' => ['description' => '记忆库名称', 'type' => 'string', 'required' => true, 'example' => 'test-memory-store', 'maxLength' => 64, 'minLength' => 2], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '响应数据', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'threadId' => [ - 'description' => '会话 id', - 'type' => 'string', - 'example' => 'thread-12313', - ], - 'version' => [ - 'description' => '版本号', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123123', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求 Id', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"threadId\\": \\"thread-12313\\",\\n \\"version\\": 123123\\n}","type":"json"}]', - 'title' => '更新会话', - 'description' => '更新会话', - ], - 'DeleteThread' => [ - 'summary' => '删除会话。', - 'path' => '/digitalEmployee/{name}/thread/{threadId}', - 'methods' => [ - 'delete', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除记忆库', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteMemoryStore', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'MemoryStore', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#WorkspaceName}/memorystore/{#MemoryStoreName}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + ], + 'DeletePipeline' => [ + 'path' => '/workspace/{workspace}/pipeline/{pipelineName}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'name', + 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'description' => '数字员工名称', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => '工作空间名称', 'type' => 'string', 'required' => false, 'example' => 'workspace-test'], ], [ - 'name' => 'threadId', + 'name' => 'pipelineName', 'in' => 'path', - 'schema' => [ - 'description' => '会话 id', - 'type' => 'string', - 'required' => true, - 'example' => 'thread_id01', - ], + 'schema' => ['description' => '流水线名称', 'type' => 'string', 'required' => false, 'example' => 'pipeline-name-1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '响应数据', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '123-0F43-23423-AC43-34234', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除流水线', + 'summary' => '删除流水线', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"123-0F43-23423-AC43-34234\\"\\n}","type":"json"}]', - 'title' => '删除会话', - 'description' => '删除会话', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CD8BA7D6-995D-578D-9941-78B0FECD14B5\\"\\n}","type":"json"}]', ], - 'UpdateIntegrationPolicy' => [ - 'summary' => '更新指定策略', - 'path' => '/integration-policies/{integrationPolicyId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'DeletePrometheusInstance' => [ + 'path' => '/prometheus-instances/{prometheusInstanceId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'prometheusInstanceId', + 'in' => 'path', + 'schema' => ['description' => '实例id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rw-abc123'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '请求体参数。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'feePackage' => [ - 'description' => '付费套餐类型，CS_Pro/CS_Basic/空。', - 'type' => 'string', - 'required' => false, - 'example' => 'CS_Pro', - ], - 'policyName' => [ - 'description' => '规则名称，最短3个字符，最长63个字符，必须以字母开头。', - 'type' => 'string', - 'required' => false, - 'example' => 'metrics-inner-manage', - ], - 'resourceGroupId' => [ - 'description' => '实例的资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aekzoiafjtr7zyq', - ], - 'tags' => [ - 'description' => '资源标签。', - 'type' => 'array', - 'items' => [ - 'description' => '资源标签。', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => '标签`key`值。', - 'type' => 'string', - 'required' => false, - 'example' => 'algo_bhv_expose_in_airec_exposure', - ], - 'value' => [ - 'description' => '标签`value`值。', - 'type' => 'string', - 'required' => false, - 'example' => '[{\'Id\': \'kgqie6hm\', \'Name\': \'Sheet1\'}]', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], - 'required' => false, ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除Prometheus实例', + 'summary' => '删除prom实例。', + 'description' => '删除Prometheus实例。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePrometheusInstance'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'integrationPolicyId', - 'in' => 'path', - 'schema' => [ - 'description' => '接入中心策略ID', - 'type' => 'string', - 'required' => true, - 'example' => 'polixy-xxxxxxxxx', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeletePrometheusInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'PrometheusInstance', 'arn' => 'acs:cms:{#regionId}:{#accountId}:prometheusinstance/{#prometheusInstanceId}'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + ], + 'DeletePrometheusView' => [ + 'path' => '/prometheus-views/{prometheusViewId}', + 'methods' => ['delete'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'prometheusViewId', + 'in' => 'path', + 'schema' => ['description' => 'Prometheus 视图ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rw-xxxxxx'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ @@ -10265,231 +8093,225 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除prometheus视图实例。', + 'summary' => '删除prometheus视图实例。', + 'description' => '删除prometheus视图实例。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePrometheusView'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeletePrometheusView', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'PrometheusView', 'arn' => 'acs:cms:{#regionId}:{#accountId}:prometheusview/{#prometheusViewId}'], + ], + ], + ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', - 'title' => '更新接入中心策略', ], - 'DeleteIntegrationPolicy' => [ - 'summary' => '删除接入中心策略', - 'path' => '/integration-policies/{policyId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'DeletePrometheusVirtualInstance' => [ + 'summary' => '通过虚拟实例 ID 删除 Prometheus 虚拟实例。', + 'path' => '/virtual-instances/{prometheusInstanceId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'prometheusInstanceId', + 'in' => 'path', + 'schema' => ['description' => '实例id。', 'type' => 'string', 'required' => false, 'example' => 'virtual-xxxxxxxxxxxxxxxx'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + ], + 'description' => '', + ], + ], ], - 'produces' => [ - 'application/json', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除 Prometheus 虚拟实例', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + ], + 'DeleteService' => [ + 'summary' => '删除应用可观测服务', + 'path' => '/workspace/{workspace}/service/{serviceId}', + 'methods' => ['delete'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'force', - 'in' => 'query', + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => '工作空间名称。', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'title' => '工作空间'], + ], + [ + 'name' => 'serviceId', + 'in' => 'path', + 'schema' => ['description' => '服务ID。', 'type' => 'string', 'required' => true, 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', 'title' => '应用服务id'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '是否强制删除云原生一体机。'."\n" - .'默认值：`false`。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '51B6A3E8-EA9E-5143-BE11-8E5F83474C95', 'title' => '请求id'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除应用可观测服务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteService'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'policyId', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Service', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#Workspace}/service/{#ServiceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"51B6A3E8-EA9E-5143-BE11-8E5F83474C95\\"\\n}","type":"json"}]', + ], + 'DeleteServiceRecord' => [ + 'path' => '/workspace/{workspace}/service/{serviceId}/record', + 'methods' => ['delete'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => '工作空间名称。', 'type' => 'string', 'required' => true, 'example' => 'default-cms-1654218***343050-cn-hangzhou'], + ], + [ + 'name' => 'serviceId', 'in' => 'path', + 'schema' => ['description' => '服务ID。', 'type' => 'string', 'required' => true, 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb'], + ], + [ + 'name' => 'recordType', + 'in' => 'query', 'schema' => [ - 'description' => '策略环境 ID。', + 'title' => '关联条目类型，目前支持:'."\n" + .'logCorrelation，标识应用日志关联', + 'description' => '关联条目类型，目前支持:'."\n" + .'logCorrelation，标识应用日志关联', 'type' => 'string', 'required' => true, - 'example' => 'policy-273c360bed1948818c5fb861886bc405', + 'example' => 'logCorrelation', + 'enum' => ['logCorrelation'], ], ], ], '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' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除服务关联条目', + 'summary' => '删除服务关联条目', + 'description' => '删除已创建的服务关联条目', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CD8BA7D6-995D-578D-9941-78B0FECD14B5\\"\\n}","type":"json"}]', - 'title' => '删除接入中心策略', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', ], - 'CreateIntegrationPolicy' => [ - 'summary' => '创建接入中心策略', - 'path' => '/integration-policies', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DeleteUmodel' => [ + 'path' => '/workspace/{workspace}/umodel', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求body。', - 'type' => 'object', - 'properties' => [ - 'entityGroup' => [ - 'description' => '用于创建策略的实体组，可以通过实体组快速创建，clusterId和vpcId是互相独立的。', - 'type' => 'object', - 'properties' => [ - 'clusterEntityType' => [ - 'description' => '集群实体类型，acs.ack.cluster/acs.one.cluster/acs.asi.cluster或其他。', - 'type' => 'string', - 'required' => false, - 'example' => 'acs.ack.cluster', - ], - 'clusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'na61prod3-na61cloudhdfsssd', - ], - 'entityUserId' => [ - 'description' => '集群归属用户ID。', - 'type' => 'string', - 'required' => false, - 'example' => '12xxxx', - ], - 'entityGroupId' => [ - 'description' => '实体组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'eg-b79f65d11fb94e779867cf937c3a3002', - ], - 'vpcId' => [ - 'description' => '专有网络ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp18fgg3ffxa9czna40xt', - ], - 'disablePolicyShare' => [ - 'description' => '是否禁用 Policy 唯一绑定，如果开启则可以为一个容器集群创建多个Policy', - 'type' => 'boolean', - 'required' => false, - 'example' => 'ture', - ], - 'clusterNamespace' => [ - 'title' => '', - 'type' => 'string', - 'required' => false, - ], - ], - 'required' => false, - ], - 'policyName' => [ - 'title' => '策略名称', - 'description' => '策略名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'prod-database', - ], - 'policyType' => [ - 'title' => '策略类型：CS/ECS/Cloud', - 'description' => '策略类型：CS/ECS/Cloud', - 'type' => 'string', - 'required' => true, - 'example' => 'CS', - ], - 'resourceGroupId' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aekz2km4kmhtbii', - ], - 'tags' => [ - 'description' => '资源标签。', - 'type' => 'array', - 'items' => [ - 'description' => '资源标签。', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => '标签`key`值。', - 'type' => 'string', - 'required' => false, - 'example' => 'use', - ], - 'value' => [ - 'description' => '标签`value`值。', - 'type' => 'string', - 'required' => false, - 'example' => 'database', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'workspace' => [ - 'title' => '工作空间，不填则创建或使用默认工作空间。', - 'description' => '工作空间。', - 'type' => 'string', - 'required' => false, - 'example' => 'prometheus', - ], - ], - 'required' => false, - ], + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => '工作空间名称。', 'type' => 'string', 'required' => true, 'example' => 'workspace-test'], ], ], 'responses' => [ @@ -10497,264 +8319,314 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'policy' => [ - 'description' => '上传策略。', - 'type' => 'object', - 'properties' => [ - 'entityGroupId' => [ - 'description' => '实体组ID。', - 'type' => 'string', - 'example' => 'eg-b79f65d11fb94e779867cf937c3a3002', - ], - 'policyId' => [ - 'title' => '策略id', - 'description' => '策略ID。', - 'type' => 'string', - 'example' => 'policy-14c8e9a29b0a46da843f8781471062ff', - ], - 'policyName' => [ - 'title' => '策略名称', - 'description' => '策略名称。', - 'type' => 'string', - 'example' => 'metrics-inner-manage', - ], - 'policyType' => [ - 'title' => '策略类型', - 'description' => '策略类型。', - 'type' => 'string', - 'example' => 'CS', - ], - 'regionId' => [ - 'title' => 'region', - 'description' => '地域。', - 'type' => 'string', - 'example' => 'cn-heyuan', - ], - 'userId' => [ - 'title' => '用户id', - 'description' => '用户ID。', - 'type' => 'string', - 'example' => 'u1234567', - ], - 'workspace' => [ - 'title' => 'Policy所在的工作空间。', - 'description' => 'Policy所在的工作空间。', - 'type' => 'string', - 'example' => 'prometheus', - ], - ], - ], - 'requestId' => [ - 'title' => '', - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5', - ], - 'created' => [ - 'description' => '是否创建。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '123123-3213-345-9941-345345345'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"policy\\": {\\n \\"entityGroupId\\": \\"eg-b79f65d11fb94e779867cf937c3a3002\\",\\n \\"policyId\\": \\"policy-14c8e9a29b0a46da843f8781471062ff\\",\\n \\"policyName\\": \\"metrics-inner-manage\\",\\n \\"policyType\\": \\"CS\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"userId\\": \\"u1234567\\",\\n \\"workspace\\": \\"prometheus\\"\\n },\\n \\"requestId\\": \\"CD8BA7D6-995D-578D-9941-78B0FECD14B5\\",\\n \\"created\\": true\\n}","type":"json"}]', - 'title' => '创建接入中心策略', - 'description' => '本接口用于支持用户创建事件集成', - ], - 'UpdateAddonRelease' => [ - 'summary' => '升级接入组件', - 'path' => '/integration-policies/{policyId}/addon-releases/{releaseName}', - 'methods' => [ - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除 Umodel', + 'summary' => '删除Umodel配置信息。', + 'description' => '删除指定 workspace 下的Umodel', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUmodel'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteUmodel', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Umodel', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/umodel'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"123123-3213-345-9941-345345345\\"\\n}","type":"json"}]', + ], + 'DeleteUmodelCommonSchemaRef' => [ + 'summary' => '删除引用的公共Umodel Schema。', + 'path' => '/workspace/{workspace}/umodel/common-schema-ref', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'releaseName', + 'name' => 'workspace', 'in' => 'path', + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'workspace-test'], + ], + [ + 'name' => 'group', + 'in' => 'query', 'schema' => [ - 'title' => 'Release 的名称。', - 'description' => 'Release 的名称。', + 'description' => '公共Umodel Schema group', 'type' => 'string', 'required' => true, - 'example' => 'test-gpu-integration-name', + 'enumValueTitles' => [], + 'example' => 'apm-common', ], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '请求体。', 'type' => 'object', 'properties' => [ - 'addonVersion' => [ - 'title' => 'Addon 的版本信息。', - 'description' => 'Addon 的版本信息。', - 'type' => 'string', - 'required' => false, - 'example' => '0.0.2', - ], - 'dryRun' => [ - 'title' => '是否预检本次请求。', - 'description' => '是否预检本次请求。', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '是', - 'false' => '否', - ], - 'example' => 'true', - ], - 'values' => [ - 'title' => '元数据信息。', - 'description' => '元数据。', - 'type' => 'string', - 'required' => false, - 'example' => '{"install":{"mode":"auto-install","listenPort":"9400"},"discoverMode":"instances","discover":{"instances":"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44"},"scrapeInterval":"15","enableSecuritecs-nodeyGroupInjection":"true","metricTags":""}', - ], - 'entityRules' => [ - 'title' => '实体发现规则。', - 'description' => '实体发现规则。', - 'required' => false, - '$ref' => '#/components/schemas/EntityDiscoverRule', - ], + 'requestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], - 'required' => false, + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除指定的公共Umodel Schema引用', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUmodelCommonSchemaRef'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'policyId', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteUmodelCommonSchemaRef', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Umodel', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/umodel'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + ], + 'DeleteUmodelData' => [ + 'path' => '/workspace/{workspace}/umodel/data', + 'methods' => ['delete'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'workspace', 'in' => 'path', + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'workspace-test'], + ], + [ + 'name' => 'domain', + 'in' => 'query', + 'schema' => ['description' => '可以指定特定Umodel data 的name，不传代表全部', 'type' => 'string', 'required' => false, 'example' => 'apm'], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => ['description' => '可以指定特定Umodel data 的name，不传代表全部', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'kind', + 'in' => 'query', + 'schema' => ['description' => '可以指定特定Umodel data 的kind，不传代表全部', 'type' => 'string', 'required' => false, 'example' => 'metric_set'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '策略环境 ID。', - 'description' => '策略环境 ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-xxxxxxxxxxxx', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '111111-222-333-1111-33333'], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除Umodel Data', + 'summary' => '删除 Umodel Elements。', + 'description' => '删除指定工作空间下Umodel的 Data', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUmodelData'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteUmodelData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Umodel', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/umodel'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"111111-222-333-1111-33333\\"\\n}","type":"json"}]', + ], + 'DeleteWorkspace' => [ + 'path' => '/workspace/{workspaceName}', + 'methods' => ['delete'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => ['title' => '实例 ID。', 'description' => '工作空间名称。', 'type' => 'string', 'required' => true, 'example' => 'workspace-test-001'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回数据。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9F00A7AF-2728-5424-B321-79D39C00A1EC', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求 ID', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9F00A7AF-2728-5424-B321-79D39C00A1EC\\"\\n}","type":"json"}]', - 'title' => '更新接入组件配置', - ], - 'ListIntegrationPolicyStorageRequirements' => [ - 'summary' => '获取接入中心策略的存储要求信息', - 'path' => '/integration-policies/{policyId}/storage-requirements', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除工作空间', + 'summary' => '删除工作空间。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWorkspace'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteWorkspace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Workspace', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspaceName}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', + ], + 'DescribeMetricMetaList' => [ + 'summary' => '查询元数据meta。', + 'path' => '/describe-metric-meta-list', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'policyId', - 'in' => 'path', - 'schema' => [ - 'title' => '接入中心策略ID', - 'description' => '接入中心策略ID', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e', - ], + 'name' => 'namespace', + 'in' => 'query', + 'schema' => ['description' => '命名空间，用于区分产品。', 'type' => 'string', 'required' => false, 'example' => 'acs_ecs_dashboard'], ], [ - 'name' => 'addonName', + 'name' => 'metaFormat', 'in' => 'query', 'schema' => [ - 'title' => 'Addon名称，如mysql。', - 'description' => 'Addon Release名称', + 'description' => '元数据来源，可选为基础云监控指标CMS，Promtheus云监控基础指标PROM_BASIC', 'type' => 'string', 'required' => false, - 'example' => 'release-1234357', + 'example' => 'CMS', + 'enum' => ['CMS', 'PROM_BASIC'], ], ], [ - 'name' => 'storageType', + 'name' => 'metricName', 'in' => 'query', - 'schema' => [ - 'title' => '存储类型', - 'description' => '存储类型，LogStore/Prometheus/TraceStore/EventStore/EntityStore。', - 'type' => 'string', - 'required' => false, - 'example' => 'LogStore', - ], + 'schema' => ['description' => '指标名称', 'type' => 'string', 'required' => false, 'example' => 'CPUUtilization'], ], [ - 'name' => 'addonReleaseName', + 'name' => 'labels', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => 'AddonRelease的名称。', - 'description' => 'AddonRelease的名称', - 'type' => 'string', + 'description' => '根据标签过滤资源。已有标签说明如下：'."\n" + .'- metricCategory：监控项分类描述。'."\n" + .'- alertEnable：是否需要报警。'."\n" + .'- alertUnit：建议的报警单位。'."\n" + .'- unitFactor：单位转换系数。'."\n" + .'- minAlertPeriod：最小报警周期。'."\n" + .'- productCategory：产品类型分类。', + 'type' => 'array', + 'items' => [ + 'description' => '标签键。', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => '标签名称', 'type' => 'string', 'required' => false, 'example' => 'productCategory'], + 'value' => ['description' => '标签的值。', 'type' => 'string', 'required' => false, 'example' => 'ecs'], + ], + 'required' => false, + ], 'required' => false, - 'example' => 'kafka-17201012937917', ], ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码，默认1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => '每页大小，默认2000。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2000'], + ], + [ + 'name' => 'keywords', + 'in' => 'query', + 'schema' => ['description' => '关键词', 'type' => 'string', 'required' => false, 'example' => '实例理论'], + ], ], 'responses' => [ 200 => [ @@ -10763,191 +8635,64 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', - ], - 'storageRequirements' => [ - 'description' => '存储需求列表', + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'totalCount' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int64', 'example' => '6370'], + 'pageNumber' => ['description' => '页码，默认1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'pageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '2000'], + 'resources' => [ + 'description' => '资源中监控项的配置信息。', 'type' => 'array', 'items' => [ + 'description' => '资源中监控项的配置信息。', 'type' => 'object', 'properties' => [ - 'apiVersion' => [ - 'description' => '版本号', - 'type' => 'string', - 'example' => 'v1', - ], - 'kind' => [ - 'description' => '资源kind', - 'type' => 'string', - 'example' => 'Pod', - ], - 'metadata' => [ - 'description' => '元数据', + 'namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'acs_ecs_dashboard'], + 'metricName' => ['description' => '指标名称。', 'type' => 'string', 'example' => 'CPUUtilization'], + 'description' => ['description' => '描述', 'type' => 'string', 'example' => 'ECS CPU Utilization'], + 'unit' => ['description' => '单位。', 'type' => 'string', 'example' => '%'], + 'labels' => [ + 'description' => '云监控标签，仅当metaFormat=CMS时返回。', 'type' => 'object', - 'properties' => [ - 'annotations' => [ - 'description' => '注释', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '注释', - 'example' => 'prometheus.io/path', - ], - ], - 'labels' => [ - 'description' => '资源标签', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '资源标签', - 'example' => 'key=value', - ], - ], - 'name' => [ - 'description' => '资源名称', - 'type' => 'string', - 'example' => 'pod-1234567', - ], - 'namespace' => [ - 'description' => '命名空间', - 'type' => 'string', - 'example' => 'arms-prom', - ], - ], - ], - 'spec' => [ - 'description' => '资源的spec', - 'type' => 'object', - 'properties' => [ - 'entityId' => [ - 'description' => '实例ID，如需精确到实例级别，则可以指定。依赖于 EntityStore 中的数据。', - 'type' => 'string', - 'example' => 'es-xxxxx', - ], - 'instance' => [ - 'description' => 'Prom实例ID。', - 'type' => 'string', - 'example' => 'i-bp122p85gthbniw8rsu9', - ], - 'instanceName' => [ - 'description' => 'Prom实例名称', - 'type' => 'string', - 'example' => 'category_predict', - ], - 'project' => [ - 'description' => '可选参数，根据当前环境类型情况判断 Project', - 'type' => 'string', - 'example' => 'datagrid_cdm', - ], - 'region' => [ - 'description' => '地域', - 'type' => 'string', - 'example' => 'cn-shenzhen', - ], - 'shareScope' => [ - 'description' => '存储共享的范围 Environment | Region | Workspace | Custom', - 'type' => 'string', - 'example' => 'Region', - ], - 'storageType' => [ - 'description' => '实例存储类型', - 'type' => 'string', - 'example' => 'Prometheus', - ], - 'systemTags' => [ - 'description' => '需要打到目标存储上的标签（以系统标签的方式注入）', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'system-key=value', - 'description' => '需要打到目标存储上的标签（以系统标签的方式注入）', - ], - ], - 'tags' => [ - 'description' => '需要打到目标存储上的标签（以普通标签的方式注入）', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'key=value', - 'description' => '需要打到目标存储上的标签（以普通标签的方式注入）', - ], - ], - 'userId' => [ - 'description' => '用户ID', - 'type' => 'string', - 'example' => '12345678', - ], - 'workspace' => [ - 'description' => '工作空间。', - 'type' => 'string', - 'example' => 'test-api', - ], - ], - ], - 'status' => [ - 'description' => '存储需求状态。', - 'type' => 'object', - 'properties' => [ - 'instanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'rmq-cn-uqm3ket1t0u', - ], - 'interUrl' => [ - 'description' => '内部url', - 'type' => 'string', - 'example' => 'http://192.168.xxxxxx', - ], - 'intraUrl' => [ - 'description' => '外部url', - 'type' => 'string', - 'example' => 'http://100.100.xxxxxx', - ], - 'name' => [ - 'description' => '存储需求名称', - 'type' => 'string', - 'example' => 'sr-xxxx', - ], - 'project' => [ - 'description' => '存储需求项目', - 'type' => 'string', - 'example' => 'jiuwu_algo', - ], - 'promMetricStore' => [ - 'description' => 'Prom的指标中心', - 'type' => 'string', - 'example' => 'xxxx', - ], - 'region' => [ - 'description' => '地域', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'storageType' => [ - 'description' => '实例存储类型', - 'type' => 'string', - 'example' => 'Prometheus', - ], - 'workspace' => [ - 'description' => '工作空间。', - 'type' => 'string', - 'example' => 'default', - ], - ], + 'additionalProperties' => ['type' => 'string', 'example' => '{'."\n" + .' "DefaultTemplate": "false",'."\n" + .' "alertDefault": "80",'."\n" + .' "alertUnit": "%",'."\n" + .' "is_alarm": "true",'."\n" + .' "metricCategory": "instanceId",'."\n" + .' "minAlertPeriod": "60",'."\n" + .' "productCategory": "ecs",'."\n" + .' "unitFactor": "1"'."\n" + .'}', 'description' => '云监控标签内容。'], + ], + 'dimensions' => [ + 'description' => '基础云监控的资源过滤维度', + 'type' => 'array', + 'items' => ['description' => '基础云监控的资源过滤维度', 'type' => 'string', 'example' => '["userId","instanceId"]'], ], - 'addonReleaseNames' => [ - 'description' => 'AddonRelease的集合。', + 'type' => ['description' => '指标类型。', 'type' => 'string', 'example' => 'Gauge'], + 'dimensionDescription' => [ + 'description' => '维度信息描述。', 'type' => 'array', 'items' => [ - 'description' => 'AddonRelease的名称。', - 'type' => 'string', - 'example' => 'kafka-17201238912', + 'description' => '维度信息描述。', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => '名称', 'type' => 'string', 'example' => 'user_id'], + ], ], ], + 'statistics' => ['description' => '监控项的统计方法。取值示例：'."\n" + .'- Maximum：最大值。'."\n" + .'- Minimum：最小值。'."\n" + .'- Average：平均值。', 'type' => 'string', 'example' => 'Maximum'], + 'periods' => ['description' => '周期。', 'type' => 'string', 'example' => '60'], + 'metaFormat' => ['description' => '元数据来源，基础云监控指标 CMS，Promtheus 云监控基础指标 PROM_BASIC'."\n" + ."\n" + .'示例值:'."\n" + .'CMS'."\n" + .'枚举值:'."\n" + .'CMS'."\n" + .'PROM_BASIC', 'type' => 'string', 'example' => 'PROM_BASIC'], ], ], ], @@ -10955,85 +8700,132 @@ ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询云监控开放的监控项详情', + 'description' => '查询云监控指标元数据详情。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\",\\n \\"storageRequirements\\": [\\n {\\n \\"apiVersion\\": \\"v1\\",\\n \\"kind\\": \\"Pod\\",\\n \\"metadata\\": {\\n \\"annotations\\": {\\n \\"key\\": \\"prometheus.io/path\\"\\n },\\n \\"labels\\": {\\n \\"key\\": \\"key=value\\"\\n },\\n \\"name\\": \\"pod-1234567\\",\\n \\"namespace\\": \\"arms-prom\\"\\n },\\n \\"spec\\": {\\n \\"entityId\\": \\"es-xxxxx\\",\\n \\"instance\\": \\"i-bp122p85gthbniw8rsu9\\",\\n \\"instanceName\\": \\"category_predict\\",\\n \\"project\\": \\"datagrid_cdm\\",\\n \\"region\\": \\"cn-shenzhen\\",\\n \\"shareScope\\": \\"Region\\",\\n \\"storageType\\": \\"Prometheus\\",\\n \\"systemTags\\": {\\n \\"key\\": \\"system-key=value\\"\\n },\\n \\"tags\\": {\\n \\"key\\": \\"key=value\\"\\n },\\n \\"userId\\": \\"12345678\\",\\n \\"workspace\\": \\"test-api\\"\\n },\\n \\"status\\": {\\n \\"instanceId\\": \\"rmq-cn-uqm3ket1t0u\\",\\n \\"interUrl\\": \\"http://192.168.xxxxxx\\",\\n \\"intraUrl\\": \\"http://100.100.xxxxxx\\",\\n \\"name\\": \\"sr-xxxx\\",\\n \\"project\\": \\"jiuwu_algo\\",\\n \\"promMetricStore\\": \\"xxxx\\",\\n \\"region\\": \\"cn-hangzhou\\",\\n \\"storageType\\": \\"Prometheus\\",\\n \\"workspace\\": \\"default\\"\\n },\\n \\"addonReleaseNames\\": [\\n \\"kafka-17201238912\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取接入中心策略的存储要求信息', - 'description' => '在策略的生效期间内，应用分组内发生的所有报警都不再发送通知。'."\n" - .' '."\n" - .'本文将提供一个示例，为应用分组`7301****`创建暂停报警通知策略`PauseNotify`，该应用分组将在`1622949300000`至`1623208500000`（北京时间`2021-06-06 11:15:00`至`2021-06-09 11:15:00`）期间暂停报警。 ', - ], - 'ListIntegrationPolicyPodMonitors' => [ - 'summary' => '获取接入中心策略的PodMonitor资源。', - 'path' => '/integration-policies/{policyId}/pod-monitors', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'cms:DescribeMetricMetaList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"totalCount\\": 6370,\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 2000,\\n \\"resources\\": [\\n {\\n \\"namespace\\": \\"acs_ecs_dashboard\\",\\n \\"metricName\\": \\"CPUUtilization\\",\\n \\"description\\": \\"ECS CPU Utilization\\",\\n \\"unit\\": \\"%\\",\\n \\"labels\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"DefaultTemplate\\\\\\": \\\\\\"false\\\\\\",\\\\n \\\\\\"alertDefault\\\\\\": \\\\\\"80\\\\\\",\\\\n \\\\\\"alertUnit\\\\\\": \\\\\\"%\\\\\\",\\\\n \\\\\\"is_alarm\\\\\\": \\\\\\"true\\\\\\",\\\\n \\\\\\"metricCategory\\\\\\": \\\\\\"instanceId\\\\\\",\\\\n \\\\\\"minAlertPeriod\\\\\\": \\\\\\"60\\\\\\",\\\\n \\\\\\"productCategory\\\\\\": \\\\\\"ecs\\\\\\",\\\\n \\\\\\"unitFactor\\\\\\": \\\\\\"1\\\\\\"\\\\n}\\"\\n },\\n \\"dimensions\\": [\\n \\"[\\\\\\"userId\\\\\\",\\\\\\"instanceId\\\\\\"]\\"\\n ],\\n \\"type\\": \\"Gauge\\",\\n \\"dimensionDescription\\": [\\n {\\n \\"name\\": \\"user_id\\"\\n }\\n ],\\n \\"statistics\\": \\"Maximum\\",\\n \\"periods\\": \\"60\\",\\n \\"metaFormat\\": \\"PROM_BASIC\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeRegions' => [ + 'path' => '/regions', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'policyId', - 'in' => 'path', - 'schema' => [ - 'title' => '接入中心策略ID。', - 'description' => '接入中心策略ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-1d4634924c8ba599822c601fcee3', - ], - ], - [ - 'name' => 'addonReleaseName', + 'name' => 'language', 'in' => 'query', 'schema' => [ - 'title' => 'Addon Release名称。', - 'description' => 'Addon Release名称。', + 'description' => '语言，取值：'."\n" + ."\n" + .'- zh：中文（默认值）'."\n" + .'- en：英文'."\n" + .'- ja：日文', 'type' => 'string', 'required' => false, - 'example' => 'release-123456789', + 'enumValueTitles' => ['ja' => 'ja', 'en' => 'en', 'zh' => 'zh'], + 'example' => 'zh', ], ], - [ - 'name' => 'namespace', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '命名空间。', - 'description' => '命名空间。', - 'type' => 'string', - 'required' => false, - 'example' => 'default', + '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' => '8FDE2569-626B-5176-9844-28877A*****'], + 'regions' => [ + 'description' => '地域信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '地域信息', + 'type' => 'object', + 'properties' => [ + 'regionId' => ['description' => '区域ID', 'type' => 'string', 'example' => 'cn-beijing'], + 'localName' => ['description' => '地域名称', 'type' => 'string', 'example' => 'China (Beijing)'], + ], + ], + ], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询地域列表', + 'summary' => '查询地域信息列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"regions\\": [\\n {\\n \\"regionId\\": \\"cn-beijing\\",\\n \\"localName\\": \\"China (Beijing)\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ExecuteQuery' => [ + 'path' => '/workspace/{workspace}/dataset/{datasetName}/query', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'maxLength' => 64, 'minLength' => 2], + ], [ - 'name' => 'encryptYaml', - 'in' => 'query', + 'name' => 'datasetName', + 'in' => 'path', + 'schema' => ['description' => '数据集名称', 'type' => 'string', 'required' => true, 'example' => 'test_dataset', 'maxLength' => 64, 'minLength' => 2], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '是否加密Yaml。', - 'description' => '是否加密Yaml。', - 'type' => 'boolean', + 'description' => '请求参数', + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => '类型', 'type' => 'string', 'required' => true, 'example' => 'SQL'], + 'query' => ['description' => '查询内容', 'type' => 'string', 'required' => true, 'example' => 'SELECT count(1) from "datasetname"'], + ], 'required' => false, - 'example' => 'true', ], ], ], @@ -11041,201 +8833,256 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '响应数据', 'type' => 'object', 'properties' => [ - 'clusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'et15prod-et15storage', + 'requestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '3B311FD9-A60B-55E0-A896-A0C73*********'], + 'meta' => [ + 'description' => '元数据', + 'type' => 'object', + 'properties' => [ + 'affectedRows' => ['description' => '扫描/处理的日志行数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'elapsedMillisecond' => ['description' => '本次执行消耗的毫秒时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1231243'], + 'progress' => ['title' => '查询的结果是否完整', 'description' => '查询的结果是否完整', 'type' => 'string', 'example' => 'Complete'], + 'count' => ['title' => '本次查询请求返回的日志行数。', 'description' => '本次查询请求返回的日志行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], ], - 'podMonitors' => [ - 'description' => 'PodMontior列表', + 'data' => [ + 'title' => '日志数据数组，每条日志对应一个元素', + 'description' => '日志数据数组，每条日志对应一个元素', 'type' => 'array', 'items' => [ - 'description' => 'PodMontior列表', + 'description' => '日志数据数组', 'type' => 'object', - 'properties' => [ - 'addonName' => [ - 'description' => 'Addon 名称。', - 'type' => 'string', - 'example' => 'cloud-ecs', - ], - 'addonReleaseName' => [ - 'description' => 'AddonRelease名称。', - 'type' => 'string', - 'example' => 'release-2345678', - ], - 'addonVersion' => [ - 'description' => 'Addon版本。', - 'type' => 'string', - 'example' => '0.0.1', - ], - 'configYaml' => [ - 'description' => '配置yaml。', - 'type' => 'string', - 'example' => 'apiVersion: xxxxx', - ], - 'enableStatus' => [ - 'description' => '启用状态。', - 'type' => 'string', - 'example' => 'run', - ], - 'encryptYaml' => [ - 'description' => '加密yaml。', - 'type' => 'boolean', - 'example' => 'YXBpVmVyc2lvbjogeHh4eHgK', + 'additionalProperties' => ['title' => '返回的日志。', 'description' => '返回的日志', 'type' => 'string', 'example' => '{\'remote_addr\': \'198.51.XXX.XXX\', \'pv\': \'1\', \'__source__\': \'\', \'__time__\': \'1649902984\'}'], + ], + ], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '执行 sql、spl 等查询接口', + 'summary' => '执行 sql、spl 等查询接口', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3B311FD9-A60B-55E0-A896-A0C73*********\\",\\n \\"meta\\": {\\n \\"affectedRows\\": 1,\\n \\"elapsedMillisecond\\": 1231243,\\n \\"progress\\": \\"Complete\\",\\n \\"count\\": 1\\n },\\n \\"data\\": [\\n {\\n \\"key\\": \\"{\'remote_addr\': \'198.51.XXX.XXX\', \'pv\': \'1\', \'__source__\': \'\', \'__time__\': \'1649902984\'}\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetAddon' => [ + 'summary' => '获取插件详情(Addon)。', + 'path' => '/addons/{addonName}', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'addonName', + 'in' => 'path', + 'schema' => ['title' => '查询参数', 'description' => '查询参数', 'type' => 'string', 'required' => true, 'example' => 'security-actiontrail'], + ], + [ + 'name' => 'version', + 'in' => 'query', + 'schema' => ['title' => 'Addon版本号', 'description' => 'Addon版本号', 'type' => 'string', 'required' => false, 'example' => '*'], + ], + [ + 'name' => 'aliyunLang', + 'in' => 'query', + 'schema' => ['title' => '语言环境,默认为中文 zh | en', 'description' => '语言环境,默认为中文 zh | en', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => '请求头对应的数据列表', + 'type' => 'object', + 'properties' => [ + 'alias' => ['description' => '接入组件别名。', 'type' => 'string', 'example' => 'resume_vector_alias'], + 'categories' => [ + 'description' => '接入组件分类目录列表。', + 'type' => 'array', + 'items' => ['description' => '分类目录名称', 'type' => 'string', 'example' => 'alibaba-cloud-service'], + ], + 'dashboards' => [ + 'description' => '仪表盘的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '仪表盘信息。', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => '仪表盘描述。', 'type' => 'string', 'example' => 'test'], + 'name' => ['description' => '仪表盘名称。', 'type' => 'string', 'example' => 'rum_api_dot_metric_set'], + 'url' => ['description' => '效果图URL地址。', 'type' => 'string', 'example' => 'http://iac-service-transfer.oss-cn-hangzhou.aliyuncs.com/78c5_288850010070719968_bdcf7cca781844c8ac4add133791713f'], + ], ], - 'endpoints' => [ - 'description' => '实例的接入点。', - 'type' => 'array', - 'items' => [ - 'description' => 'Endpoint详情', - 'type' => 'object', - 'properties' => [ - 'interval' => [ - 'description' => '采集间隔', - 'type' => 'string', - 'example' => '30s', - ], - 'matchedTargetCount' => [ - 'description' => '匹配的target数量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'path' => [ - 'description' => '指标采集路径', - 'type' => 'string', - 'example' => '/metrics', + ], + 'description' => ['description' => 'Addon描述', 'type' => 'string', 'example' => 'o11y-demo-cn-heyuan'], + 'environments' => [ + 'description' => '环境信息。', + 'type' => 'array', + 'items' => [ + 'description' => '单个环境信息。', + 'type' => 'object', + 'properties' => [ + 'enable' => ['description' => '是否启用', 'type' => 'boolean', 'example' => 'false'], + 'label' => ['description' => '环境展示名称。', 'type' => 'string', 'example' => '容器环境'], + 'dependencies' => [ + 'description' => '附加依赖文件。', + 'type' => 'object', + 'properties' => [ + 'clusterTypes' => [ + 'description' => '对集群类型的依赖。', + 'type' => 'array', + 'items' => ['description' => '对集群类型的依赖。', 'type' => 'string', 'example' => 'ManagedKubernetes/Default'], + ], + 'features' => [ + 'description' => '对探针的依赖。', + 'type' => 'object', + 'additionalProperties' => ['type' => 'boolean', 'description' => '是否依赖目标探针组件', 'example' => 'true'], + ], + 'services' => [ + 'description' => '对开通服务的依赖', + 'type' => 'array', + 'items' => ['description' => '服务名称', 'type' => 'string', 'example' => 'Prometheus'], + ], ], - 'port' => [ - 'description' => '端口号', - 'type' => 'string', - 'example' => '9100', + ], + 'description' => ['description' => '描述', 'type' => 'string', 'example' => 'Observability integration.'], + 'name' => ['description' => 'Addon名称。', 'type' => 'string', 'example' => 'cs-default-umodel-1752755202744_k8s.metric.high_level_metric_deployment_cn-hangzhou/c0a686118449c4390b9cc0a07ea3e0e85'], + 'policies' => [ + 'description' => '资源组ID。', + 'type' => 'object', + 'properties' => [ + 'alertDefaultStatus' => ['description' => '告警规则默认策略的启用状态。', 'type' => 'string', 'example' => 'true'], + 'defaultInstall' => ['description' => '是否默认安装', 'type' => 'boolean', 'example' => 'true'], + 'enableServiceAccount' => ['description' => '是否分配 Service Account 用以与 Console API 通信。', 'type' => 'boolean', 'example' => 'true'], + 'metricCheckRule' => [ + 'description' => '指标检测规则。', + 'type' => 'object', + 'properties' => [ + 'promQL' => [ + 'description' => '安装后数据检查规则', + 'type' => 'array', + 'items' => ['description' => '安装后数据检查规则', 'type' => 'string', 'example' => 'up=1'], + ], + ], + ], + 'needRestartAfterIntegration' => ['description' => '是否在插件接入时完成安装后即进入 Pod 重启引导。', 'type' => 'boolean', 'example' => 'true'], + 'protocols' => [ + 'description' => '协议。', + 'type' => 'array', + 'items' => [ + 'description' => '协议。', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => '协议说明', 'type' => 'string', 'example' => 'Support OpenTelemetry Protocol'], + 'icon' => ['description' => '图标地址', 'type' => 'string', 'example' => 'icon URL'], + 'label' => ['description' => '协议展示名称。', 'type' => 'string', 'example' => 'OpenTelemetry'], + 'name' => ['description' => '协议名称。', 'type' => 'string', 'example' => 'OpenTelemetry'], + ], + ], + ], + 'targetAddonName' => ['description' => '跳转的目标 Addon 名称', 'type' => 'string', 'example' => 'cs-default'], ], - 'targetPort' => [ - 'description' => '目标端口', - 'type' => 'string', - 'example' => 'https', + ], + 'policyType' => ['description' => '接入策略类型。', 'type' => 'string', 'example' => 'CS'], + 'commonSchemaRefs' => [ + 'description' => '关联的Common Schema列表', + 'type' => 'array', + 'items' => [ + 'description' => '关联的Common Schema信息', + 'type' => 'object', + 'properties' => [ + 'group' => ['description' => 'CommonSchema 的分组名称', 'type' => 'string', 'example' => 'acs-ecs'], + 'version' => ['description' => 'CommonSchema 的版本', 'type' => 'string', 'example' => '0.1.3'], + ], ], ], ], ], - 'matchedPodCount' => [ - 'description' => '匹配pod的数量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'name' => [ - 'description' => '采集名称。', - 'type' => 'string', - 'example' => 'znzmo_entity_test', - ], - 'namespace' => [ - 'description' => '命名空间', - 'type' => 'string', - 'example' => 'sla-ns-d5aeb2b4f91b47', - ], ], + 'icon' => ['description' => '图标地址', 'type' => 'string', 'example' => 'https://xxxxx'], + 'keywords' => [ + 'description' => '关键词', + 'type' => 'array', + 'items' => ['description' => '关键词', 'type' => 'string', 'example' => 'metrics'], + ], + 'language' => ['description' => '语言。', 'type' => 'string', 'example' => 'zh'], + 'latestReleaseCreateTime' => ['description' => '最新一次创建时间。', 'type' => 'string', 'example' => '2023-09-12 12:30:30'], + 'name' => ['description' => 'Addon名称。', 'type' => 'string', 'example' => 'rum_api_dashboard_explorer_link_metric_set'], + 'once' => ['description' => '是否只能安装一次。', 'type' => 'boolean', 'example' => 'true'], + 'scene' => ['description' => '组件场景。', 'type' => 'string', 'example' => 'middleware'], + 'version' => ['description' => '组件版本。', 'type' => 'string', 'example' => '*'], + 'weight' => ['description' => '权重值。', 'type' => 'string', 'example' => '10'], ], ], - 'policyId' => [ - 'description' => '策略 ID。', - 'type' => 'string', - 'example' => 'policy-c9efed2b99c348d49e589c5f780fc074', - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"alias\\": \\"resume_vector_alias\\",\\n \\"categories\\": [\\n \\"alibaba-cloud-service\\"\\n ],\\n \\"dashboards\\": [\\n {\\n \\"description\\": \\"test\\",\\n \\"name\\": \\"rum_api_dot_metric_set\\",\\n \\"url\\": \\"http://iac-service-transfer.oss-cn-hangzhou.aliyuncs.com/78c5_288850010070719968_bdcf7cca781844c8ac4add133791713f\\"\\n }\\n ],\\n \\"description\\": \\"o11y-demo-cn-heyuan\\",\\n \\"environments\\": [\\n {\\n \\"enable\\": false,\\n \\"label\\": \\"容器环境\\",\\n \\"dependencies\\": {\\n \\"clusterTypes\\": [\\n \\"ManagedKubernetes/Default\\"\\n ],\\n \\"features\\": {\\n \\"key\\": true\\n },\\n \\"services\\": [\\n \\"Prometheus\\"\\n ]\\n },\\n \\"description\\": \\"Observability integration.\\",\\n \\"name\\": \\"cs-default-umodel-1752755202744_k8s.metric.high_level_metric_deployment_cn-hangzhou/c0a686118449c4390b9cc0a07ea3e0e85\\",\\n \\"policies\\": {\\n \\"alertDefaultStatus\\": \\"true\\",\\n \\"defaultInstall\\": true,\\n \\"enableServiceAccount\\": true,\\n \\"metricCheckRule\\": {\\n \\"promQL\\": [\\n \\"up=1\\"\\n ]\\n },\\n \\"needRestartAfterIntegration\\": true,\\n \\"protocols\\": [\\n {\\n \\"description\\": \\"Support OpenTelemetry Protocol\\",\\n \\"icon\\": \\"icon URL\\",\\n \\"label\\": \\"OpenTelemetry\\",\\n \\"name\\": \\"OpenTelemetry\\"\\n }\\n ],\\n \\"targetAddonName\\": \\"cs-default\\"\\n },\\n \\"policyType\\": \\"CS\\",\\n \\"commonSchemaRefs\\": [\\n {\\n \\"group\\": \\"acs-ecs\\",\\n \\"version\\": \\"0.1.3\\"\\n }\\n ]\\n }\\n ],\\n \\"icon\\": \\"https://xxxxx\\",\\n \\"keywords\\": [\\n \\"metrics\\"\\n ],\\n \\"language\\": \\"zh\\",\\n \\"latestReleaseCreateTime\\": \\"2023-09-12 12:30:30\\",\\n \\"name\\": \\"rum_api_dashboard_explorer_link_metric_set\\",\\n \\"once\\": true,\\n \\"scene\\": \\"middleware\\",\\n \\"version\\": \\"*\\",\\n \\"weight\\": \\"10\\"\\n },\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8\\"\\n}","type":"json"}]', + 'title' => '获取 Addon 配置详情', + 'description' => '获取Addon详情。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"clusterId\\": \\"et15prod-et15storage\\",\\n \\"podMonitors\\": [\\n {\\n \\"addonName\\": \\"cloud-ecs\\",\\n \\"addonReleaseName\\": \\"release-2345678\\",\\n \\"addonVersion\\": \\"0.0.1\\",\\n \\"configYaml\\": \\"apiVersion: xxxxx\\",\\n \\"enableStatus\\": \\"run\\",\\n \\"encryptYaml\\": true,\\n \\"endpoints\\": [\\n {\\n \\"interval\\": \\"30s\\",\\n \\"matchedTargetCount\\": 1,\\n \\"path\\": \\"/metrics\\",\\n \\"port\\": \\"9100\\",\\n \\"targetPort\\": \\"https\\"\\n }\\n ],\\n \\"matchedPodCount\\": 3,\\n \\"name\\": \\"znzmo_entity_test\\",\\n \\"namespace\\": \\"sla-ns-d5aeb2b4f91b47\\"\\n }\\n ],\\n \\"policyId\\": \\"policy-c9efed2b99c348d49e589c5f780fc074\\",\\n \\"requestId\\": \\"CD8BA7D6-995D-578D-9941-78B0FECD14B5\\"\\n}","type":"json"}]', - 'title' => '查询接入中心策略的PodMonitor资源', - 'description' => '本文将提供一个示例，查询报警模板列表。返回结果显示，报警模板列表中共有2个报警模板，分别是`ECS_Template1`和`ECS_Template2`。', + 'ramActions' => [], ], - 'ListIntegrationPolicyDashboards' => [ - 'summary' => '查询大盘列表。', - 'path' => '/integration-policies/{policyId}/dashboards', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetAddonCodeTemplate' => [ + 'path' => '/addons/{addonName}/alert-code-template', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'policyId', + 'name' => 'addonName', 'in' => 'path', - 'schema' => [ - 'description' => '策略 ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e', - ], + 'schema' => ['title' => 'Addon的名称信息', 'description' => 'Addon的名称信息', 'type' => 'string', 'required' => true, 'example' => 'apm-opentelemetry'], ], [ - 'name' => 'addonName', + 'name' => 'aliyunLang', 'in' => 'query', - 'schema' => [ - 'description' => 'Addon 名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'cs-default', - ], + 'schema' => ['title' => '语言环境,默认为中文 zh | en', 'description' => '语言环境,默认为中文 zh | en', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], [ - 'name' => 'scene', + 'name' => 'environmentType', 'in' => 'query', - 'schema' => [ - 'description' => '组件场景。', - 'type' => 'string', - 'required' => false, - 'example' => 'databse', - ], + 'schema' => ['title' => '环境类型 CS(容器) | ECS', 'description' => '环境类型 CS(容器) | ECS', 'type' => 'string', 'required' => false, 'example' => 'Client'], ], [ - 'name' => 'language', + 'name' => 'version', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => '查询语言。', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - 'default' => 'zh', - 'enum' => [ - 'zh', - 'en', - ], - ], + 'schema' => ['description' => '组件版本。', 'type' => 'string', 'required' => false, 'example' => '0.1.0'], ], ], 'responses' => [ @@ -11245,1246 +9092,1217 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5', - ], - 'total' => [ - 'description' => '组件数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'dashboards' => [ - 'description' => '仪表盘的列表。', + 'codes' => [ + 'description' => '代码模版信息列表', 'type' => 'array', 'items' => [ - 'description' => '仪表盘的列表。', 'type' => 'object', 'properties' => [ - 'uid' => [ - 'description' => '当前阿里云主账号的ID，只读', - 'type' => 'string', - 'example' => '1258199346721590', - ], - 'engine' => [ - 'title' => '大盘引擎：'."\n" - .'grafana：共享grafana。'."\n" - .'cms：cms自研大盘引擎。', - 'description' => '大盘引擎：'."\n" - .'grafana：共享grafana。'."\n" - .'cms：cms自研大盘引擎。', - 'type' => 'string', - 'example' => 'grafana', - ], - 'title' => [ - 'description' => 'UI模块的标题（非name）', - 'type' => 'string', - 'example' => 'test', - ], - 'name' => [ - 'title' => '大盘名称', - 'description' => '大盘名称', - 'type' => 'string', - 'example' => 'k8s-pod', - ], - 'url' => [ - 'description' => 'pagerDuty的集成webhook。支持V1和V2版', - 'type' => 'string', - 'example' => 'https://agi.alicdn.com/user/0/0_0_5255362686.png?x-oss-process=image/quality,q_75/format,jpg&file=1734574878007.jpg', - ], - 'region' => [ - 'description' => '地域', - 'type' => 'string', - 'example' => 'cn-hongkong', - ], - 'folderUid' => [ - 'description' => '大盘目录UID。', - 'type' => 'string', - 'example' => 'Env-AAA', - ], - 'tags' => [ - 'description' => '标签列表。', - 'type' => 'array', - 'items' => [ - 'description' => '标签。', - 'type' => 'string', - 'example' => 'tag1', - ], - ], + 'codeTemplate' => ['description' => '代码模版', 'type' => 'string', 'example' => 'javascript\\nnpm install @arms/rum-miniapp --save'], + 'name' => ['description' => '代码模版名称', 'type' => 'string', 'example' => 'cs-default-CS-cs-default-1753236205394-cs-default-CS-kubeApiserver'], ], + 'description' => '', ], ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-***'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取Addon内代码模版', + 'summary' => '插件schema详情(Addon)', + 'description' => '本文将提供一个示例，修改版本`1`的报警模板`123456`，将报警级别修改为`Critical`，报警统计方法修改为`Average`，报警阈值比较符修改为`GreaterThanOrEqualToThreshold`，报警阈值修改为`90`，报警重试次数修改为`3`。返回结果显示，修改报警模板成功。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CD8BA7D6-995D-578D-9941-78B0FECD14B5\\",\\n \\"total\\": 1,\\n \\"dashboards\\": [\\n {\\n \\"uid\\": \\"1258199346721590\\",\\n \\"engine\\": \\"grafana\\",\\n \\"title\\": \\"test\\",\\n \\"name\\": \\"k8s-pod\\",\\n \\"url\\": \\"https://agi.alicdn.com/user/0/0_0_5255362686.png?x-oss-process=image/quality,q_75/format,jpg&file=1734574878007.jpg\\",\\n \\"region\\": \\"cn-hongkong\\",\\n \\"folderUid\\": \\"Env-AAA\\",\\n \\"tags\\": [\\n \\"tag1\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询大盘列表', - 'description' => '本文将提供一个示例，查询报警模板列表。返回结果显示，报警模板列表中共有2个报警模板，分别是`ECS_Template1`和`ECS_Template2`。', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"codes\\": [\\n {\\n \\"codeTemplate\\": \\"javascript\\\\\\\\nnpm install @arms/rum-miniapp --save\\",\\n \\"name\\": \\"cs-default-CS-cs-default-1753236205394-cs-default-CS-kubeApiserver\\"\\n }\\n ],\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-***\\"\\n}","type":"json"}]', ], - 'ListIntegrationPolicyCustomScrapeJobRules' => [ - 'summary' => '获取接入中心策略的自定义服务发现规则。', - 'path' => '/integration-policies/{policyId}/custom-scrape-job-rules', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetAddonRelease' => [ + 'path' => '/integration-policies/{policyId}/addon-releases/{releaseName}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ + 'name' => 'releaseName', + 'in' => 'path', + 'schema' => ['title' => 'AddonRelease 的名称。', 'description' => 'AddonRelease 的名称', 'type' => 'string', 'required' => true, 'example' => 'test-gpu-integration-name'], + ], + [ 'name' => 'policyId', 'in' => 'path', + 'schema' => ['title' => '环境 ID。', 'description' => '环境 ID', 'type' => 'string', 'required' => true, 'example' => 'policy-xxxxxxxxxxxx'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '接入中心策略ID。', - 'description' => '接入中心策略ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-d95435164593aece55f9999ce45c', + 'type' => 'object', + 'properties' => [ + 'config' => ['title' => '组件配置。', 'description' => '组件配置。', 'type' => 'string', 'example' => '{"install":{"mode":"auto-install","listenPort":"9400"},"discoverMode":"instances","discover":{"instances":"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44"},"scrapeInterval":"15","enableSecuritecs-nodeyGroupInjection":"true","metricTags":""}'], + 'release' => [ + 'description' => '详细信息。', + 'type' => 'object', + 'properties' => [ + 'addonName' => ['title' => '组件 Addon 名称。', 'description' => '组件 Addon 名称。', 'type' => 'string', 'example' => 'cs-gpu'], + 'alertRuleCount' => ['title' => '告警规则数量。', 'description' => '告警规则数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '6'], + 'conditions' => [ + 'title' => '安装阶段状况信息汇总。'."\n" + ."\n" + .'Type 包括四个：Loaded（加载配置），Installed（执行安装），Ready（执行安装后就绪检查），UnInstalled（执行卸载）。四个状况理论上顺序出现。'."\n" + ."\n" + .'Status: 可选值包括：Unknown(正处在当前阶段执行)，True（执行就绪），False（执行失败）'."\n" + ."\n" + .'完整状态判断说明：'."\n" + .'Loaded，Installed，Ready 只要有一个的 Status=False，则代表安装失败，Ready 的 Status=True，则代表安装成功，其他情况则代表正在安装中。'."\n" + ."\n" + .'UnInstalled 只要存在，则代表正在执行卸载。Status=True 则代表卸载成功，Status=Unknown 代表执行卸载中，Status=False 代表卸载失败。', + 'description' => '安装阶段信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'firstTransitionTime' => ['title' => '第一次转换时间。', 'description' => '第一次转换时间。', 'type' => 'string', 'example' => '2024-11-04T16:10:22+08:00'], + 'lastTransitionTime' => ['title' => '最后一次转换时间。', 'description' => '最后一次转换时间。', 'type' => 'string', 'example' => '2024-11-04T16:10:22+08:00'], + 'message' => ['title' => '详细信息。', 'description' => '详细信息。', 'type' => 'string', 'example' => 'The addon loaded successfully'], + 'status' => ['title' => '阶段状态。', 'description' => '阶段状态。', 'type' => 'string', 'example' => 'True'], + 'type' => ['title' => '阶段类型。', 'description' => '阶段类型。', 'type' => 'string', 'example' => 'Loaded'], + ], + 'description' => '', + ], + ], + 'config' => ['title' => '组件配置信息。', 'description' => '组件配置信息。', 'type' => 'string', 'example' => '{"install":{"mode":"auto-install","listenPort":"9400"},"discoverMode":"instances","discover":{"instances":"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44"},"scrapeInterval":"15","enableSecuritecs-nodeyGroupInjection":"true","metricTags":""}'], + 'createTime' => ['title' => '接入时间。', 'description' => '接入时间。', 'type' => 'string', 'example' => '2024-11-04T16:10:12+08:00'], + 'dashboardCount' => ['title' => '大盘数量。', 'description' => '大盘数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'environmentId' => ['title' => '环境 ID。', 'description' => '环境 ID。', 'type' => 'string', 'example' => 'policy-xxxxxxxxxxx'], + 'exporterCount' => ['title' => '插件数量。', 'description' => '插件数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'haveConfig' => ['title' => '是否有配置。', 'description' => '是否有配置。', 'type' => 'boolean', 'example' => 'true'], + 'installUserId' => ['title' => '接入用户 ID。', 'description' => '接入用户 ID。', 'type' => 'string', 'example' => '1707xxxxxxxxxxxx'], + 'language' => ['title' => '语言。', 'description' => '语言。', 'type' => 'string', 'example' => 'zh'], + 'managed' => ['title' => '是否为托管组件。', 'description' => '是否为托管组件。', 'type' => 'boolean', 'example' => 'true'], + 'parentAddonReleaseId' => ['title' => '父级 AddonReleaseId。', 'description' => '父级 AddonReleaseId。', 'type' => 'string', 'example' => 'policy-xxxxxxxxxxxxx'], + 'policyId' => ['title' => '策略 ID。', 'description' => '策略 ID。', 'type' => 'string', 'example' => 'policy-xxxxxxxxxxxxx'], + 'regionId' => ['title' => '区域 ID。', 'description' => '区域 ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'releaseId' => ['title' => 'Release ID。', 'description' => 'Release ID。', 'type' => 'string', 'example' => '7339d808-66f9-4d40-83fa-xxxxxxxxxxx'], + 'releaseName' => ['title' => 'Release 的名称。', 'description' => 'Release 的名称。', 'type' => 'string', 'example' => 'test-gpu-integration-name'], + 'scene' => ['title' => '组件场景。', 'description' => '组件场景。', 'type' => 'string', 'example' => 'container'], + 'status' => ['title' => '组件状态。', 'description' => '组件状态。', 'type' => 'string', 'example' => 'running'], + 'updateTime' => ['title' => '更新时间。', 'description' => '更新时间。', 'type' => 'string', 'example' => '2024-11-04T16:10:12+08:00'], + 'userId' => ['title' => '所属用户 ID。', 'description' => '所属用户 ID。', 'type' => 'string', 'example' => '1707xxxxxxxxxxxx'], + 'version' => ['title' => '组件版本。', 'description' => '组件版本。', 'type' => 'string', 'example' => '0.0.2'], + 'envType' => ['title' => '环境类型。', 'description' => '环境类型。', 'type' => 'string', 'example' => 'CS'], + 'workspace' => ['title' => '工作空间。', 'description' => '工作空间。', 'type' => 'string', 'example' => 'default'], + 'entityRules' => ['title' => '实体详情。', 'description' => '实体详情。', '$ref' => '#/components/schemas/EntityGroupBase'], + ], + ], + 'requestId' => ['title' => '请求 ID。', 'description' => '请求 ID。', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查看接入组件信息', + 'summary' => '查看addon release(查看接入状态)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '210', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAddonRelease'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'addonReleaseName', - 'in' => 'query', - 'schema' => [ - 'title' => 'Addon Release名称。', - 'description' => 'Addon Release名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'release12345678', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetAddonRelease', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'AddonRelease', 'arn' => 'acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#PolicyId}/addonrelease/{#ReleaseName}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"config\\": \\"{\\\\\\"install\\\\\\":{\\\\\\"mode\\\\\\":\\\\\\"auto-install\\\\\\",\\\\\\"listenPort\\\\\\":\\\\\\"9400\\\\\\"},\\\\\\"discoverMode\\\\\\":\\\\\\"instances\\\\\\",\\\\\\"discover\\\\\\":{\\\\\\"instances\\\\\\":\\\\\\"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44\\\\\\"},\\\\\\"scrapeInterval\\\\\\":\\\\\\"15\\\\\\",\\\\\\"enableSecuritecs-nodeyGroupInjection\\\\\\":\\\\\\"true\\\\\\",\\\\\\"metricTags\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"release\\": {\\n \\"addonName\\": \\"cs-gpu\\",\\n \\"alertRuleCount\\": 6,\\n \\"conditions\\": [\\n {\\n \\"firstTransitionTime\\": \\"2024-11-04T16:10:22+08:00\\",\\n \\"lastTransitionTime\\": \\"2024-11-04T16:10:22+08:00\\",\\n \\"message\\": \\"The addon loaded successfully\\",\\n \\"status\\": \\"True\\",\\n \\"type\\": \\"Loaded\\"\\n }\\n ],\\n \\"config\\": \\"{\\\\\\"install\\\\\\":{\\\\\\"mode\\\\\\":\\\\\\"auto-install\\\\\\",\\\\\\"listenPort\\\\\\":\\\\\\"9400\\\\\\"},\\\\\\"discoverMode\\\\\\":\\\\\\"instances\\\\\\",\\\\\\"discover\\\\\\":{\\\\\\"instances\\\\\\":\\\\\\"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44\\\\\\"},\\\\\\"scrapeInterval\\\\\\":\\\\\\"15\\\\\\",\\\\\\"enableSecuritecs-nodeyGroupInjection\\\\\\":\\\\\\"true\\\\\\",\\\\\\"metricTags\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"createTime\\": \\"2024-11-04T16:10:12+08:00\\",\\n \\"dashboardCount\\": 3,\\n \\"environmentId\\": \\"policy-xxxxxxxxxxx\\",\\n \\"exporterCount\\": 2,\\n \\"haveConfig\\": true,\\n \\"installUserId\\": \\"1707xxxxxxxxxxxx\\",\\n \\"language\\": \\"zh\\",\\n \\"managed\\": true,\\n \\"parentAddonReleaseId\\": \\"policy-xxxxxxxxxxxxx\\",\\n \\"policyId\\": \\"policy-xxxxxxxxxxxxx\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"releaseId\\": \\"7339d808-66f9-4d40-83fa-xxxxxxxxxxx\\",\\n \\"releaseName\\": \\"test-gpu-integration-name\\",\\n \\"scene\\": \\"container\\",\\n \\"status\\": \\"running\\",\\n \\"updateTime\\": \\"2024-11-04T16:10:12+08:00\\",\\n \\"userId\\": \\"1707xxxxxxxxxxxx\\",\\n \\"version\\": \\"0.0.2\\",\\n \\"envType\\": \\"CS\\",\\n \\"workspace\\": \\"default\\",\\n \\"entityRules\\": {\\n \\"workspace\\": \\"default-cms-1654218***343050-cn-hangzhou\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"entityQueries\\": [\\n {\\n \\"entityType\\": \\"acs.ecs.instance\\",\\n \\"spl\\": \\".entity with(type=\'acs.ecs.instance\') | where region_id in (\'cn-beijing\')\\"\\n }\\n ],\\n \\"description\\": \\"ECS 实例\\",\\n \\"entityGroupId\\": \\"eg-1234567890\\",\\n \\"entityRules\\": {\\n \\"resourceGroupId\\": \\"rg-acfm2m7atreujs1\\",\\n \\"ipMatchRule\\": {\\n \\"ipFieldKey\\": \\"\\",\\n \\"ipCIDR\\": \\"\\"\\n },\\n \\"tags\\": [\\n {\\n \\"tagKey\\": \\"project\\",\\n \\"op\\": \\"in\\",\\n \\"tagValues\\": [\\n \\"demo\\"\\n ]\\n }\\n ],\\n \\"instanceIds\\": [\\n \\"i-bp1gj8wyq4fxk28k6iy2\\"\\n ],\\n \\"entityTypes\\": [\\n \\"acs.ecs.instance\\"\\n ],\\n \\"regionIds\\": [\\n \\"cn-shanghai\\"\\n ],\\n \\"labels\\": [\\n {\\n \\"tagKey\\": \\"project\\",\\n \\"op\\": \\"in\\",\\n \\"tagValues\\": [\\n \\"demo\\"\\n ]\\n }\\n ],\\n \\"annotations\\": [\\n {\\n \\"tagKey\\": \\"instanceId\\",\\n \\"op\\": \\"in\\",\\n \\"tagValues\\": [\\n \\"i-bp1gj8wyq4fxk28k6iy2\\\\n\\"\\n ]\\n }\\n ],\\n \\"fieldRules\\": [\\n {\\n \\"fieldKey\\": \\"instanceId\\",\\n \\"op\\": \\"in\\",\\n \\"fieldValues\\": [\\n \\"i-bp1gj8wyq4fxk28k6iy2\\"\\n ]\\n }\\n ]\\n },\\n \\"entityGroupName\\": \\"ECS 全部实体\\",\\n \\"userId\\": \\"1654218***343050\\"\\n }\\n },\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8\\"\\n}","type":"json"}]', + ], + 'GetAddonSchema' => [ + 'summary' => '插件schema详情(Addon)。', + 'path' => '/addons/{addonName}/schema', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'encryptYaml', + 'name' => 'addonName', + 'in' => 'path', + 'schema' => ['title' => 'Addon的名称信息', 'description' => 'Addon的名称信息', 'type' => 'string', 'required' => true, 'example' => 'cloud-rds-audit-log'], + ], + [ + 'name' => 'aliyunLang', 'in' => 'query', - 'schema' => [ - 'title' => '是否加密Yaml。', - 'description' => '是否加密Yaml。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['title' => '语言环境,默认为中文 zh | en', 'description' => '语言环境,默认为中文 zh | en', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], [ - 'name' => 'namespace', + 'name' => 'environmentType', 'in' => 'query', - 'schema' => [ - 'title' => '命名空间。', - 'description' => '命名空间。', - 'type' => 'string', - 'required' => false, - 'example' => 'arms-prom', - ], + 'schema' => ['title' => '环境类型 CS(容器) | ECS', 'description' => '环境类型 CS(容器) | ECS', 'type' => 'string', 'required' => false, 'example' => 'CS'], + ], + [ + 'name' => 'version', + 'in' => 'query', + 'schema' => ['description' => '组件版本。', 'type' => 'string', 'required' => false, 'example' => '0.1.1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'clusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'et15prod-et15storage', - ], - 'customScrapeJobRules' => [ - 'description' => '自定义采集任务规则', + 'fields' => [ + 'description' => '数据表字段列表。', 'type' => 'array', 'items' => [ - 'description' => '自定义服务发现规则', + 'description' => '数据表字段信息。', 'type' => 'object', 'properties' => [ - 'addonName' => [ - 'description' => 'Addon 名称。', - 'type' => 'string', - 'example' => 'cloud-ecs', - ], - 'addonReleaseName' => [ - 'description' => 'AddonRelease 名称', - 'type' => 'string', - 'example' => 'release-12345678', - ], - 'addonVersion' => [ - 'description' => 'Addon 版本', - 'type' => 'string', - 'example' => '0.0.1', - ], - 'configYaml' => [ - 'description' => '配置yaml', - 'type' => 'string', - 'example' => 'scrape_cofnigs:'."\n" - .'- jobxxxxxx', - ], - 'enableStatus' => [ - 'description' => '启用状态', - 'type' => 'string', - 'example' => 'mini', - ], - 'encryptYaml' => [ - 'description' => '加密yaml', - 'type' => 'boolean', - 'example' => 'true', - ], - 'matchedPodCount' => [ - 'description' => '匹配到的pod数量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'message' => [ - 'description' => '详细信息。', - 'type' => 'string', - 'example' => 'ok', - ], - 'name' => [ - 'description' => '服务名。', - 'type' => 'string', - 'example' => 'dlab1', - ], - 'namespace' => [ - 'description' => '命名空间', - 'type' => 'string', - 'example' => 'prod-data', - ], - 'scrapeConfigs' => [ - 'description' => '自定义配置', + 'conditions' => [ + 'description' => '展示条件列表。', 'type' => 'array', 'items' => [ - 'description' => '自定义配置', + 'description' => '展示条件。', 'type' => 'object', 'properties' => [ - 'jobName' => [ - 'description' => '采集名称', - 'type' => 'string', - 'example' => 'mysql-exporter', - ], - 'message' => [ - 'description' => '详细信息。', - 'type' => 'string', - 'example' => 'successful', - ], - 'metricsPath' => [ - 'description' => '采集path', - 'type' => 'string', - 'example' => '/metrics', - ], - 'scheme' => [ - 'description' => '调用方式。', - 'type' => 'string', - 'example' => 'http', - ], - 'scrapeInterval' => [ - 'description' => '采集间隔', - 'type' => 'string', - 'example' => '30s', - ], - 'scrapeTimeout' => [ - 'description' => '采集超时时间', - 'type' => 'string', - 'example' => '60s', - ], - 'serviceDiscoveryConfigs' => [ - 'description' => '服务发现配置', - 'type' => 'array', - 'items' => [ - 'description' => '服务发现配置', - 'type' => 'string', - 'example' => '{}', + 'action' => ['description' => '字段控制模式。', 'type' => 'string', 'example' => 'show'], + 'field' => ['description' => '字段名称', 'type' => 'string', 'example' => 'store.storageTarget'], + 'op' => ['description' => '判断条件操作符。', 'type' => 'string', 'example' => '=='], + 'value' => ['description' => '判断目标值。', 'type' => 'any', 'example' => 'Custom'], + ], + ], + ], + 'defaultValue' => ['description' => '默认值', 'type' => 'any', 'example' => 'mysql.default'], + 'description' => ['description' => '描述', 'type' => 'string', 'example' => 'MySQL datasource'], + 'disabled' => ['description' => '是否隐藏: true - 隐藏， false - 显示', 'type' => 'boolean', 'example' => 'false'], + 'element' => ['description' => '元素类型。', 'type' => 'string', 'example' => 'input'], + 'fieldPath' => ['description' => '字段路径。', 'type' => 'string', 'example' => 'mysql.host'], + 'label' => ['description' => '字段展示名称。', 'type' => 'string', 'example' => 'mysql'], + 'name' => ['description' => '字段名称。', 'type' => 'string', 'example' => 'host'], + 'placeholder' => ['description' => '输入提示。', 'type' => 'string', 'example' => 'Please enter the metrics collection interval'], + 'props' => [ + 'description' => '组件其他属性。', + 'type' => 'object', + 'properties' => [ + 'dataSource' => [ + 'description' => '数据源信息。', + 'type' => 'array', + 'items' => [ + 'description' => '数据源信息。', + 'type' => 'object', + 'properties' => [ + 'label' => ['description' => '标签。', 'type' => 'string', 'example' => 'tagKey'], + 'value' => ['description' => '标签Value。', 'type' => 'string', 'example' => 'tagValue'], ], ], ], + 'related' => [ + 'description' => '相关的数据集合。', + 'type' => 'array', + 'items' => ['description' => '相关数据。', 'type' => 'string', 'example' => 'mysql.host'], + ], + 'selectMode' => ['description' => '模式。', 'type' => 'string', 'example' => 'single'], + ], + ], + 'type' => ['description' => '字段类型。', 'type' => 'string', 'example' => 'string'], + 'validation' => [ + 'description' => '字段校验规则', + 'type' => 'object', + 'properties' => [ + 'max' => ['description' => '分数区间最大值（包含）', 'type' => 'integer', 'format' => 'int32', 'example' => '2000'], + 'maxLength' => ['description' => '文本控件支持的最大长度。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'message' => ['description' => '详细信息。', 'type' => 'string', 'example' => 'length limit'], + 'min' => ['description' => '最小值。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'minLength' => ['description' => '最短长度。', 'type' => 'integer', 'format' => 'int32', 'example' => '16'], + 'regular' => ['description' => '正则表达式。', 'type' => 'string', 'example' => '^(http|https)://'], + 'required' => ['description' => '参数是否必填。', 'type' => 'boolean', 'example' => 'false'], ], ], ], ], ], - 'policyId' => [ - 'description' => '策略 ID。', - 'type' => 'string', - 'example' => 'policy-15abcc24c06f4797832b5954198e1ed1', - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', - ], + 'requestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E5B1D3D4-BB28-5996-8AD2-***********'], + 'type' => ['description' => 'Schema类型。', 'type' => 'string', 'example' => 'common'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取Addon的Schema信息', + 'description' => '获取Addon的Schema信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"clusterId\\": \\"et15prod-et15storage\\",\\n \\"customScrapeJobRules\\": [\\n {\\n \\"addonName\\": \\"cloud-ecs\\",\\n \\"addonReleaseName\\": \\"release-12345678\\",\\n \\"addonVersion\\": \\"0.0.1\\",\\n \\"configYaml\\": \\"scrape_cofnigs:\\\\n- jobxxxxxx\\",\\n \\"enableStatus\\": \\"mini\\",\\n \\"encryptYaml\\": true,\\n \\"matchedPodCount\\": 1,\\n \\"message\\": \\"ok\\",\\n \\"name\\": \\"dlab1\\",\\n \\"namespace\\": \\"prod-data\\",\\n \\"scrapeConfigs\\": [\\n {\\n \\"jobName\\": \\"mysql-exporter\\",\\n \\"message\\": \\"successful\\",\\n \\"metricsPath\\": \\"/metrics\\",\\n \\"scheme\\": \\"http\\",\\n \\"scrapeInterval\\": \\"30s\\",\\n \\"scrapeTimeout\\": \\"60s\\",\\n \\"serviceDiscoveryConfigs\\": [\\n \\"{}\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"policyId\\": \\"policy-15abcc24c06f4797832b5954198e1ed1\\",\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', - 'title' => '获取接入中心策略的自定义服务发现规则', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"fields\\": [\\n {\\n \\"conditions\\": [\\n {\\n \\"action\\": \\"show\\",\\n \\"field\\": \\"store.storageTarget\\",\\n \\"op\\": \\"==\\",\\n \\"value\\": \\"Custom\\"\\n }\\n ],\\n \\"defaultValue\\": \\"mysql.default\\",\\n \\"description\\": \\"MySQL datasource\\",\\n \\"disabled\\": false,\\n \\"element\\": \\"input\\",\\n \\"fieldPath\\": \\"mysql.host\\",\\n \\"label\\": \\"mysql\\",\\n \\"name\\": \\"host\\",\\n \\"placeholder\\": \\"Please enter the metrics collection interval\\",\\n \\"props\\": {\\n \\"dataSource\\": [\\n {\\n \\"label\\": \\"tagKey\\",\\n \\"value\\": \\"tagValue\\"\\n }\\n ],\\n \\"related\\": [\\n \\"mysql.host\\"\\n ],\\n \\"selectMode\\": \\"single\\"\\n },\\n \\"type\\": \\"string\\",\\n \\"validation\\": {\\n \\"max\\": 2000,\\n \\"maxLength\\": 100,\\n \\"message\\": \\"length limit\\",\\n \\"min\\": 0,\\n \\"minLength\\": 16,\\n \\"regular\\": \\"^(http|https)://\\",\\n \\"required\\": false\\n }\\n }\\n ],\\n \\"requestId\\": \\"E5B1D3D4-BB28-5996-8AD2-***********\\",\\n \\"type\\": \\"common\\"\\n}","type":"json"}]', ], - 'ListIntegrationPolicies' => [ - 'summary' => '查询接入中心策略列表信息', - 'path' => '/integration-policies', - 'methods' => [ - 'get', + 'GetAggTaskGroup' => [ + 'summary' => '查询聚合任务组详情。', + 'path' => '/prometheus-instances/{instanceId}/agg-task-groups/{groupId}', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['title' => '聚合任务组所属的 Prometheus 实例的 id，聚合任务从这个实例中读取数据', 'description' => '聚合任务组所属的 Prometheus 实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rw-xxx'], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => ['title' => '聚合任务组 id', 'description' => '聚合任务组ID。', 'type' => 'string', 'required' => true, 'example' => 'aggTaskGroup-xxx'], + ], ], - 'schemes' => [ - 'https', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '出参结构体', + 'description' => '出参结构体。', + 'type' => 'object', + 'properties' => [ + 'aggTaskGroup' => [ + 'title' => '聚合任务组', + 'description' => '聚合任务组。', + 'type' => 'object', + 'properties' => [ + 'aggTaskGroupConfig' => ['title' => '聚合任务组配置', 'description' => '聚合任务组配置。', 'type' => 'string', 'example' => 'groups:'."\n" + .'- name: "node.rules"'."\n" + .' interval: "60s"'."\n" + .' rules:'."\n" + .' - record: "node_namespace_pod:kube_pod_info:"'."\n" + .' expr: "max(label_replace(kube_pod_info{job=\\"kubernetes-pods-kube-state-metrics\\"\\'."\n" + .' }, \\"pod\\", \\"$1\\", \\"pod\\", \\"(.*)\\")) by (node, namespace, pod, cluster)"'], + 'aggTaskGroupConfigHash' => ['title' => '聚合任务组配置的摘要', 'description' => '聚合任务组配置的摘要。', 'type' => 'string', 'example' => 'a54136xxx'], + 'aggTaskGroupId' => ['title' => '聚合任务组 id', 'description' => '聚合任务组ID。', 'type' => 'string', 'example' => 'aggTaskGroup-xx'], + 'aggTaskGroupName' => ['title' => '聚合任务组名称', 'description' => '聚合任务组名称。', 'type' => 'string', 'example' => 'pipeline-aggtask-group'], + 'cronExpr' => ['title' => '调度模式选择“Cron”情况下，聚合任务组的调度表达式', 'description' => '调度模式选择“Cron”情况下，聚合任务组的调度表达式。', 'type' => 'string', 'example' => '0 1 3 * * ? *'], + 'delay' => ['title' => '调度的固定延迟时间', 'description' => '调度的固定延迟时间（秒）。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'description' => ['title' => '聚合任务组描述'."\n" + ."\n", 'description' => '聚合任务组描述。', 'type' => 'string', 'example' => 'test'], + 'fromTime' => ['title' => '调度开始时间对应的的秒级时间戳', 'description' => '调度开始时间对应的的秒级时间戳（暂未生效）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1757409495'], + 'maxRetries' => ['title' => '执行聚合任务的最大重试次数', 'description' => '执行聚合任务的最大重试次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'maxRunTimeInSeconds' => ['title' => '执行聚合任务的最大重试时间', 'description' => '执行聚合任务的最大重试时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '50'], + 'precheckString' => ['title' => '预检测配置', 'description' => '预检测配置。', 'type' => 'string', 'example' => '{"policy":"skip","prometheusId":"rw-xx","query":"noPrecheck","threshold":0.5,"timeout":15,"type":"none"}'], + 'regionId' => ['title' => '地域 id', 'description' => '地域ID。', 'type' => 'string', 'example' => 'cn-zhangjiakou'], + 'scheduleMode' => ['title' => '调度模式', 'description' => '调度模式。', 'type' => 'string', 'example' => 'FixedRate'], + 'scheduleTimeExpr' => ['title' => '调度时间表达式', 'description' => '调度时间表达式。', 'type' => 'string', 'example' => '@m'], + 'sourcePrometheusId' => ['title' => '聚合任务组的源 Prometheus 实例 id', 'description' => '聚合任务组的源 Prometheus实例ID。', 'type' => 'string', 'example' => 'rw-xxx'], + 'status' => ['title' => '聚合任务组状态', 'description' => '聚合任务组状态。', 'type' => 'string', 'example' => 'Running'], + 'tags' => [ + 'title' => '资源组标签', + 'description' => '资源组标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'key' => ['title' => '资源组标签的键', 'description' => '资源组标签的键。', 'type' => 'string', 'example' => 'key1'], + 'value' => ['title' => '资源组标签的值', 'description' => '资源组标签的值。', 'type' => 'string', 'example' => 'value1'], + ], + ], + ], + 'targetPrometheusId' => ['title' => '聚合任务组的目标 Prometheus 实例 id', 'description' => '聚合任务组的目标 Prometheus 实例ID。', 'type' => 'string', 'example' => 'rw-xxx'], + 'toTime' => ['title' => '调度结束时间对应的秒级时间戳', 'description' => '调度结束时间对应的秒级时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1757409495'], + 'updateTime' => ['title' => '聚合任务组的更新时间', 'description' => '聚合任务组的更新时间（时间戳）。', 'type' => 'string', 'example' => '1757409499000'], + 'userId' => ['title' => '聚合任务组所属用户', 'description' => '聚合任务组所属用户。', 'type' => 'string', 'example' => '123xxx'], + ], + ], + 'requestId' => ['title' => '请求 id', 'description' => '请求 id', 'type' => 'string', 'example' => '68DAF543-35DF-5762-BE90-F5C00B5DC036'], + 'success' => ['title' => '请求是否成功', 'description' => '请求是否成功', 'type' => 'boolean', 'example' => 'True'], + ], + ], + ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询聚合任务组', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAggTaskGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetAggTaskGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'AggTaskGroup', 'arn' => 'acs:cms:{#regionId}:{#accountId}:prometheusinstance/{#sourcePrometheusId}/aggtaskgroup/{#aggTaskGroupId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"aggTaskGroup\\": {\\n \\"aggTaskGroupConfig\\": \\"groups:\\\\n- name: \\\\\\"node.rules\\\\\\"\\\\n interval: \\\\\\"60s\\\\\\"\\\\n rules:\\\\n - record: \\\\\\"node_namespace_pod:kube_pod_info:\\\\\\"\\\\n expr: \\\\\\"max(label_replace(kube_pod_info{job=\\\\\\\\\\\\\\"kubernetes-pods-kube-state-metrics\\\\\\\\\\\\\\"\\\\\\\\\\\\n }, \\\\\\\\\\\\\\"pod\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"$1\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"pod\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"(.*)\\\\\\\\\\\\\\")) by (node, namespace, pod, cluster)\\\\\\"\\",\\n \\"aggTaskGroupConfigHash\\": \\"a54136xxx\\",\\n \\"aggTaskGroupId\\": \\"aggTaskGroup-xx\\",\\n \\"aggTaskGroupName\\": \\"pipeline-aggtask-group\\",\\n \\"cronExpr\\": \\"0 1 3 * * ? *\\",\\n \\"delay\\": 2,\\n \\"description\\": \\"test\\",\\n \\"fromTime\\": 1757409495,\\n \\"maxRetries\\": 2,\\n \\"maxRunTimeInSeconds\\": 50,\\n \\"precheckString\\": \\"{\\\\\\"policy\\\\\\":\\\\\\"skip\\\\\\",\\\\\\"prometheusId\\\\\\":\\\\\\"rw-xx\\\\\\",\\\\\\"query\\\\\\":\\\\\\"noPrecheck\\\\\\",\\\\\\"threshold\\\\\\":0.5,\\\\\\"timeout\\\\\\":15,\\\\\\"type\\\\\\":\\\\\\"none\\\\\\"}\\",\\n \\"regionId\\": \\"cn-zhangjiakou\\",\\n \\"scheduleMode\\": \\"FixedRate\\",\\n \\"scheduleTimeExpr\\": \\"@m\\",\\n \\"sourcePrometheusId\\": \\"rw-xxx\\",\\n \\"status\\": \\"Running\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"key1\\",\\n \\"value\\": \\"value1\\"\\n }\\n ],\\n \\"targetPrometheusId\\": \\"rw-xxx\\",\\n \\"toTime\\": 1757409495,\\n \\"updateTime\\": \\"1757409499000\\",\\n \\"userId\\": \\"123xxx\\"\\n },\\n \\"requestId\\": \\"68DAF543-35DF-5762-BE90-F5C00B5DC036\\",\\n \\"success\\": true\\n}","type":"json"}]', + ], + 'GetBizTrace' => [ + 'summary' => '查询业务链路', + 'path' => '/bizTrace/{bizTraceId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'bizTraceId', + 'in' => 'path', + 'schema' => ['description' => '业务链路id', 'type' => 'string', 'required' => false, 'example' => 'e339260ed64c95d'], + ], ], - 'produces' => [ - 'application/json', + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'item' => ['description' => '业务链路', '$ref' => '#/components/schemas/BizTraceConfig'], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询业务链路', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"item\\": {\\n \\"workspace\\": \\"default-cms-xxxxxxx-cn-hangzhou\\",\\n \\"bizTraceId\\": \\"e339260ed64c95d\\",\\n \\"bizTraceName\\": \\"just test\\",\\n \\"bizTraceCode\\": \\"label_env\\",\\n \\"ruleConfig\\": \\"[{\\\\\\"entrancePid\\\\\\":\\\\\\"xxxxx@b57c44xx6e86\\\\\\",\\\\\\"rpcMatcher\\\\\\":{\\\\\\"matchType\\\\\\":\\\\\\"EQUALS\\\\\\",\\\\\\"pattern\\\\\\":\\\\\\"/createApp\\\\\\"},\\\\\\"characteristics\\\\\\":{\\\\\\"operation\\\\\\":\\\\\\"AND\\\\\\",\\\\\\"rules\\\\\\":[{\\\\\\"target\\\\\\":\\\\\\"CUSTOM_EXTRACT\\\\\\",\\\\\\"matcher\\\\\\":{\\\\\\"matchType\\\\\\":\\\\\\"CONTAINS\\\\\\",\\\\\\"pattern\\\\\\":[]}}]}}]\\",\\n \\"advancedConfig\\": \\"{\\\\\\"sample\\\\\\":{\\\\\\"strategy\\\\\\":\\\\\\"BY_APP\\\\\\"}}\\",\\n \\"createTime\\": \\"2025-12-12 00:00:00\\",\\n \\"regionId\\": \\"cn-beijing\\"\\n }\\n}","type":"json"}]', + ], + 'GetCloudResource' => [ + 'path' => '/cloudresource', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREcms5OJOSH'], + 'tenantRelevance' => 'publicInformation', ], - 'parameters' => [ - [ - 'name' => 'policyId', - 'in' => 'query', + 'parameters' => [], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '策略 ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'policy-93817a401f78435596d745a97d2e85a1', + 'type' => 'object', + 'properties' => [ + 'regionId' => ['description' => '区域 ID', 'type' => 'string', 'example' => 'cn-heyuan'], + 'requestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取云资源中心属性', + 'summary' => '查询云资源中心', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'policyName', - 'in' => 'query', - 'schema' => [ - 'description' => '规则名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'prod-database', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetCloudResource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'CloudResource', 'arn' => 'acs:cms:{#regionId}:{#accountId}:cloudresource'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', + ], + 'GetCloudResourceData' => [ + 'summary' => '查询指定时间内某个云产品的全部实体信息。', + 'path' => '/cloudresource/data', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'policyType', - 'in' => 'query', - 'schema' => [ - 'description' => '策略类型', - 'type' => 'string', - 'required' => false, - 'example' => 'CS', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'addonName', + 'name' => 'from', 'in' => 'query', - 'schema' => [ - 'description' => 'Addon 名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'cs-default', - ], + 'schema' => ['description' => '查询开始时间点。'."\n" + ."\n" + .'Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1721767203'], ], [ - 'name' => 'filterRegionIds', + 'name' => 'to', 'in' => 'query', - 'schema' => [ - 'title' => '指定筛选的regionId（目前仅支持单regioinId，暂不支持多值）。', - 'description' => '用于Region查询，以英文逗号分隔', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing,cn-hangzhou', - ], + 'schema' => ['description' => '查询结束时间点。'."\n" + ."\n" + .'Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1721767203'], ], [ - 'name' => 'resourceGroupId', + 'name' => 'query', 'in' => 'query', - 'schema' => [ - 'description' => '资源组id。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-xxxxx', - ], + 'schema' => ['description' => '查询语句', 'type' => 'string', 'required' => true, 'example' => '.entity with(domain=\'acs\', type=\'acs.k8s.node\') | limit 0, 10'], ], - [ - 'name' => 'tag', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '标签列表。', - 'type' => 'array', - 'items' => [ - 'description' => '标签列表，JSON格式。', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => '标签键', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'title' => 'Schema of Response', + 'description' => '响应体，包含请求的状态、数据等信息。'."\n", + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => '返回数据列表总和', + 'type' => 'array', + 'items' => [ + 'description' => '请求头对应的数据列表', + 'type' => 'array', + 'items' => ['description' => '请求头对应的数据', 'type' => 'string', 'example' => 'data1'], ], - 'value' => [ - 'description' => '标签值', - 'type' => 'string', - 'required' => false, - 'example' => 'value', + ], + 'header' => [ + 'description' => '请求头列表', + 'type' => 'array', + 'items' => ['description' => '请求头', 'type' => 'string', 'example' => 'headerKey'], + ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求 ID', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'responseStatus' => [ + 'description' => '结果状态', + 'type' => 'object', + 'properties' => [ + 'result' => ['description' => '执行结果', 'type' => 'string', 'example' => 'Success,PartialSuccess,Error'], + 'retryPolicy' => ['description' => '重试策略', 'type' => 'string', 'example' => 'None,Once,Continuous'], + 'level' => ['description' => '状态级别', 'type' => 'string', 'example' => 'Info,Warn,Error'], + 'statusItem' => [ + 'description' => '详细的状态信息', + 'type' => 'array', + 'items' => [ + 'description' => '详细的状态信息', + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => '状态码', 'type' => 'string', 'example' => 'Success,ExecuteTimeout,UModelNotExist'], + 'level' => ['description' => '状态级别', 'type' => 'string', 'example' => 'Info,Warn,Error'], + 'message' => ['description' => '消息内容'."\n", 'type' => 'string', 'example' => 'successful'], + 'suggestion' => ['description' => '执行错误时的建议', 'type' => 'string', 'example' => 'Try to reduce the query scope or increase timeout limit, then retry'], + ], + ], + ], + 'executionStates' => ['description' => '执行过程中的信息', 'type' => 'string', 'example' => '{}'], ], ], - 'required' => false, ], - 'required' => false, ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取云产品实体数据', + 'description' => '## 请求说明'."\n" + .'- 该接口用于查询特定时间范围内，某个云产品下的所有实体。'."\n" + .'- `from` 和 `to` 参数分别指定了查询的时间范围，使用秒级时间戳表示。'."\n" + .'- `spl` 参数支持通过 entityStore 查询语句来过滤或选择需要的实体及其属性。'."\n" + .'- 如果只需要部分字段，可以在 `spl` 中使用 `project` 子句进行筛选。'."\n" + .'- 响应中包含了每个实体的具体属性值以及对应的属性名列表，方便解析和处理。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n [\\n \\"data1\\"\\n ]\\n ],\\n \\"header\\": [\\n \\"headerKey\\"\\n ],\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"responseStatus\\": {\\n \\"result\\": \\"Success,PartialSuccess,Error\\",\\n \\"retryPolicy\\": \\"None,Once,Continuous\\",\\n \\"level\\": \\"Info,Warn,Error\\",\\n \\"statusItem\\": [\\n {\\n \\"code\\": \\"Success,ExecuteTimeout,UModelNotExist\\",\\n \\"level\\": \\"Info,Warn,Error\\",\\n \\"message\\": \\"successful\\",\\n \\"suggestion\\": \\"Try to reduce the query scope or increase timeout limit, then retry\\"\\n }\\n ],\\n \\"executionStates\\": \\"{}\\"\\n }\\n}","type":"json"}]', + ], + 'GetCmsService' => [ + 'summary' => '检查Prometheus服务或商品开通状态。', + 'path' => '/cmsservice', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ [ - 'name' => 'nextToken', + 'name' => 'product', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => '用来返回更多结果。第一次查询不需要提供这个参数，后续查询所需使用的Token，从返回结果中获取。', + 'title' => '空：云产品开通prometheus场景使用。'."\n" + .'prometheus：开通prometheuse服务（按上报量或写入量计费）'."\n" + .'sls：开通sls日志服务', + 'description' => 'prometheus：prometheuse服务（按上报量或写入量计费）开通状态。', 'type' => 'string', 'required' => false, - 'example' => 'mvnX6zqg3P', + 'enumValueTitles' => ['prometheus' => 'prometheus'], + 'example' => 'prometheus', + 'enum' => ['prometheus'], ], ], [ - 'name' => 'maxResults', + 'name' => 'service', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => '最大返回结果数。默认30，最大值100。', - 'type' => 'integer', - 'format' => 'int32', + 'title' => '空：云产品开通prometheus场景使用。'."\n" + .'prometheus：检查上报量计费的prometheus是否开通。'."\n" + .'prometheusgb：检查写入量计费的prometheus是否开通。'."\n" + .'ackpro：检查容器监控pro是否开通。', + 'description' => 'prometheus：prometheus上报量计费商品是否开通。'."\n" + .'prometheusgb：prometheus写入量计费商品是否开通。', + 'type' => 'string', 'required' => false, - 'example' => '30', + 'enumValueTitles' => ['prometheusgb' => 'prometheusgb', 'promethues' => 'promethues'], + 'example' => 'prometheus', + 'enum' => ['prometheus', 'prometheusgb', 'promethues', 'ackpro'], ], ], - [ - 'name' => 'entityGroupIds', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '实体ID的过滤，以英文逗号分隔', - 'type' => 'string', - 'required' => false, - 'example' => 'eg-1,eg-2,eg-3', + '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' => '8FDE2569-626B-5176-9844-28877A*****'], + 'enabled' => ['description' => '服务或商品是否开通。', 'type' => 'boolean', 'example' => 'false'], + 'errorCode' => ['title' => 'PROM_NOT_OPEN：prometheus未开通'."\n" + .'SLS_NOT_OPEN：sls未开通'."\n" + .'CMS_SLR_NOT_EXIST：cloudmonitor SLR未创建'."\n" + .'SLS_SLR_NOT_EXIST：sls SLR未创建', 'description' => 'PROM_NOT_OPEN：prometheus未开通。'."\n" + .'SLS_NOT_OPEN：prometheus依赖的sls未开通。'."\n" + .'CMS_SLR_NOT_EXIST：cloudmonitor SLR未创建。'."\n" + .'SLS_SLR_NOT_EXIST：SLS SLR未创建。', 'type' => 'string', 'example' => 'PROM_NOT_OPEN'], + ], ], ], + ], + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '检查Prometheus服务或商品开通状态', + 'description' => 'product和service两个入参，不支持同时填写。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"enabled\\": false,\\n \\"errorCode\\": \\"PROM_NOT_OPEN\\"\\n}","type":"json"}]', + ], + 'GetContext' => [ + 'path' => '/workspace/{workspace}/contextstore/{contextStoreName}/context/{contextId}', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ 'name' => 'workspace', - 'in' => 'query', - 'schema' => [ - 'description' => '工作空间。', - 'type' => 'string', - 'required' => false, - 'example' => 'demo', - ], + 'in' => 'path', + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'maxLength' => 64, 'minLength' => 2], ], [ - 'name' => 'query', - 'in' => 'query', - 'schema' => [ - 'description' => '用于通用查询', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => '上下文库名称', 'type' => 'string', 'required' => true, 'example' => 'test-context-store', 'maxLength' => 64, 'minLength' => 2], ], [ - 'name' => 'prometheusInstanceId', + 'name' => 'contextId', + 'in' => 'path', + 'schema' => ['description' => '上下文Id', 'type' => 'string', 'required' => true, 'example' => '897294a7-67a4-4f60-976c-e136edc5f97e', 'minLength' => 1], + ], + [ + 'name' => 'formatted', 'in' => 'query', + 'schema' => ['description' => '格式化', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => ['description' => '上下文信息', 'type' => 'object', 'example' => '{}'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询单条上下文', + 'summary' => '查询单条上下文', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + ], + 'GetContextStore' => [ + 'summary' => '查询上下文库', + 'path' => '/workspace/{workspace}/contextstore/{contextStoreName}', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'maxLength' => 64, 'minLength' => 2], + ], + [ + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => '上下文库名称', 'type' => 'string', 'required' => true, 'example' => 'test-context-store', 'maxLength' => 64, 'minLength' => 2], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '实例id。', - 'type' => 'string', - 'required' => false, - 'example' => 'cmee-622d27c2e87d49debceeebc7c642610e', + 'description' => '响应数据', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => '请求Id', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'contextStoreName' => ['description' => '上下文库名称', 'type' => 'string', 'example' => 'test-context-store'], + 'workspace' => ['description' => '工作空间ID', 'type' => 'string', 'example' => 'workspace-test'], + 'regionId' => ['description' => '地域 ID', 'type' => 'string', 'example' => 'cn-beijing'], + 'contextType' => ['description' => '上下文类型', 'type' => 'string', 'example' => 'memory'], + 'description' => ['description' => '描述', 'type' => 'string', 'example' => 'test'], + 'status' => ['description' => '状态', 'type' => 'string', 'example' => 'active'], + 'config' => [ + 'description' => '配置信息', + 'type' => 'object', + 'properties' => [ + 'innerSource' => [ + 'description' => '内部源', + 'type' => 'object', + 'properties' => [ + 'project' => ['description' => '日志服务Project名称', 'type' => 'string', 'example' => 'sls-test-project'], + 'logstore' => ['description' => '日志服务Logstore名称', 'type' => 'string', 'example' => 'sls-test-logstore'], + ], + ], + 'source' => [ + 'description' => '配置源', + 'type' => 'object', + 'properties' => [ + 'project' => ['description' => '日志服务Project名称', 'type' => 'string', 'example' => 'sls-test-project'], + 'logstore' => ['description' => '日志服务Logstore名称', 'type' => 'string', 'example' => 'sls-test-logstore'], + 'startTime' => ['description' => '生效开始时间', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1754962200000'], + ], + ], + 'metadataField' => [ + 'description' => '元数据字段', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => '{'."\n" + .' "project": "attributes.project",'."\n" + .' "logstore": "attributes.logstore",'."\n" + .' "agentId": "attributes.agent_id",'."\n" + .' "scene": "attributes.scene"'."\n" + .' }', 'description' => '元数据字段'], + ], + ], + ], + 'dataset' => [ + 'description' => '数据集信息', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => '数据集名称', 'type' => 'string', 'example' => 'test_dataset'], + ], + ], + 'createTime' => ['description' => '创建时间', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1695090077'], + 'updateTime' => ['description' => '更新时间', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1695090077'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询上下文库', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"contextStoreName\\": \\"test-context-store\\",\\n \\"workspace\\": \\"workspace-test\\",\\n \\"regionId\\": \\"cn-beijing\\",\\n \\"contextType\\": \\"memory\\",\\n \\"description\\": \\"test\\",\\n \\"status\\": \\"active\\",\\n \\"config\\": {\\n \\"innerSource\\": {\\n \\"project\\": \\"sls-test-project\\",\\n \\"logstore\\": \\"sls-test-logstore\\"\\n },\\n \\"source\\": {\\n \\"project\\": \\"sls-test-project\\",\\n \\"logstore\\": \\"sls-test-logstore\\",\\n \\"startTime\\": \\"1754962200000\\"\\n },\\n \\"metadataField\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"project\\\\\\": \\\\\\"attributes.project\\\\\\",\\\\n \\\\\\"logstore\\\\\\": \\\\\\"attributes.logstore\\\\\\",\\\\n \\\\\\"agentId\\\\\\": \\\\\\"attributes.agent_id\\\\\\",\\\\n \\\\\\"scene\\\\\\": \\\\\\"attributes.scene\\\\\\"\\\\n }\\"\\n }\\n },\\n \\"dataset\\": {\\n \\"name\\": \\"test_dataset\\"\\n },\\n \\"createTime\\": \\"1695090077\\",\\n \\"updateTime\\": \\"1695090077\\"\\n}","type":"json"}]', + ], + 'GetDataset' => [ + 'path' => '/workspace/{workspace}/dataset/{datasetName}', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'bindResourceId', - 'in' => 'query', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'maxLength' => 64, 'minLength' => 2], + ], + [ + 'name' => 'datasetName', + 'in' => 'path', + 'schema' => ['description' => '数据集名称', 'type' => 'string', 'required' => true, 'example' => 'test_dataset', 'maxLength' => 64, 'minLength' => 2], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '绑定的资源Id', - 'description' => '绑定的资源Id', - 'type' => 'string', - 'required' => false, - 'example' => '622d27c2e87d49debceeebc7c642610e', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => '描述', 'type' => 'string', 'example' => 'test'], + 'createTime' => ['description' => '创建时间', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1695090077'], + 'requestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'updateTime' => ['description' => '更新时间', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1695090077'], + 'workspace' => ['description' => '工作空间名称', 'type' => 'string', 'example' => 'workspace-test'], + 'datasetName' => ['description' => '数据集名称', 'type' => 'string', 'example' => 'test_dataset'], + 'regionId' => ['description' => '地域 ID', 'type' => 'string', 'example' => 'cn-heyuan'], + 'schema' => [ + 'description' => '表结构', + 'type' => 'object', + 'additionalProperties' => ['$ref' => '#/components/schemas/IndexKey', 'description' => '表结构'], + ], + ], ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询数据集', + 'summary' => '查询数据集', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"description\\": \\"test\\",\\n \\"createTime\\": \\"1695090077\\",\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"updateTime\\": \\"1695090077\\",\\n \\"workspace\\": \\"workspace-test\\",\\n \\"datasetName\\": \\"test_dataset\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"schema\\": {\\n \\"key\\": {\\n \\"chn\\": true,\\n \\"type\\": \\"\\",\\n \\"embedding\\": \\"\\",\\n \\"jsonKeys\\": {\\n \\"key\\": {\\n \\"type\\": \\"\\",\\n \\"chn\\": true\\n }\\n }\\n }\\n }\\n}","type":"json"}]', + ], + 'GetDeliveryTask' => [ + 'summary' => '获取数据投递任务详情。', + 'path' => '/delivery-task/{taskId}', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'taskId', + 'in' => 'path', + 'schema' => ['description' => '投递任务 ID', 'type' => 'string', 'required' => true, 'example' => '98e367d8fb8cc83b'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体', 'type' => 'object', 'properties' => [ - 'maxResults' => [ - 'description' => '分页大小'."\n" - .'默认值:'."\n" - .' 50'."\n" - .'最大值:'."\n" - .' 50', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'nextToken' => [ - 'description' => '分页Token', - 'type' => 'string', - 'example' => '44ANBjKZmQeKnaB1fXRq06w7sFYK3MUcCALMD9qQbmEiE', - ], - 'policies' => [ - 'description' => '接入策略列表', - 'type' => 'array', - 'items' => [ - 'description' => '接入策略', - 'type' => 'object', - 'properties' => [ - 'bindResource' => [ - 'description' => '绑定的资源信息', - 'type' => 'object', - 'properties' => [ - 'clusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'cv68tt87d78vyc89zy9v', - ], - 'clusterType' => [ - 'description' => '集群类型。', - 'type' => 'string', - 'example' => 'ManagedKubernetes', - ], - 'vpcCidr' => [ - 'description' => 'VPC网段', - 'type' => 'string', - 'example' => '100.100.0.1/16', - ], - 'vpcId' => [ - 'description' => '虚拟专有网络。', - 'type' => 'string', - 'example' => 'vpc-uf664nyle5khp5d4d7hdo', - ], + 'deliveryTask' => [ + 'description' => '投递任务详情', + 'type' => 'object', + 'properties' => [ + 'taskId' => ['description' => '投递任务 ID', 'type' => 'string', 'example' => '8b07eeac8249866d'], + 'taskName' => ['description' => '任务名称', 'type' => 'string', 'example' => 'test-task'], + 'taskDescription' => ['description' => '任务描述', 'type' => 'string', 'example' => 'my delivery task'], + 'status' => ['description' => '任务当前状态', 'type' => 'string', 'example' => 'Enable'], + 'dataSourceId' => ['description' => '数据源id（Prometheus 实例 ID)', 'type' => 'string', 'example' => 'rw-xxxxxx'], + 'labelFiltersType' => [ + 'description' => '指标过滤模式', + 'type' => 'string', + 'enumValueTitles' => ['Deny' => 'Deny', 'Allow' => 'Allow'], + 'example' => 'Allow', + ], + 'labelFilters' => [ + 'description' => '指标过滤条件，配合 labelFiltersType 使用，key 为指标 label 名，value 为匹配值', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => '__name__: up', 'description' => 'filterKey → filterValue，例如 __name__ → up，job → my_job'], + ], + 'externalLabels' => [ + 'description' => '为所有投递指标附加的额外 label，key 为 label 名，value 为 label 值', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => 'region: cn-hangzhou', 'description' => 'externalLabelsKey → externalLabelsValue，例如 region → cn-hangzhou'], + ], + 'createTime' => ['description' => '创建时间', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2025-07-24T02:08:27Z'], + 'updateTime' => ['description' => '更新时间', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2026-01-22T11:50:48Z'], + 'extraInfo' => [ + 'description' => '扩展信息。', + 'type' => 'object', + 'properties' => [ + 'taskNameList' => [ + 'description' => 'EventBridge 任务列表', + 'type' => 'array', + 'items' => ['description' => 'EventBridge 任务名称', 'type' => 'string', 'example' => 'prometheus-deliver-98e367d8fb8cc83b-0'], ], ], - 'entityGroup' => [ - 'description' => '实体组', + ], + 'sinkList' => [ + 'description' => '投递目标列表', + 'type' => 'array', + 'items' => [ + 'description' => '投递目标配置', 'type' => 'object', 'properties' => [ - 'description' => [ - 'description' => '描述。', - 'type' => 'string', - 'example' => 'xxxx', - ], - 'entityGroupId' => [ - 'description' => '实体组ID', + 'sinkType' => [ + 'description' => '投递目标类型', 'type' => 'string', - 'example' => 'eg-b79f65d11fb94e779867cf937c3a3002', - ], - 'entityGroupName' => [ - 'description' => '实体组名称', - 'type' => 'string', - 'example' => 'test-eg', + 'enumValueTitles' => ['AcsKafka' => 'AcsKafka', 'Prometheus' => 'Prometheus', 'AcsMaxcompute' => 'AcsMaxcompute'], + 'example' => 'Prometheus', ], - 'entityRules' => [ - 'description' => '实体组', + 'sinkConfigs' => [ + 'description' => '投递目标详细配置，key/value 含义因 sinkType 不同而不同（见 CreateDeliveryTask 说明）', 'type' => 'object', - 'properties' => [ - 'annotations' => [ - 'description' => '注释', - 'type' => 'array', - 'items' => [ - 'description' => '注释', - 'type' => 'object', - 'properties' => [ - 'op' => [ - 'description' => '执行的操作。', - 'type' => 'string', - 'example' => 'add', - ], - 'tagKey' => [ - 'description' => '标签的键。', - 'type' => 'string', - 'example' => 'key', - ], - 'tagValues' => [ - 'description' => '标签的值', - 'type' => 'array', - 'items' => [ - 'description' => '标签的值', - 'type' => 'string', - 'example' => 'value', - ], - ], - ], - ], - ], - 'entityTypes' => [ - 'description' => '实体类型列表', - 'type' => 'array', - 'items' => [ - 'description' => '实体类型', - 'type' => 'string', - 'example' => 'ECS', - ], - ], - 'fieldRules' => [ - 'description' => '字段规则', - 'type' => 'array', - 'items' => [ - 'description' => '字段规则', - 'type' => 'object', - 'properties' => [ - 'fieldKey' => [ - 'description' => '字段的唯一标识。', - 'type' => 'string', - 'example' => 'test', - ], - 'fieldValues' => [ - 'description' => '字段内容，多值用英文,分隔。', - 'type' => 'array', - 'items' => [ - 'description' => '字段内容，多值用英文,分隔。', - 'type' => 'string', - 'example' => 'field1,fieled2', - ], - ], - 'op' => [ - 'description' => '执行的操作。', - 'type' => 'string', - 'example' => 'add', - ], - ], - ], - ], - 'instanceIds' => [ - 'description' => '实例ID。', - 'type' => 'array', - 'items' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => '6fq8fvvcb,owqeq789r', - ], - ], - 'ipMatchRule' => [ - 'description' => 'IP匹配规则', - 'type' => 'object', - 'properties' => [ - 'ipCidr' => [ - 'description' => 'IP网段', - 'type' => 'string', - 'example' => '100.100.1.0/16', - ], - 'ipFieldKey' => [ - 'description' => 'IP字段的key', - 'type' => 'string', - 'example' => 'xxxx', - ], - ], - ], - 'labels' => [ - 'description' => '标签', - 'type' => 'array', - 'items' => [ - 'description' => '标签`value`值。', - 'type' => 'object', - 'properties' => [ - 'op' => [ - 'description' => '执行的操作。', - 'type' => 'string', - 'example' => 'add', - ], - 'tagKey' => [ - 'description' => '标签键。', - 'type' => 'string', - 'example' => 'test', - ], - 'tagValues' => [ - 'description' => '标签的值', - 'type' => 'array', - 'items' => [ - 'description' => '标签的值', - 'type' => 'string', - 'example' => 'value1', - ], - ], - ], - ], - ], - 'regionIds' => [ - 'description' => '地域ID列表', - 'type' => 'array', - 'items' => [ - 'description' => '地域ID', - 'type' => 'string', - 'example' => 'cn-beijing,cn-hangzhou', - ], - ], - 'resourceGroupId' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'example' => 'rg-5i6dbwxfxuqihk7k', - ], - 'tags' => [ - 'description' => '实例的标签信息。', - 'type' => 'array', - 'items' => [ - 'description' => '标签值', - 'type' => 'object', - 'properties' => [ - 'op' => [ - 'description' => '执行的操作。', - 'type' => 'string', - 'example' => 'add', - ], - 'tagKey' => [ - 'description' => '标签键。', - 'type' => 'string', - 'example' => 'key', - ], - 'tagValues' => [ - 'description' => '标签值。', - 'type' => 'array', - 'items' => [ - 'description' => '标签值。', - 'type' => 'string', - 'example' => 'value1', - ], - ], - ], - ], - ], - ], + 'additionalProperties' => ['type' => 'string', 'example' => 'Url: http://xxxx/api/v1/write', 'description' => '各 sinkType 支持的配置项'], ], - 'query' => [ - 'description' => '搜索的关键词，支持文档库名称和描述', - 'type' => 'string', - 'example' => '哈弗', - ], - 'regionId' => [ - 'description' => '区域 ID。', - 'type' => 'string', - 'example' => 'cn-heyuan', - ], - 'userId' => [ - 'description' => '用户ID', - 'type' => 'string', - 'example' => '1236812738', - ], - 'workspace' => [ - 'description' => '工作空间。', - 'type' => 'string', - 'example' => 'test-api', - ], - ], - ], - 'managedInfo' => [ - 'description' => '策略网络管理信息。', - 'type' => 'object', - 'properties' => [ - 'securityGroupId' => [ - 'description' => '安全组ID', - 'type' => 'string', - 'example' => 'sg-xxxxx', - ], - 'vswitchId' => [ - 'description' => '交换机ID。', - 'type' => 'string', - 'example' => 'vsw-xxxxxx', - ], - 'eniId' => [ - 'title' => '托管探针的eni网卡id。例如: eni-xxxx。', - 'description' => '托管探针的eni网卡id。例如: eni-xxxx。', - 'type' => 'string', - 'example' => 'eni-12345678', - ], - ], - ], - 'policyId' => [ - 'description' => '策略 ID。', - 'type' => 'string', - 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e', - ], - 'policyName' => [ - 'description' => '规则名称。', - 'type' => 'string', - 'example' => '6f5HSsg3AP', - ], - 'policyType' => [ - 'description' => '接入中心策略类型', - 'type' => 'string', - 'example' => 'ECS', - ], - 'regionId' => [ - 'description' => '区域 ID。', - 'type' => 'string', - 'example' => 'cn-heyuan', - ], - 'resourceGroupId' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'example' => 'rg-xxxxx', - ], - 'userId' => [ - 'description' => '用户ID', - 'type' => 'string', - 'example' => '128470923', - ], - 'workspace' => [ - 'description' => '工作空间。', - 'type' => 'string', - 'example' => 'test-api', - ], - 'feePackage' => [ - 'description' => '计费类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'CS_Pro' => 'CS_Pro', - 'CS_Basic' => 'CS_Basic', ], - 'example' => 'CS_Pro', ], - 'subAddonRelease' => [ - 'description' => '子Release数量', + ], + 'regionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-chengdu'], + 'tags' => [ + 'description' => '资源组标签的键。', + 'type' => 'array', + 'items' => [ + 'description' => 'Tag的值。', 'type' => 'object', 'properties' => [ - 'total' => [ - 'description' => '规则数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '278', - ], - 'ready' => [ - 'description' => '已就绪的子Release数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], + 'key' => ['description' => '资源组标签键', 'type' => 'string', 'example' => 'sourcetype'], + 'value' => ['description' => '资源组标签值', 'type' => 'string', 'example' => 'production'], ], ], - 'csUmodelStatus' => [ - 'description' => '容器环境umodel安装状态。', - 'type' => 'boolean', - 'example' => 'true', - ], ], ], ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5', - ], - 'totalCount' => [ - 'description' => '条目总数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], + 'requestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取数据投递任务', + 'description' => '删除一个指定的站点监控任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"maxResults\\": 100,\\n \\"nextToken\\": \\"44ANBjKZmQeKnaB1fXRq06w7sFYK3MUcCALMD9qQbmEiE\\",\\n \\"policies\\": [\\n {\\n \\"bindResource\\": {\\n \\"clusterId\\": \\"cv68tt87d78vyc89zy9v\\",\\n \\"clusterType\\": \\"ManagedKubernetes\\",\\n \\"vpcCidr\\": \\"100.100.0.1/16\\",\\n \\"vpcId\\": \\"vpc-uf664nyle5khp5d4d7hdo\\"\\n },\\n \\"entityGroup\\": {\\n \\"description\\": \\"xxxx\\",\\n \\"entityGroupId\\": \\"eg-b79f65d11fb94e779867cf937c3a3002\\",\\n \\"entityGroupName\\": \\"test-eg\\",\\n \\"entityRules\\": {\\n \\"annotations\\": [\\n {\\n \\"op\\": \\"add\\",\\n \\"tagKey\\": \\"key\\",\\n \\"tagValues\\": [\\n \\"value\\"\\n ]\\n }\\n ],\\n \\"entityTypes\\": [\\n \\"ECS\\"\\n ],\\n \\"fieldRules\\": [\\n {\\n \\"fieldKey\\": \\"test\\",\\n \\"fieldValues\\": [\\n \\"field1,fieled2\\"\\n ],\\n \\"op\\": \\"add\\"\\n }\\n ],\\n \\"instanceIds\\": [\\n \\"6fq8fvvcb,owqeq789r\\"\\n ],\\n \\"ipMatchRule\\": {\\n \\"ipCidr\\": \\"100.100.1.0/16\\",\\n \\"ipFieldKey\\": \\"xxxx\\"\\n },\\n \\"labels\\": [\\n {\\n \\"op\\": \\"add\\",\\n \\"tagKey\\": \\"test\\",\\n \\"tagValues\\": [\\n \\"value1\\"\\n ]\\n }\\n ],\\n \\"regionIds\\": [\\n \\"cn-beijing,cn-hangzhou\\"\\n ],\\n \\"resourceGroupId\\": \\"rg-5i6dbwxfxuqihk7k\\",\\n \\"tags\\": [\\n {\\n \\"op\\": \\"add\\",\\n \\"tagKey\\": \\"key\\",\\n \\"tagValues\\": [\\n \\"value1\\"\\n ]\\n }\\n ]\\n },\\n \\"query\\": \\"哈弗\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"userId\\": \\"1236812738\\",\\n \\"workspace\\": \\"test-api\\"\\n },\\n \\"managedInfo\\": {\\n \\"securityGroupId\\": \\"sg-xxxxx\\",\\n \\"vswitchId\\": \\"vsw-xxxxxx\\",\\n \\"eniId\\": \\"eni-12345678\\"\\n },\\n \\"policyId\\": \\"policy-ac38a7cb02d14ff48bc9f97d0a75063e\\",\\n \\"policyName\\": \\"6f5HSsg3AP\\",\\n \\"policyType\\": \\"ECS\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"resourceGroupId\\": \\"rg-xxxxx\\",\\n \\"userId\\": \\"128470923\\",\\n \\"workspace\\": \\"test-api\\",\\n \\"feePackage\\": \\"CS_Pro\\",\\n \\"subAddonRelease\\": {\\n \\"total\\": 278,\\n \\"ready\\": 30\\n },\\n \\"csUmodelStatus\\": true\\n }\\n ],\\n \\"requestId\\": \\"CD8BA7D6-995D-578D-9941-78B0FECD14B5\\",\\n \\"totalCount\\": 0\\n}","type":"json"}]', - 'title' => '查询接入中心策略列表信息', - 'description' => '查询集成列表', - ], - 'ListAddonReleases' => [ - 'summary' => 'addon的release列表', - 'path' => '/integration-policies/{policyId}/addon-releases', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetDeliveryTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'DeliveryTask', 'arn' => 'acs:cms:{#regionId}:{#accountId}:deliverytask/{#TaskId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"deliveryTask\\": {\\n \\"taskId\\": \\"8b07eeac8249866d\\",\\n \\"taskName\\": \\"test-task\\",\\n \\"taskDescription\\": \\"my delivery task\\",\\n \\"status\\": \\"Enable\\",\\n \\"dataSourceId\\": \\"rw-xxxxxx\\",\\n \\"labelFiltersType\\": \\"Allow\\",\\n \\"labelFilters\\": {\\n \\"key\\": \\"__name__: up\\"\\n },\\n \\"externalLabels\\": {\\n \\"key\\": \\"region: cn-hangzhou\\"\\n },\\n \\"createTime\\": \\"2025-07-24T02:08:27Z\\",\\n \\"updateTime\\": \\"2026-01-22T11:50:48Z\\",\\n \\"extraInfo\\": {\\n \\"taskNameList\\": [\\n \\"prometheus-deliver-98e367d8fb8cc83b-0\\"\\n ]\\n },\\n \\"sinkList\\": [\\n {\\n \\"sinkType\\": \\"Prometheus\\",\\n \\"sinkConfigs\\": {\\n \\"key\\": \\"Url: http://xxxx/api/v1/write\\"\\n }\\n }\\n ],\\n \\"regionId\\": \\"cn-chengdu\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"sourcetype\\",\\n \\"value\\": \\"production\\"\\n }\\n ]\\n },\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', + ], + 'GetEntityStore' => [ + 'path' => '/workspace/{workspaceName}/entitystore', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'policyId', + 'name' => 'workspaceName', 'in' => 'path', + 'schema' => ['description' => '工作空间名称。', 'type' => 'string', 'required' => true, 'example' => 'workspace-test-001'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '策略环境 ID。', - 'description' => '策略环境 ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-xxxxxxxxxxxx', + 'type' => 'object', + 'properties' => [ + 'regionId' => ['description' => '区域 ID', 'type' => 'string', 'example' => 'cn-heyuan'], + 'requestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'."\n"], + 'workspaceName' => ['description' => '工作空间名称', 'type' => 'string', 'example' => 'workspace-test-001'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取EntityStore', + 'summary' => '获取EntityStore相关存储信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEntityStore'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'addonName', - 'in' => 'query', - 'schema' => [ - 'title' => '组件 Addon 名称。', - 'description' => '组件 Addon 名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'cs-gpu', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetEntityStore', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'EntityStore', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspaceName}/entitystore'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\\\n\\",\\n \\"workspaceName\\": \\"workspace-test-001\\"\\n}","type":"json"}]', + ], + 'GetEntityStoreData' => [ + 'path' => '/workspace/{workspace}/entitiesAndRelations', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'parentAddonReleaseId', - 'in' => 'query', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'acceptEncoding', + 'in' => 'header', + 'schema' => ['description' => '压缩算法内容编码类型', 'type' => 'string', 'required' => false, 'example' => 'gzip', 'default' => 'gzip'], + ], + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'workspace-test-001'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '父级 AddonReleaseId。', - 'description' => '父级 AddonReleaseId。', - 'type' => 'string', + 'description' => '请求 Body', + 'type' => 'object', + 'properties' => [ + 'from' => ['description' => '查询开始时间点。'."\n" + ."\n" + .'Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1721767203'], + 'query' => ['description' => '查询语句。', 'type' => 'string', 'required' => true, 'example' => '.entity with(domain=\'acs\', type=\'acs.k8s.node\') | limit 0, 10'], + 'to' => ['description' => '查询结束时间点。'."\n" + ."\n" + .'Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1721767283'], + ], 'required' => false, - 'example' => 'policy-xxxxxxxxxxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'releases' => [ - 'description' => '接入组件信息集。', + 'data' => [ + 'description' => '返回数据列表总和', 'type' => 'array', 'items' => [ - 'description' => '接入组件信息集。', - 'type' => 'object', - 'properties' => [ - 'addonName' => [ - 'title' => 'Addon 名称。', - 'description' => 'Addon 名称。', - 'type' => 'string', - 'example' => 'cs-gpu', - ], - 'alertRuleCount' => [ - 'title' => '告警规则数量。', - 'description' => '告警规则数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', - ], - 'conditions' => [ - 'title' => '安装阶段状况信息汇总。'."\n" - ."\n" - .'Type 包括四个：Loaded（加载配置），Installed（执行安装），Ready（执行安装后就绪检查），UnInstalled（执行卸载）。四个状况理论上顺序出现。'."\n" - ."\n" - .'Status: 可选值包括：Unknown(正处在当前阶段执行)，True（执行就绪），False（执行失败）'."\n" - ."\n" - .'完整状态判断说明：'."\n" - .'Loaded，Installed，Ready 只要有一个的 Status=False，则代表安装失败，Ready 的 Status=True，则代表安装成功，其他情况则代表正在安装中。'."\n" - ."\n" - .'UnInstalled 只要存在，则代表正在执行卸载。Status=True 则代表卸载成功，Status=Unknown 代表执行卸载中，Status=False 代表卸载失败。'."\n", - 'description' => '安装阶段信息。', - 'type' => 'array', - 'items' => [ - 'description' => '安装阶段信息。', - 'type' => 'object', - 'properties' => [ - 'firstTransitionTime' => [ - 'title' => '第一次转换时间。', - 'description' => '第一次转换时间。', - 'type' => 'string', - 'example' => '2024-11-04T16:10:22+08:00', - ], - 'lastTransitionTime' => [ - 'title' => '最后一次转换时间。', - 'description' => '最后一次转换时间。', - 'type' => 'string', - 'example' => '2024-11-04T16:10:22+08:00', - ], - 'message' => [ - 'title' => '详细信息。', - 'description' => '详细信息。', - 'type' => 'string', - 'example' => 'The addon loaded successfully', - ], - 'status' => [ - 'title' => '阶段状态。', - 'description' => '阶段状态。', - 'type' => 'string', - 'example' => 'True', - ], - 'type' => [ - 'title' => '阶段类型。', - 'description' => '阶段类型。', - 'type' => 'string', - 'example' => 'Loaded', - ], - ], - ], - ], - 'config' => [ - 'title' => '组件配置信息。', - 'description' => '组件配置信息。', - 'type' => 'string', - 'example' => '{"install":{"mode":"auto-install","listenPort":"9400"},"discoverMode":"instances","discover":{"instances":"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44"},"scrapeInterval":"15","enableSecuritecs-nodeyGroupInjection":"true","metricTags":""}', - ], - 'createTime' => [ - 'title' => '接入时间。', - 'description' => '接入时间。', - 'type' => 'string', - 'example' => '2024-11-04T16:10:12+08:00', - ], - 'dashboardCount' => [ - 'title' => '大盘数量。', - 'description' => '大盘数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'environmentId' => [ - 'title' => '环境 ID。', - 'description' => '环境 ID。', - 'type' => 'string', - 'example' => 'policy-xxxxxxxxxxxx', - ], - 'exporterCount' => [ - 'title' => '插件数量。', - 'description' => '插件数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'haveConfig' => [ - 'title' => '是否有配置。', - 'description' => '是否有配置。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'installUserId' => [ - 'title' => '接入用户 ID。', - 'description' => '接入用户 ID。', - 'type' => 'string', - 'example' => '175xxxxxxxxx', - ], - 'language' => [ - 'title' => '语言。', - 'description' => '语言。', - 'type' => 'string', - 'example' => 'zh', - ], - 'managed' => [ - 'title' => '是否为托管组件。', - 'description' => '是否为托管组件。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'parentAddonReleaseId' => [ - 'title' => '父级 AddonReleaseId。', - 'description' => '父级 AddonReleaseId。', - 'type' => 'string', - 'example' => 'policy-xxxxxxxxxxxxxx', - ], - 'policyId' => [ - 'title' => '策略 ID。', - 'description' => '策略 ID。', - 'type' => 'string', - 'example' => 'policy-xxxxxxxxxxxxxx', - ], - 'regionId' => [ - 'title' => '区域 ID。', - 'description' => '区域 ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'releaseId' => [ - 'title' => 'Release ID。', - 'description' => 'Release ID。', - 'type' => 'string', - 'example' => '7339d808-66f9-4d40-83fa-xxxxxxxxxxx', - ], - 'releaseName' => [ - 'title' => 'Release 名称。', - 'description' => 'Release 名称。', - 'type' => 'string', - 'example' => 'test-gpu-integration-name', - ], - 'scene' => [ - 'title' => '组件场景。', - 'description' => '组件场景。', - 'type' => 'string', - 'example' => 'container', - ], - 'status' => [ - 'title' => '状态。', - 'description' => '状态。', - 'type' => 'string', - 'example' => 'running', - ], - 'updateTime' => [ - 'title' => '更新时间。', - 'description' => '更新时间。', - 'type' => 'string', - 'example' => '2024-11-04T16:10:23+08:00', - ], - 'userId' => [ - 'title' => '所属用户 ID。', - 'description' => '所属用户 ID。', - 'type' => 'string', - 'example' => '175xxxxxxxxxxxxx', - ], - 'version' => [ - 'title' => '组件版本。', - 'description' => '组件版本。', - 'type' => 'string', - 'example' => '0.0.2', - ], - 'envType' => [ - 'title' => '环境类型。', - 'description' => '环境类型。', - 'type' => 'string', - 'example' => 'CS', - ], - 'workspace' => [ - 'title' => '工作空间。', - 'description' => '工作空间。', - 'type' => 'string', - 'example' => 'default', - ], - 'subAddonRelease' => [ - 'title' => '子AddonRelease的统计信息', - 'description' => '子AddonRelease的统计信息。', + 'description' => '请求头对应的数据列表', + 'type' => 'array', + 'items' => ['description' => '请求头对应的数据', 'type' => 'string', 'example' => 'data1'], + ], + ], + 'header' => [ + 'description' => '请求头列表', + 'type' => 'array', + 'items' => ['description' => '请求头', 'type' => 'string', 'example' => 'headerKey'], + ], + 'requestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'responseStatus' => [ + 'description' => '结果状态', + 'type' => 'object', + 'properties' => [ + 'result' => ['description' => '执行结果', 'type' => 'string', 'example' => 'Success,PartialSuccess,Error'], + 'retryPolicy' => ['description' => '重试策略', 'type' => 'string', 'example' => 'None,Once,Continuous'], + 'level' => ['description' => '状态级别', 'type' => 'string', 'example' => 'Info,Warn,Error'], + 'statusItem' => [ + 'description' => '详细的状态信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '详细的状态信息', 'type' => 'object', 'properties' => [ - 'ready' => [ - 'title' => '已就绪的子Release数量', - 'description' => '已就绪的子Release数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'total' => [ - 'title' => '子Release数量', - 'description' => '子Release数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], + 'code' => ['description' => '状态码', 'type' => 'string', 'example' => 'Success,ExecuteTimeout,UModelNotExist'], + 'level' => ['description' => '状态级别', 'type' => 'string', 'example' => 'Info,Warn,Error'], + 'message' => ['description' => '计算执行信息', 'type' => 'string', 'example' => 'Query execution timeout after 30 seconds'], + 'suggestion' => ['description' => '执行错误时的建议', 'type' => 'string', 'example' => 'Try to reduce the query scope or increase timeout limit, then retry'], ], ], - 'nextVersion' => [ - 'description' => '剩余列表起始版本号。', - 'type' => 'string', - 'example' => 'None', - ], - 'entityRules' => [ - 'title' => '实体详情。', - 'description' => '实体详情。', - '$ref' => '#/components/schemas/EntityGroupBase', - ], - 'apiVersion' => [ - 'description' => '版本号', - 'type' => 'string', - 'example' => '2023-03-30', - ], ], + 'executionStates' => ['description' => '执行过程中的信息', 'type' => 'string', 'example' => '{}'], ], ], - 'requestId' => [ - 'title' => '请求 ID。', - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5', - ], - 'total' => [ - 'title' => '组件数量。', - 'description' => '组件数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询实体和关系数据', + 'summary' => '查询指定Workspace下的实体和关系数据，返回结果显示某时间区间中的实体数据。', + 'changeSet' => [ + ['createdAt' => '2025-09-10T09:49:36.000Z', 'description' => '响应参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"releases\\": [\\n {\\n \\"addonName\\": \\"cs-gpu\\",\\n \\"alertRuleCount\\": 6,\\n \\"conditions\\": [\\n {\\n \\"firstTransitionTime\\": \\"2024-11-04T16:10:22+08:00\\",\\n \\"lastTransitionTime\\": \\"2024-11-04T16:10:22+08:00\\",\\n \\"message\\": \\"The addon loaded successfully\\",\\n \\"status\\": \\"True\\",\\n \\"type\\": \\"Loaded\\"\\n }\\n ],\\n \\"config\\": \\"{\\\\\\"install\\\\\\":{\\\\\\"mode\\\\\\":\\\\\\"auto-install\\\\\\",\\\\\\"listenPort\\\\\\":\\\\\\"9400\\\\\\"},\\\\\\"discoverMode\\\\\\":\\\\\\"instances\\\\\\",\\\\\\"discover\\\\\\":{\\\\\\"instances\\\\\\":\\\\\\"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44\\\\\\"},\\\\\\"scrapeInterval\\\\\\":\\\\\\"15\\\\\\",\\\\\\"enableSecuritecs-nodeyGroupInjection\\\\\\":\\\\\\"true\\\\\\",\\\\\\"metricTags\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"createTime\\": \\"2024-11-04T16:10:12+08:00\\",\\n \\"dashboardCount\\": 3,\\n \\"environmentId\\": \\"policy-xxxxxxxxxxxx\\",\\n \\"exporterCount\\": 2,\\n \\"haveConfig\\": true,\\n \\"installUserId\\": \\"175xxxxxxxxx\\",\\n \\"language\\": \\"zh\\",\\n \\"managed\\": true,\\n \\"parentAddonReleaseId\\": \\"policy-xxxxxxxxxxxxxx\\",\\n \\"policyId\\": \\"policy-xxxxxxxxxxxxxx\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"releaseId\\": \\"7339d808-66f9-4d40-83fa-xxxxxxxxxxx\\",\\n \\"releaseName\\": \\"test-gpu-integration-name\\",\\n \\"scene\\": \\"container\\",\\n \\"status\\": \\"running\\",\\n \\"updateTime\\": \\"2024-11-04T16:10:23+08:00\\",\\n \\"userId\\": \\"175xxxxxxxxxxxxx\\",\\n \\"version\\": \\"0.0.2\\",\\n \\"envType\\": \\"CS\\",\\n \\"workspace\\": \\"default\\",\\n \\"subAddonRelease\\": {\\n \\"ready\\": 2,\\n \\"total\\": 3\\n },\\n \\"nextVersion\\": \\"None\\",\\n \\"entityRules\\": {\\n \\"workspace\\": \\"\\",\\n \\"regionId\\": \\"\\",\\n \\"entityQueries\\": [\\n {\\n \\"entityType\\": \\"\\",\\n \\"spl\\": \\"\\"\\n }\\n ],\\n \\"description\\": \\"\\",\\n \\"entityGroupId\\": \\"\\",\\n \\"entityRules\\": {\\n \\"ipMatchRule\\": [\\n {\\n \\"ipFieldKey\\": \\"\\",\\n \\"ipCIDR\\": \\"\\"\\n }\\n ],\\n \\"instanceIds\\": [\\n \\"\\"\\n ],\\n \\"fieldRules\\": [\\n {\\n \\"op\\": \\"\\",\\n \\"fieldKey\\": \\"\\",\\n \\"fieldValues\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"annotations\\": [\\n {\\n \\"op\\": \\"\\",\\n \\"tagKey\\": \\"\\",\\n \\"tagValues\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"resourceGroupId\\": \\"\\",\\n \\"entityTypes\\": [\\n \\"\\"\\n ],\\n \\"regionIds\\": [\\n \\"\\"\\n ],\\n \\"tags\\": [\\n {\\n \\"op\\": \\"\\",\\n \\"tagKey\\": \\"\\",\\n \\"tagValues\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"labels\\": [\\n {\\n \\"op\\": \\"\\",\\n \\"tagKey\\": \\"\\",\\n \\"tagValues\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n },\\n \\"entityGroupName\\": \\"\\",\\n \\"userId\\": \\"\\"\\n },\\n \\"apiVersion\\": \\"2023-03-30\\"\\n }\\n ],\\n \\"requestId\\": \\"CD8BA7D6-995D-578D-9941-78B0FECD14B5\\",\\n \\"total\\": 1\\n}","type":"json"}]', - 'title' => '查看接入组件列表', - 'description' => '查询接入配置列表', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEntityStoreData'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetEntityStoreData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'EntityStore', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspaceName}/entitystore'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n [\\n \\"data1\\"\\n ]\\n ],\\n \\"header\\": [\\n \\"headerKey\\"\\n ],\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"responseStatus\\": {\\n \\"result\\": \\"Success,PartialSuccess,Error\\",\\n \\"retryPolicy\\": \\"None,Once,Continuous\\",\\n \\"level\\": \\"Info,Warn,Error\\",\\n \\"statusItem\\": [\\n {\\n \\"code\\": \\"Success,ExecuteTimeout,UModelNotExist\\",\\n \\"level\\": \\"Info,Warn,Error\\",\\n \\"message\\": \\"Query execution timeout after 30 seconds\\",\\n \\"suggestion\\": \\"Try to reduce the query scope or increase timeout limit, then retry\\"\\n }\\n ],\\n \\"executionStates\\": \\"{}\\"\\n }\\n}","type":"json"}]', ], 'GetIntegrationPolicy' => [ - 'summary' => '查询接入中心策略信息', 'path' => '/integration-policies/{policyId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'policyId', 'in' => 'path', - 'schema' => [ - 'description' => '策略 ID', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e', - ], + 'schema' => ['description' => '策略 ID', 'type' => 'string', 'required' => true, 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e'], ], ], 'responses' => [ @@ -12500,47 +10318,19 @@ 'description' => '绑定的资源信息。', 'type' => 'object', 'properties' => [ - 'clusterId' => [ - 'description' => '集群ID。'."\n", - 'type' => 'string', - 'example' => '00b1630f02814f95a9bce717d8d56bb2 ', - ], - 'clusterType' => [ - 'description' => '集群类型。', - 'type' => 'string', - 'example' => 'ManagedKubernetes', - ], - 'vpcCidr' => [ - 'description' => 'VPC网段。', - 'type' => 'string', - 'example' => '10.12.0.1/16', - ], - 'vpcId' => [ - 'description' => '专有网络ID。', - 'type' => 'string', - 'example' => 'vpc-2zegqpeyxplhtmdg70xnr', - ], + 'clusterId' => ['description' => '集群ID。'."\n", 'type' => 'string', 'example' => '00b1630f02814f95a9bce717d8d56bb2 '], + 'clusterType' => ['description' => '集群类型。', 'type' => 'string', 'example' => 'ManagedKubernetes'], + 'vpcCidr' => ['description' => 'VPC网段。', 'type' => 'string', 'example' => '10.12.0.1/16'], + 'vpcId' => ['description' => '专有网络ID。', 'type' => 'string', 'example' => 'vpc-2zegqpeyxplhtmdg70xnr'], ], ], 'entityGroup' => [ 'description' => '实体组。', 'type' => 'object', 'properties' => [ - 'description' => [ - 'description' => '描述。', - 'type' => 'string', - 'example' => 'xxxxxx', - ], - 'entityGroupId' => [ - 'description' => '实体组ID。', - 'type' => 'string', - 'example' => 'eg-b79f65d11fb94e779867cf937c3a3002', - ], - 'entityGroupName' => [ - 'description' => '实体组名称。', - 'type' => 'string', - 'example' => 'prod-database', - ], + 'description' => ['description' => '描述。', 'type' => 'string', 'example' => 'xxxxxx'], + 'entityGroupId' => ['description' => '实体组ID。', 'type' => 'string', 'example' => 'eg-b79f65d11fb94e779867cf937c3a3002'], + 'entityGroupName' => ['description' => '实体组名称。', 'type' => 'string', 'example' => 'prod-database'], 'entityRules' => [ 'description' => '实体规则。', 'type' => 'object', @@ -12552,24 +10342,12 @@ 'description' => '注释。', 'type' => 'object', 'properties' => [ - 'op' => [ - 'description' => '执行的操作。', - 'type' => 'string', - 'example' => 'add', - ], - 'tagKey' => [ - 'description' => '标签键。', - 'type' => 'string', - 'example' => 'use', - ], + 'op' => ['description' => '执行的操作。', 'type' => 'string', 'example' => 'add'], + 'tagKey' => ['description' => '标签键。', 'type' => 'string', 'example' => 'use'], 'tagValues' => [ 'description' => '标签值。', 'type' => 'array', - 'items' => [ - 'description' => '标签值。', - 'type' => 'string', - 'example' => 'db', - ], + 'items' => ['description' => '标签值。', 'type' => 'string', 'example' => 'db'], ], ], ], @@ -12577,11 +10355,7 @@ 'entityTypes' => [ 'description' => '实体类型列表。', 'type' => 'array', - 'items' => [ - 'description' => '实体类型。', - 'type' => 'string', - 'example' => 'CS', - ], + 'items' => ['description' => '实体类型。', 'type' => 'string', 'example' => 'CS'], ], 'fieldRules' => [ 'description' => '属性规则列表。', @@ -12590,51 +10364,27 @@ 'description' => '属性规则。', 'type' => 'object', 'properties' => [ - 'fieldKey' => [ - 'description' => '字段的唯一标识。', - 'type' => 'string', - 'example' => 'test', - ], + 'fieldKey' => ['description' => '字段的唯一标识。', 'type' => 'string', 'example' => 'test'], 'fieldValues' => [ 'description' => '字段内容。', 'type' => 'array', - 'items' => [ - 'description' => '字段内容。', - 'type' => 'string', - 'example' => 'test-value', - ], - ], - 'op' => [ - 'description' => '执行的操作。', - 'type' => 'string', - 'example' => 'add', + 'items' => ['description' => '字段内容。', 'type' => 'string', 'example' => 'test-value'], ], + 'op' => ['description' => '执行的操作。', 'type' => 'string', 'example' => 'add'], ], ], ], 'instanceIds' => [ 'description' => '实例ID。', 'type' => 'array', - 'items' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'i-uf6bsi1aivfbn581buj6,i-uf6eu25p75drryo4712u', - ], + 'items' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'i-uf6bsi1aivfbn581buj6,i-uf6eu25p75drryo4712u'], ], 'ipMatchRule' => [ 'description' => 'IP匹配规则。', 'type' => 'object', 'properties' => [ - 'ipCidr' => [ - 'description' => 'IP网段。', - 'type' => 'string', - 'example' => '10.10.0.1/16', - ], - 'ipFieldKey' => [ - 'description' => 'IP字段的Key。', - 'type' => 'string', - 'example' => 'test-key', - ], + 'ipCidr' => ['description' => 'IP网段。', 'type' => 'string', 'example' => '10.10.0.1/16'], + 'ipFieldKey' => ['description' => 'IP字段的Key。', 'type' => 'string', 'example' => 'test-key'], ], ], 'labels' => [ @@ -12644,24 +10394,12 @@ 'description' => '标签`key`值。', 'type' => 'object', 'properties' => [ - 'op' => [ - 'description' => '执行的操作。', - 'type' => 'string', - 'example' => 'add', - ], - 'tagKey' => [ - 'description' => '实例的标签键。', - 'type' => 'string', - 'example' => 'key1', - ], + 'op' => ['description' => '执行的操作。', 'type' => 'string', 'example' => 'add'], + 'tagKey' => ['description' => '实例的标签键。', 'type' => 'string', 'example' => 'key1'], 'tagValues' => [ 'description' => '标签值列表。', 'type' => 'array', - 'items' => [ - 'description' => '标签值。', - 'type' => 'string', - 'example' => 'value1', - ], + 'items' => ['description' => '标签值。', 'type' => 'string', 'example' => 'value1'], ], ], ], @@ -12669,17 +10407,9 @@ 'regionIds' => [ 'description' => '地域 ID列表。', 'type' => 'array', - 'items' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - ], - 'resourceGroupId' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'example' => 'rg-aek3aqsuvlv3yyq', + 'items' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-beijing'], ], + 'resourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-aek3aqsuvlv3yyq'], 'tags' => [ 'description' => '标签值。', 'type' => 'array', @@ -12687,93 +10417,37 @@ 'description' => '资源标签value值。', 'type' => 'object', 'properties' => [ - 'op' => [ - 'description' => '执行的操作。', - 'type' => 'string', - 'example' => 'add', - ], - 'tagKey' => [ - 'description' => '实例的标签键。', - 'type' => 'string', - 'example' => 'key2', - ], + 'op' => ['description' => '执行的操作。', 'type' => 'string', 'example' => 'add'], + 'tagKey' => ['description' => '实例的标签键。', 'type' => 'string', 'example' => 'key2'], 'tagValues' => [ 'description' => '标签值列表。', 'type' => 'array', - 'items' => [ - 'description' => '标签值。', - 'type' => 'string', - 'example' => 'values', - ], + 'items' => ['description' => '标签值。', 'type' => 'string', 'example' => 'values'], ], ], ], ], ], ], - 'regionId' => [ - 'description' => '区域 ID。', - 'type' => 'string', - 'example' => 'cn-heyuan', - ], - 'userId' => [ - 'description' => '用户ID。', - 'type' => 'string', - 'example' => 'u123456', - ], - 'workspace' => [ - 'description' => '工作空间。', - 'type' => 'string', - 'example' => 'test-api', - ], - 'query' => [ - 'description' => '用于查询', - 'type' => 'string', - 'example' => 'status: 200 AND totalTime > 0.5', - ], + 'regionId' => ['description' => '区域 ID。', 'type' => 'string', 'example' => 'cn-heyuan'], + 'userId' => ['description' => '用户ID。', 'type' => 'string', 'example' => 'u123456'], + 'workspace' => ['description' => '工作空间。', 'type' => 'string', 'example' => 'test-api'], + 'query' => ['description' => '用于查询', 'type' => 'string', 'example' => 'status: 200 AND totalTime > 0.5'], ], ], 'managedInfo' => [ 'description' => '策略管理信息。', 'type' => 'object', 'properties' => [ - 'securityGroupId' => [ - 'description' => '安全组ID。', - 'type' => 'string', - 'example' => 'sg-xxxxxx', - ], - 'vswitchId' => [ - 'description' => '交换机ID。', - 'type' => 'string', - 'example' => 'vsw-xxxxxxxxx', - ], + 'securityGroupId' => ['description' => '安全组ID。', 'type' => 'string', 'example' => 'sg-xxxxxx'], + 'vswitchId' => ['description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-xxxxxxxxx'], ], ], - 'policyId' => [ - 'description' => '策略 ID。', - 'type' => 'string', - 'example' => 'policy-c9efed2b99c348d49e589c5f780fc074', - ], - 'policyName' => [ - 'description' => '规则名称。', - 'type' => 'string', - 'example' => 'ControlPolicy4DetailVportInfo', - ], - 'policyType' => [ - 'description' => '接入策略类型。', - 'type' => 'string', - 'example' => 'CS', - ], - 'regionId' => [ - 'description' => '区域 ID。', - 'type' => 'string', - 'example' => 'cn-heyuan', - ], - 'resourceGroupId' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'example' => 'rg-xxxxx', - ], + 'policyId' => ['description' => '策略 ID。', 'type' => 'string', 'example' => 'policy-c9efed2b99c348d49e589c5f780fc074'], + 'policyName' => ['description' => '规则名称。', 'type' => 'string', 'example' => 'ControlPolicy4DetailVportInfo'], + 'policyType' => ['description' => '接入策略类型。', 'type' => 'string', 'example' => 'CS'], + 'regionId' => ['description' => '区域 ID。', 'type' => 'string', 'example' => 'cn-heyuan'], + 'resourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-xxxxx'], 'tags' => [ 'description' => '标签键。', 'type' => 'array', @@ -12781,822 +10455,1132 @@ 'description' => '标签。', 'type' => 'object', 'properties' => [ - 'key' => [ - 'description' => '标签Key。', - 'type' => 'string', - 'example' => 'use', - ], - 'value' => [ - 'description' => '标签Value。', - 'type' => 'string', - 'example' => 'db', - ], + 'key' => ['description' => '标签Key。', 'type' => 'string', 'example' => 'use'], + 'value' => ['description' => '标签Value。', 'type' => 'string', 'example' => 'db'], ], ], ], - 'userId' => [ - 'description' => '用户ID。', - 'type' => 'string', - 'example' => 'u123456', - ], - 'workspace' => [ - 'description' => '工作空间。', - 'type' => 'string', - 'example' => 'prometheus', - ], - 'csUmodelStatus' => [ - 'description' => '容器环境umodel安装状态。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'userId' => ['description' => '用户ID。', 'type' => 'string', 'example' => 'u123456'], + 'workspace' => ['description' => '工作空间。', 'type' => 'string', 'example' => 'prometheus'], + 'csUmodelStatus' => ['description' => '容器环境umodel安装状态。', 'type' => 'boolean', 'example' => 'true'], ], ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询接入中心策略详情', + 'summary' => '查询接入中心策略信息', + 'changeSet' => [ + ['createdAt' => '2025-10-30T11:46:59.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIntegrationPolicy'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetIntegrationPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'integrationPolicy', 'arn' => 'acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#integrationPolicyId}'], + ], + ], + ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"policy\\": {\\n \\"bindResource\\": {\\n \\"clusterId\\": \\"00b1630f02814f95a9bce717d8d56bb2 \\",\\n \\"clusterType\\": \\"ManagedKubernetes\\",\\n \\"vpcCidr\\": \\"10.12.0.1/16\\",\\n \\"vpcId\\": \\"vpc-2zegqpeyxplhtmdg70xnr\\"\\n },\\n \\"entityGroup\\": {\\n \\"description\\": \\"xxxxxx\\",\\n \\"entityGroupId\\": \\"eg-b79f65d11fb94e779867cf937c3a3002\\",\\n \\"entityGroupName\\": \\"prod-database\\",\\n \\"entityRules\\": {\\n \\"annotations\\": [\\n {\\n \\"op\\": \\"add\\",\\n \\"tagKey\\": \\"use\\",\\n \\"tagValues\\": [\\n \\"db\\"\\n ]\\n }\\n ],\\n \\"entityTypes\\": [\\n \\"CS\\"\\n ],\\n \\"fieldRules\\": [\\n {\\n \\"fieldKey\\": \\"test\\",\\n \\"fieldValues\\": [\\n \\"test-value\\"\\n ],\\n \\"op\\": \\"add\\"\\n }\\n ],\\n \\"instanceIds\\": [\\n \\"i-uf6bsi1aivfbn581buj6,i-uf6eu25p75drryo4712u\\"\\n ],\\n \\"ipMatchRule\\": {\\n \\"ipCidr\\": \\"10.10.0.1/16\\",\\n \\"ipFieldKey\\": \\"test-key\\"\\n },\\n \\"labels\\": [\\n {\\n \\"op\\": \\"add\\",\\n \\"tagKey\\": \\"key1\\",\\n \\"tagValues\\": [\\n \\"value1\\"\\n ]\\n }\\n ],\\n \\"regionIds\\": [\\n \\"cn-beijing\\"\\n ],\\n \\"resourceGroupId\\": \\"rg-aek3aqsuvlv3yyq\\",\\n \\"tags\\": [\\n {\\n \\"op\\": \\"add\\",\\n \\"tagKey\\": \\"key2\\",\\n \\"tagValues\\": [\\n \\"values\\"\\n ]\\n }\\n ]\\n },\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"userId\\": \\"u123456\\",\\n \\"workspace\\": \\"test-api\\",\\n \\"query\\": \\"status: 200 AND totalTime > 0.5\\"\\n },\\n \\"managedInfo\\": {\\n \\"securityGroupId\\": \\"sg-xxxxxx\\",\\n \\"vswitchId\\": \\"vsw-xxxxxxxxx\\"\\n },\\n \\"policyId\\": \\"policy-c9efed2b99c348d49e589c5f780fc074\\",\\n \\"policyName\\": \\"ControlPolicy4DetailVportInfo\\",\\n \\"policyType\\": \\"CS\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"resourceGroupId\\": \\"rg-xxxxx\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"use\\",\\n \\"value\\": \\"db\\"\\n }\\n ],\\n \\"userId\\": \\"u123456\\",\\n \\"workspace\\": \\"prometheus\\",\\n \\"csUmodelStatus\\": true\\n },\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8\\"\\n}","type":"json"}]', - 'title' => '查询接入中心策略详情', ], - 'GetAddonRelease' => [ - 'summary' => '查看addon release(查看接入状态)。', - 'path' => '/integration-policies/{policyId}/addon-releases/{releaseName}', - 'methods' => [ - 'get', + 'GetIntegrationVersionForCS' => [ + 'summary' => '查询容器集群链接的接入中心版本。', + 'path' => '/integration-version/cs', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'clusterId', + 'in' => 'query', + 'schema' => ['title' => '集群ID。', 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'c502646fd0d1249baaf792b3a1b589e1b'], + ], + [ + 'name' => 'clusterType', + 'in' => 'query', + 'schema' => ['title' => '集群类型。取值：acs.ack.cluster,acs.asi.cluster。', 'description' => '集群类型。取值：acs.ack.cluster,acs.asi.cluster。', 'type' => 'string', 'required' => true, 'example' => 'acs.ack.cluster'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'integrationVersion' => ['title' => '接入中心版本。', 'description' => '接入中心版本。', 'type' => 'string', 'example' => 'V1'], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CD9BCF34-EA09-5643-BC11-AF41C8DFAE5A'], + ], + 'description' => '', + ], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询容器集群链接的接入中心版本', + 'description' => '根据传入ID获取集成', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"integrationVersion\\": \\"V1\\",\\n \\"requestId\\": \\"CD9BCF34-EA09-5643-BC11-AF41C8DFAE5A\\"\\n}","type":"json"}]', + ], + 'GetMemories' => [ + 'summary' => '获取全部记忆。', + 'path' => '/workspace/{workspace}/memorystore/{memoryStoreName}/memory/query', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求 Body', + 'type' => 'object', + 'properties' => [ + 'userId' => ['description' => '用户Id', 'type' => 'string', 'required' => false, 'example' => 'test_user_001'], + 'agentId' => ['description' => '应用的agentId', 'type' => 'string', 'required' => false, 'example' => '952730652285943809'], + 'appId' => ['description' => '应用Id', 'type' => 'string', 'required' => false, 'example' => '150130323'], + 'runId' => ['description' => '运行id', 'type' => 'string', 'required' => false, 'example' => 'jr-80ded1d6953c64ea'], + 'filters' => [ + 'title' => '过滤条件', + 'description' => '过滤条件', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['title' => '过滤条件', 'description' => '过滤条件', 'type' => 'any', 'example' => '{"__strategy_type__":"Fact"}'], + 'example' => '{"__strategy_type__":"Fact"}', + ], + 'pageSize' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000'], + 'page' => ['description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + 'required' => false, + ], + ], + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'maxLength' => 64, 'minLength' => 2], + ], + [ + 'name' => 'memoryStoreName', + 'in' => 'path', + 'schema' => ['description' => '记忆库名称', 'type' => 'string', 'required' => true, 'example' => 'test-memory-store', 'maxLength' => 64, 'minLength' => 2], + ], ], - 'produces' => [ - 'application/json', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应数据', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'results' => [ + 'description' => '返回值', + 'type' => 'array', + 'items' => [ + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'actorId' => ['description' => '操作者Id', 'type' => 'string', 'example' => 'test_session_001'], + 'agentId' => ['description' => '应用的agentId', 'type' => 'string', 'example' => '980565235819266048'], + 'createdAt' => ['description' => '创建时间', 'type' => 'string', 'example' => '1747623093939'], + 'hash' => ['description' => '记忆哈希值', 'type' => 'string', 'example' => '73ad89f2d56c2f8615e5dd0cef7b4c41c074277c91fa0e31fc5b41802c0481f2'], + 'id' => ['description' => '记忆ID', 'type' => 'string', 'example' => '019ca1e5-7307-7d50-b943-5e628326a8ed'], + 'memory' => ['description' => '记忆', 'type' => 'string', 'example' => 'My name is Zhang San and I live in Hangzhou.'], + 'metadata' => [ + 'description' => '元数据', + 'type' => 'object', + 'additionalProperties' => ['title' => '元数据', 'description' => '元数据', 'type' => 'any', 'example' => '{"__strategy_type__":"Fact"}'], + 'example' => '{"__strategy_type__":"Fact"}', + ], + 'role' => ['description' => '消息发起角色', 'type' => 'string', 'example' => 'user'], + 'runId' => ['description' => '运行id', 'type' => 'string', 'example' => 'jr-965a0b00cb42a43b'], + 'score' => ['description' => '相似性分数', 'type' => 'number', 'format' => 'double', 'example' => '30.12'], + 'updatedAt' => ['description' => '更新时间', 'type' => 'string', 'example' => '1752825865045'], + 'userId' => ['description' => '用户Id', 'type' => 'string', 'example' => 'test_session_001'], + 'appId' => ['title' => '应用Id', 'description' => '应用Id', 'type' => 'string', 'example' => 'test_user_001'], + ], + ], + ], + 'relations' => [ + 'description' => '关系', + 'type' => 'array', + 'items' => [ + 'description' => '关系', + 'type' => 'object', + 'properties' => [ + 'destination' => ['description' => '目标', 'type' => 'string', 'example' => 'test'], + 'relationship' => ['description' => '关系', 'type' => 'string', 'example' => 'test'], + 'source' => ['description' => '源', 'type' => 'string', 'example' => 'test_namespace/RegistryModule-test2153b9f3-0be6-455e-9efd-05fd31f62885/alicloud'], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取全部记忆', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetMemories', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'MemoryStore', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#WorkspaceName}/memorystore/{#MemoryStoreName}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"results\\": [\\n {\\n \\"actorId\\": \\"test_session_001\\",\\n \\"agentId\\": \\"980565235819266048\\",\\n \\"createdAt\\": \\"1747623093939\\",\\n \\"hash\\": \\"73ad89f2d56c2f8615e5dd0cef7b4c41c074277c91fa0e31fc5b41802c0481f2\\",\\n \\"id\\": \\"019ca1e5-7307-7d50-b943-5e628326a8ed\\",\\n \\"memory\\": \\"My name is Zhang San and I live in Hangzhou.\\",\\n \\"metadata\\": {\\n \\"key\\": \\"{\\\\\\"__strategy_type__\\\\\\":\\\\\\"Fact\\\\\\"}\\"\\n },\\n \\"role\\": \\"user\\",\\n \\"runId\\": \\"jr-965a0b00cb42a43b\\",\\n \\"score\\": 30.12,\\n \\"updatedAt\\": \\"1752825865045\\",\\n \\"userId\\": \\"test_session_001\\",\\n \\"appId\\": \\"test_user_001\\"\\n }\\n ],\\n \\"relations\\": [\\n {\\n \\"destination\\": \\"test\\",\\n \\"relationship\\": \\"test\\",\\n \\"source\\": \\"test_namespace/RegistryModule-test2153b9f3-0be6-455e-9efd-05fd31f62885/alicloud\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetMemory' => [ + 'path' => '/workspace/{workspace}/memorystore/{memoryStoreName}/memory/{memoryId}', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'releaseName', + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'default-cms-1793369865235921-cn-shenzhen', 'maxLength' => 64, 'minLength' => 2], + ], + [ + 'name' => 'memoryStoreName', + 'in' => 'path', + 'schema' => ['description' => '记忆库名称', 'type' => 'string', 'required' => true, 'example' => 'test-memory-store', 'maxLength' => 64, 'minLength' => 2], + ], + [ + 'name' => 'memoryId', 'in' => 'path', + 'schema' => ['description' => '记忆Id', 'type' => 'string', 'required' => true, 'example' => '019ca1e5-7307-7d50-b943-5e628326a8ed', 'minLength' => 1], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'AddonRelease 的名称。', - 'description' => 'AddonRelease 的名称', - 'type' => 'string', - 'required' => true, - 'example' => 'test-gpu-integration-name', + 'title' => 'Schema of Response', + 'description' => '响应数据', + 'type' => 'object', + 'properties' => [ + 'immutable' => ['title' => 'Id of the request', 'description' => '可变属性', 'type' => 'string', 'example' => 'test'], + 'owner' => ['description' => '记忆所有者', 'type' => 'string', 'example' => 'test'], + 'updatedAt' => ['description' => '更新时间', 'type' => 'string', 'example' => '1744428159434'], + 'organization' => ['description' => '组织', 'type' => 'string', 'example' => 'test'], + 'memory' => ['description' => '记忆', 'type' => 'string', 'example' => 'My name is Zhang San and I live in Hangzhou.'], + 'metadata' => ['description' => '元数据', 'type' => 'string', 'example' => '{"sessionId":"test_session_001"}'], + 'id' => ['description' => '记忆ID', 'type' => 'string', 'example' => '019ca1e5-7307-7d50-b943-5e628326a8ed'], + 'expirationDate' => ['description' => '过期时间。', 'type' => 'string', 'example' => '1751595283143'], + 'createdAt' => ['description' => '创建时间', 'type' => 'string', 'example' => '1751595283143'], + 'requestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'userId' => ['type' => 'string', 'example' => 'test_user_001'], + 'agentId' => ['type' => 'string', 'example' => 'test_user_001'], + 'runId' => ['type' => 'string', 'example' => 'test_user_001'], + 'appId' => ['type' => 'string', 'example' => 'test_user_001'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取单个记忆', + 'summary' => '获取单个记忆。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'policyId', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetMemory', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'MemoryStore', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#WorkspaceName}/memorystore/{#MemoryStoreName}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"immutable\\": \\"test\\",\\n \\"owner\\": \\"test\\",\\n \\"updatedAt\\": \\"1744428159434\\",\\n \\"organization\\": \\"test\\",\\n \\"memory\\": \\"My name is Zhang San and I live in Hangzhou.\\",\\n \\"metadata\\": \\"{\\\\\\"sessionId\\\\\\":\\\\\\"test_session_001\\\\\\"}\\",\\n \\"id\\": \\"019ca1e5-7307-7d50-b943-5e628326a8ed\\",\\n \\"expirationDate\\": \\"1751595283143\\",\\n \\"createdAt\\": \\"1751595283143\\",\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"userId\\": \\"test_user_001\\",\\n \\"agentId\\": \\"test_user_001\\",\\n \\"runId\\": \\"test_user_001\\",\\n \\"appId\\": \\"test_user_001\\"\\n}","type":"json"}]', + ], + 'GetMemoryHistory' => [ + 'summary' => '获取记忆历史记录。', + 'path' => '/workspace/{workspace}/memorystore/{memoryStoreName}/memory/{memoryId}/history', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => '工作空间名称。', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'maxLength' => 64, 'minLength' => 2], + ], + [ + 'name' => 'memoryStoreName', + 'in' => 'path', + 'schema' => ['description' => '记忆库名称', 'type' => 'string', 'required' => true, 'example' => 'test-memory-store', 'maxLength' => 64, 'minLength' => 2], + ], + [ + 'name' => 'memoryId', 'in' => 'path', + 'schema' => ['description' => '记忆Id', 'type' => 'string', 'required' => true, 'example' => '019ca1e5-7307-7d50-b943-5e628326a8ed', 'minLength' => 1], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '环境 ID。', - 'description' => '环境 ID', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-xxxxxxxxxxxx', + 'description' => '响应数据', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3B311FD9-A60B-55E0-A896-A0C73*********'], + 'results' => [ + 'description' => '返回值', + 'type' => 'array', + 'items' => [ + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => '记忆ID', 'type' => 'string', 'example' => 'b25d6ad7-306f-4040-9890-4dddd2505a2e'], + 'memoryId' => ['description' => '记忆Id', 'type' => 'string', 'example' => '019cacf6-7b39-7f61-8314-548f07ca449a'], + 'input' => [ + 'description' => '原始消息', + 'type' => 'array', + 'items' => [ + 'description' => '消息', + 'type' => 'object', + 'properties' => [ + 'role' => ['description' => '消息发送角色', 'type' => 'string', 'example' => 'user'], + 'content' => ['description' => '消息内容', 'type' => 'string', 'example' => 'My name is Zhang San and I live in Hangzhou.'], + ], + ], + ], + 'newMemory' => ['description' => '新记忆', 'type' => 'string', 'example' => 'I really like Python.'], + 'userId' => ['description' => '用户Id', 'type' => 'string', 'example' => 'test_session_001'], + 'event' => ['description' => '事件类型', 'type' => 'string', 'example' => 'ADD'], + 'createdAt' => ['description' => '创建时间', 'type' => 'string', 'example' => '1764556182850'], + 'updatedAt' => ['description' => '更新时间', 'type' => 'string', 'example' => '1771036123785'], + 'oldMemory' => ['description' => '旧记忆', 'type' => 'string', 'example' => 'I really don\'t like Python at all.'], + 'metadata' => ['description' => '元数据', 'type' => 'object', 'example' => '{"sessionId":"test_session_001"}'], + ], + ], + ], + ], ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取记忆历史记录', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3B311FD9-A60B-55E0-A896-A0C73*********\\",\\n \\"results\\": [\\n {\\n \\"id\\": \\"b25d6ad7-306f-4040-9890-4dddd2505a2e\\",\\n \\"memoryId\\": \\"019cacf6-7b39-7f61-8314-548f07ca449a\\",\\n \\"input\\": [\\n {\\n \\"role\\": \\"user\\",\\n \\"content\\": \\"My name is Zhang San and I live in Hangzhou.\\"\\n }\\n ],\\n \\"newMemory\\": \\"I really like Python.\\",\\n \\"userId\\": \\"test_session_001\\",\\n \\"event\\": \\"ADD\\",\\n \\"createdAt\\": \\"1764556182850\\",\\n \\"updatedAt\\": \\"1771036123785\\",\\n \\"oldMemory\\": \\"I really don\'t like Python at all.\\",\\n \\"metadata\\": {\\n \\"sessionId\\": \\"test_session_001\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetMemoryStore' => [ + 'summary' => '查询记忆库。', + 'path' => '/workspace/{workspace}/memorystore/{memoryStoreName}', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => '工作空间名称。', 'type' => 'string', 'required' => true, 'example' => 'default-cms-1654218965343050-cn-hangzhou', 'maxLength' => 64, 'minLength' => 2], + ], + [ + 'name' => 'memoryStoreName', + 'in' => 'path', + 'schema' => ['description' => '记忆库名称', 'type' => 'string', 'required' => true, 'example' => 'test-memory-store', 'maxLength' => 64, 'minLength' => 2], + ], + ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应数据', 'type' => 'object', 'properties' => [ - 'config' => [ - 'title' => '组件配置。', - 'description' => '组件配置。', - 'type' => 'string', - 'example' => '{"install":{"mode":"auto-install","listenPort":"9400"},"discoverMode":"instances","discover":{"instances":"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44"},"scrapeInterval":"15","enableSecuritecs-nodeyGroupInjection":"true","metricTags":""}', + 'description' => ['description' => '描述', 'type' => 'string', 'example' => 'test'], + 'createTime' => ['description' => '创建时间', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1764556182850'], + 'updateTime' => ['description' => '更新时间', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1764556182850'], + 'shortTermTtl' => ['description' => '短期记忆保存时间', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'memoryStoreName' => ['description' => '记忆库名称', 'type' => 'string', 'example' => 'test-memory-store'], + 'workspace' => ['description' => '工作空间名称', 'type' => 'string', 'example' => 'default-cms-xxxxxx-cn-beijing'], + 'regionId' => ['description' => '地域 ID', 'type' => 'string', 'example' => 'cn-beijing'], + 'requestId' => ['description' => '请求Id', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8'], + 'extractionStrategies' => [ + 'description' => '支持 "Episodic", "Summary", "Fact"。', + 'type' => 'array', + 'items' => ['description' => '支持 "Episodic", "Summary", "Fact"。', 'type' => 'string', 'example' => 'Fact'], ], - 'release' => [ - 'description' => '详细信息。', + 'customExtractionStrategies' => [ + 'description' => '自定义提取策略。', + 'type' => 'array', + 'items' => ['description' => '自定义提取策略。', 'example' => '[{}]', '$ref' => '#/components/schemas/CustomExtractionStrategy'], + ], + 'shortTermStorage' => [ + 'description' => '短期记忆存储', 'type' => 'object', 'properties' => [ - 'addonName' => [ - 'title' => '组件 Addon 名称。', - 'description' => '组件 Addon 名称。', - 'type' => 'string', - 'example' => 'cs-gpu', - ], - 'alertRuleCount' => [ - 'title' => '告警规则数量。', - 'description' => '告警规则数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', + 'project' => ['description' => '日志服务Project名称。', 'type' => 'string', 'example' => 'wk_cms_data_warehouse'], + 'logstore' => ['description' => '日志服务Logstore名称。', 'type' => 'string', 'example' => 'memory-store'], + ], + ], + 'sourceType' => ['title' => 'memory 来源', 'description' => 'memory 来源', 'type' => 'string', 'example' => 'Trace'], + 'traceSourceConfig' => [ + 'title' => 'sourceType为 Trace 时的配置', + 'description' => 'sourceType为 Trace 时的配置', + 'type' => 'object', + 'properties' => [ + 'workspace' => ['title' => 'trace 所在 workspace', 'description' => 'trace 所在 workspace', 'type' => 'string', 'example' => 'test-workspace'], + 'includeOutput' => ['title' => '是否将 LLM 输出加入记忆抽取', 'description' => '是否将 LLM 输出加入记忆抽取', 'type' => 'boolean'], + 'query' => ['title' => '用于过滤 trace 的 sls 查询语句', 'description' => '用于过滤 trace 的 sls 查询语句', 'type' => 'string', 'example' => '(serviceName : "langchain-rag" or serviceName : "agentscope-code-correction") and hostname = frontend-proxy-999c48c8d-hvk6c '], + ], + ], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询记忆库', + 'description' => '通常配合查询监控项接口QueryMetricMeta和查询监控数据接口QueryMetricList/QueryMetricLast 一起使用。'."\n" + .'##请求类型 '."\n" + .'POST|GET '."\n" + .' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"description\\": \\"test\\",\\n \\"createTime\\": \\"1764556182850\\",\\n \\"updateTime\\": \\"1764556182850\\",\\n \\"shortTermTtl\\": 10,\\n \\"memoryStoreName\\": \\"test-memory-store\\",\\n \\"workspace\\": \\"default-cms-xxxxxx-cn-beijing\\",\\n \\"regionId\\": \\"cn-beijing\\",\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8\\",\\n \\"extractionStrategies\\": [\\n \\"Fact\\"\\n ],\\n \\"customExtractionStrategies\\": [\\n {\\n \\"strategyName\\": \\"test1\\",\\n \\"strategyType\\": \\"Fact\\",\\n \\"extractionPrompt\\": \\"test\\",\\n \\"updatePrompt\\": \\"test\\",\\n \\"description\\": \\"test\\"\\n }\\n ],\\n \\"shortTermStorage\\": {\\n \\"project\\": \\"wk_cms_data_warehouse\\",\\n \\"logstore\\": \\"memory-store\\"\\n },\\n \\"sourceType\\": \\"Trace\\",\\n \\"traceSourceConfig\\": {\\n \\"workspace\\": \\"test-workspace\\",\\n \\"includeOutput\\": true,\\n \\"query\\": \\"(serviceName : \\\\\\"langchain-rag\\\\\\" or serviceName : \\\\\\"agentscope-code-correction\\\\\\") and hostname = frontend-proxy-999c48c8d-hvk6c \\"\\n }\\n}","type":"json"}]', + ], + 'GetPipeline' => [ + 'summary' => '查询流水线', + 'path' => '/workspace/{workspace}/pipeline/{pipelineName}', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => false, 'example' => 'workspace-test'], + ], + [ + 'name' => 'pipelineName', + 'in' => 'path', + 'schema' => ['description' => '流水线名称', 'type' => 'string', 'required' => false, 'example' => 'pipeline-name-1'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应数据', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => '请求Id', 'type' => 'string', 'example' => '3430AE20-AFFF-597C-B553-2DF04B2933AA'], + 'pipelineName' => ['description' => '流水线名称', 'type' => 'string', 'example' => 'pipeline-name-1'], + 'description' => ['description' => '描述', 'type' => 'string', 'example' => 'workspace test'], + 'createTime' => ['description' => '创建时间', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2025-03-11T08:21:58Z'], + 'updateTime' => ['description' => '更新时间', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2026-02-06T14:09:11Z'], + 'workspace' => ['description' => '工作空间ID', 'type' => 'string', 'example' => 'workspace-test'], + 'regionId' => ['description' => '地域ID', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'source' => [ + 'description' => '数据源', + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => '数据源类型', 'type' => 'string', 'example' => 'logstore'], + 'logstore' => [ + 'description' => '日志服务Logstore信息', + 'type' => 'object', + 'properties' => [ + 'project' => ['description' => '日志服务Project名称', 'type' => 'string', 'example' => 'test-project'], + 'logstore' => ['description' => '日志服务Logstore名称', 'type' => 'string', 'example' => 'test-logstore'], + 'query' => ['type' => 'string'], + ], ], - 'conditions' => [ - 'title' => '安装阶段状况信息汇总。'."\n" - ."\n" - .'Type 包括四个：Loaded（加载配置），Installed（执行安装），Ready（执行安装后就绪检查），UnInstalled（执行卸载）。四个状况理论上顺序出现。'."\n" - ."\n" - .'Status: 可选值包括：Unknown(正处在当前阶段执行)，True（执行就绪），False（执行失败）'."\n" - ."\n" - .'完整状态判断说明：'."\n" - .'Loaded，Installed，Ready 只要有一个的 Status=False，则代表安装失败，Ready 的 Status=True，则代表安装成功，其他情况则代表正在安装中。'."\n" - ."\n" - .'UnInstalled 只要存在，则代表正在执行卸载。Status=True 则代表卸载成功，Status=Unknown 代表执行卸载中，Status=False 代表卸载失败。', - 'description' => '安装阶段信息。', + ], + ], + 'pipeline' => [ + 'description' => '流水线信息', + 'type' => 'object', + 'properties' => [ + 'nodes' => [ + 'description' => '节点', 'type' => 'array', 'items' => [ + 'description' => '节点', 'type' => 'object', 'properties' => [ - 'firstTransitionTime' => [ - 'title' => '第一次转换时间。', - 'description' => '第一次转换时间。', - 'type' => 'string', - 'example' => '2024-11-04T16:10:22+08:00', - ], - 'lastTransitionTime' => [ - 'title' => '最后一次转换时间。', - 'description' => '最后一次转换时间。', - 'type' => 'string', - 'example' => '2024-11-04T16:10:22+08:00', - ], - 'message' => [ - 'title' => '详细信息。', - 'description' => '详细信息。', - 'type' => 'string', - 'example' => 'The addon loaded successfully', - ], - 'status' => [ - 'title' => '阶段状态。', - 'description' => '阶段状态。', - 'type' => 'string', - 'example' => 'True', - ], - 'type' => [ - 'title' => '阶段类型。', - 'description' => '阶段类型。', - 'type' => 'string', - 'example' => 'Loaded', + 'id' => ['description' => '节点Id', 'type' => 'string', 'example' => 'node_1'], + 'type' => ['description' => '节点类型', 'type' => 'string', 'example' => 'dedup-fuzzy'], + 'parameters' => [ + 'description' => '参数', + 'type' => 'object', + 'additionalProperties' => ['type' => 'any', 'description' => '参数', 'example' => '{'."\n" + .' "output": "ID,key_0,key_2,key_3,key_4",'."\n" + .' "workspace": "workspace-test-dataset",'."\n" + .' "field": "key_0",'."\n" + .' "global": true,'."\n" + .' "dataset": "dataset_1"'."\n" + .' }'], ], ], ], ], - 'config' => [ - 'title' => '组件配置信息。', - 'description' => '组件配置信息。', - 'type' => 'string', - 'example' => '{"install":{"mode":"auto-install","listenPort":"9400"},"discoverMode":"instances","discover":{"instances":"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44"},"scrapeInterval":"15","enableSecuritecs-nodeyGroupInjection":"true","metricTags":""}', - ], - 'createTime' => [ - 'title' => '接入时间。', - 'description' => '接入时间。', - 'type' => 'string', - 'example' => '2024-11-04T16:10:12+08:00', - ], - 'dashboardCount' => [ - 'title' => '大盘数量。', - 'description' => '大盘数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'environmentId' => [ - 'title' => '环境 ID。', - 'description' => '环境 ID。', - 'type' => 'string', - 'example' => 'policy-xxxxxxxxxxx', - ], - 'exporterCount' => [ - 'title' => '插件数量。', - 'description' => '插件数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'haveConfig' => [ - 'title' => '是否有配置。', - 'description' => '是否有配置。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'installUserId' => [ - 'title' => '接入用户 ID。', - 'description' => '接入用户 ID。', - 'type' => 'string', - 'example' => '1707xxxxxxxxxxxx', - ], - 'language' => [ - 'title' => '语言。', - 'description' => '语言。', - 'type' => 'string', - 'example' => 'zh', - ], - 'managed' => [ - 'title' => '是否为托管组件。', - 'description' => '是否为托管组件。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'parentAddonReleaseId' => [ - 'title' => '父级 AddonReleaseId。', - 'description' => '父级 AddonReleaseId。', - 'type' => 'string', - 'example' => 'policy-xxxxxxxxxxxxx', - ], - 'policyId' => [ - 'title' => '策略 ID。', - 'description' => '策略 ID。', - 'type' => 'string', - 'example' => 'policy-xxxxxxxxxxxxx', - ], - 'regionId' => [ - 'title' => '区域 ID。', - 'description' => '区域 ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'releaseId' => [ - 'title' => 'Release ID。', - 'description' => 'Release ID。', - 'type' => 'string', - 'example' => '7339d808-66f9-4d40-83fa-xxxxxxxxxxx', - ], - 'releaseName' => [ - 'title' => 'Release 的名称。', - 'description' => 'Release 的名称。', - 'type' => 'string', - 'example' => 'test-gpu-integration-name', - ], - 'scene' => [ - 'title' => '组件场景。', - 'description' => '组件场景。', - 'type' => 'string', - 'example' => 'container', - ], - 'status' => [ - 'title' => '组件状态。', - 'description' => '组件状态。', - 'type' => 'string', - 'example' => 'running', - ], - 'updateTime' => [ - 'title' => '更新时间。', - 'description' => '更新时间。', - 'type' => 'string', - 'example' => '2024-11-04T16:10:12+08:00', - ], - 'userId' => [ - 'title' => '所属用户 ID。', - 'description' => '所属用户 ID。', - 'type' => 'string', - 'example' => '1707xxxxxxxxxxxx', - ], - 'version' => [ - 'title' => '组件版本。', - 'description' => '组件版本。', - 'type' => 'string', - 'example' => '0.0.2', - ], - 'envType' => [ - 'title' => '环境类型。', - 'description' => '环境类型。', - 'type' => 'string', - 'example' => 'CS', + ], + ], + 'sink' => [ + 'description' => '输出目标', + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => '输出目标类型', 'type' => 'string', 'example' => 'dataset'], + 'dataset' => [ + 'description' => '数据集信息', + 'type' => 'object', + 'properties' => [ + 'workspace' => ['description' => '工作空间ID', 'type' => 'string', 'example' => 'workspace-test'], + 'dataset' => ['description' => '数据集', 'type' => 'string', 'example' => 'dataset_1'], + ], ], - 'workspace' => [ - 'title' => '工作空间。', - 'description' => '工作空间。', - 'type' => 'string', - 'example' => 'default', + ], + ], + 'executePolicy' => [ + 'description' => '执行策略', + 'type' => 'object', + 'properties' => [ + 'mode' => ['description' => '执行模式', 'type' => 'string', 'example' => 'runOnce'], + 'runOnce' => [ + 'description' => '只执行一次时的配置', + 'type' => 'object', + 'properties' => [ + 'fromTime' => ['description' => '开始时间时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1772519013'], + 'toTime' => ['description' => '结束时间时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1772519013'], + ], ], - 'entityRules' => [ - 'title' => '实体详情。', - 'description' => '实体详情。', - '$ref' => '#/components/schemas/EntityGroupBase', + 'scheduled' => [ + 'description' => '定时执行时的配置', + 'type' => 'object', + 'properties' => [ + 'interval' => ['description' => '时间间隔', 'type' => 'string', 'example' => '86400'], + 'fromTime' => ['description' => '开始时间时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1772519013'], + ], ], ], ], - 'requestId' => [ - 'title' => '请求 ID。', - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8', - ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询流水线', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"config\\": \\"{\\\\\\"install\\\\\\":{\\\\\\"mode\\\\\\":\\\\\\"auto-install\\\\\\",\\\\\\"listenPort\\\\\\":\\\\\\"9400\\\\\\"},\\\\\\"discoverMode\\\\\\":\\\\\\"instances\\\\\\",\\\\\\"discover\\\\\\":{\\\\\\"instances\\\\\\":\\\\\\"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44\\\\\\"},\\\\\\"scrapeInterval\\\\\\":\\\\\\"15\\\\\\",\\\\\\"enableSecuritecs-nodeyGroupInjection\\\\\\":\\\\\\"true\\\\\\",\\\\\\"metricTags\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"release\\": {\\n \\"addonName\\": \\"cs-gpu\\",\\n \\"alertRuleCount\\": 6,\\n \\"conditions\\": [\\n {\\n \\"firstTransitionTime\\": \\"2024-11-04T16:10:22+08:00\\",\\n \\"lastTransitionTime\\": \\"2024-11-04T16:10:22+08:00\\",\\n \\"message\\": \\"The addon loaded successfully\\",\\n \\"status\\": \\"True\\",\\n \\"type\\": \\"Loaded\\"\\n }\\n ],\\n \\"config\\": \\"{\\\\\\"install\\\\\\":{\\\\\\"mode\\\\\\":\\\\\\"auto-install\\\\\\",\\\\\\"listenPort\\\\\\":\\\\\\"9400\\\\\\"},\\\\\\"discoverMode\\\\\\":\\\\\\"instances\\\\\\",\\\\\\"discover\\\\\\":{\\\\\\"instances\\\\\\":\\\\\\"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44\\\\\\"},\\\\\\"scrapeInterval\\\\\\":\\\\\\"15\\\\\\",\\\\\\"enableSecuritecs-nodeyGroupInjection\\\\\\":\\\\\\"true\\\\\\",\\\\\\"metricTags\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"createTime\\": \\"2024-11-04T16:10:12+08:00\\",\\n \\"dashboardCount\\": 3,\\n \\"environmentId\\": \\"policy-xxxxxxxxxxx\\",\\n \\"exporterCount\\": 2,\\n \\"haveConfig\\": true,\\n \\"installUserId\\": \\"1707xxxxxxxxxxxx\\",\\n \\"language\\": \\"zh\\",\\n \\"managed\\": true,\\n \\"parentAddonReleaseId\\": \\"policy-xxxxxxxxxxxxx\\",\\n \\"policyId\\": \\"policy-xxxxxxxxxxxxx\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"releaseId\\": \\"7339d808-66f9-4d40-83fa-xxxxxxxxxxx\\",\\n \\"releaseName\\": \\"test-gpu-integration-name\\",\\n \\"scene\\": \\"container\\",\\n \\"status\\": \\"running\\",\\n \\"updateTime\\": \\"2024-11-04T16:10:12+08:00\\",\\n \\"userId\\": \\"1707xxxxxxxxxxxx\\",\\n \\"version\\": \\"0.0.2\\",\\n \\"envType\\": \\"CS\\",\\n \\"workspace\\": \\"default\\",\\n \\"entityRules\\": {\\n \\"workspace\\": \\"\\",\\n \\"regionId\\": \\"\\",\\n \\"entityQueries\\": [\\n {\\n \\"entityType\\": \\"\\",\\n \\"spl\\": \\"\\"\\n }\\n ],\\n \\"description\\": \\"\\",\\n \\"entityGroupId\\": \\"\\",\\n \\"entityRules\\": {\\n \\"ipMatchRule\\": [\\n {\\n \\"ipFieldKey\\": \\"\\",\\n \\"ipCIDR\\": \\"\\"\\n }\\n ],\\n \\"instanceIds\\": [\\n \\"\\"\\n ],\\n \\"fieldRules\\": [\\n {\\n \\"op\\": \\"\\",\\n \\"fieldKey\\": \\"\\",\\n \\"fieldValues\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"annotations\\": [\\n {\\n \\"op\\": \\"\\",\\n \\"tagKey\\": \\"\\",\\n \\"tagValues\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"resourceGroupId\\": \\"\\",\\n \\"entityTypes\\": [\\n \\"\\"\\n ],\\n \\"regionIds\\": [\\n \\"\\"\\n ],\\n \\"tags\\": [\\n {\\n \\"op\\": \\"\\",\\n \\"tagKey\\": \\"\\",\\n \\"tagValues\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"labels\\": [\\n {\\n \\"op\\": \\"\\",\\n \\"tagKey\\": \\"\\",\\n \\"tagValues\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n },\\n \\"entityGroupName\\": \\"\\",\\n \\"userId\\": \\"\\"\\n }\\n },\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8\\"\\n}","type":"json"}]', - 'title' => '查看接入组件信息', - ], - 'DeleteAddonRelease' => [ - 'summary' => '删除addon release信息。', - 'path' => '/integration-policies/{policyId}/addon-releases', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'cms:GetPipeline', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Pipeline', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#Workspace}/pipeline/{#PipelineName}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3430AE20-AFFF-597C-B553-2DF04B2933AA\\",\\n \\"pipelineName\\": \\"pipeline-name-1\\",\\n \\"description\\": \\"workspace test\\",\\n \\"createTime\\": \\"2025-03-11T08:21:58Z\\",\\n \\"updateTime\\": \\"2026-02-06T14:09:11Z\\",\\n \\"workspace\\": \\"workspace-test\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"source\\": {\\n \\"type\\": \\"logstore\\",\\n \\"logstore\\": {\\n \\"project\\": \\"test-project\\",\\n \\"logstore\\": \\"test-logstore\\",\\n \\"query\\": \\"\\"\\n }\\n },\\n \\"pipeline\\": {\\n \\"nodes\\": [\\n {\\n \\"id\\": \\"node_1\\",\\n \\"type\\": \\"dedup-fuzzy\\",\\n \\"parameters\\": {\\n \\"key\\": \\"{\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"output\\\\\\": \\\\\\"ID,key_0,key_2,key_3,key_4\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"workspace\\\\\\": \\\\\\"workspace-test-dataset\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"field\\\\\\": \\\\\\"key_0\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"global\\\\\\": true,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"dataset\\\\\\": \\\\\\"dataset_1\\\\\\"\\\\n\\\\t\\\\t\\\\t}\\"\\n }\\n }\\n ]\\n },\\n \\"sink\\": {\\n \\"type\\": \\"dataset\\",\\n \\"dataset\\": {\\n \\"workspace\\": \\"workspace-test\\",\\n \\"dataset\\": \\"dataset_1\\"\\n }\\n },\\n \\"executePolicy\\": {\\n \\"mode\\": \\"runOnce\\",\\n \\"runOnce\\": {\\n \\"fromTime\\": 1772519013,\\n \\"toTime\\": 1772519013\\n },\\n \\"scheduled\\": {\\n \\"interval\\": \\"86400\\",\\n \\"fromTime\\": 1772519013\\n }\\n }\\n}","type":"json"}]', + ], + 'GetPrometheusInstance' => [ + 'summary' => '查询指定Prometheus实例详情信息。', + 'path' => '/prometheus-instances/{prometheusInstanceId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcmsCP2WWY'], + 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'releaseName', + 'name' => 'prometheusInstanceId', + 'in' => 'path', + 'schema' => ['description' => '实例id。', 'type' => 'string', 'required' => true, 'example' => 'rw-abc123'], + ], + [ + 'name' => 'resourceGroupId', 'in' => 'query', - 'schema' => [ - 'title' => 'AddonRelease 的名称。', - 'description' => 'AddonRelease 的名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test-gpu-integration-name', - ], + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2bhocin5e2na'], ], [ - 'name' => 'force', + 'name' => 'aliyunLang', 'in' => 'query', + 'schema' => ['title' => '语言环境, 默认为中文 zh | en', 'description' => '语言环境, 默认为中文 zh | en。', 'type' => 'string', 'required' => false, 'example' => 'zh', 'default' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '是否硬性删除，默认 false。', - 'description' => '是否硬性删除，默认 false。', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '是', - 'false' => '否', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'prometheusInstance' => [ + 'description' => 'Prometheus 实例详情。', + 'type' => 'object', + 'properties' => [ + 'accessType' => ['title' => '权限类型：'."\n" + .'readWrite、readOnly、httpReadOnly', 'description' => '权限类型：'."\n" + .'readWrite、readOnly、httpReadOnly', 'type' => 'string', 'example' => 'readOnly'], + 'archiveDuration' => ['title' => '存储到期后，自动归档保存的天数，0表示不归档保存，3650表示永久保存。', 'description' => '存储到期后，自动归档保存的天数，0表示不归档保存，3650表示永久保存。', 'type' => 'integer', 'format' => 'int32', 'example' => '90'], + 'authFreeReadPolicy' => ['title' => '读免密地址白名单策略。', 'description' => '免密读策略（支持IP段和VpcId）。', 'type' => 'string', 'example' => '{'."\n" + .' "SourceIp": ['."\n" + .' "192.168.1.0/24",'."\n" + .' "172.168.2.22"'."\n" + .' ],'."\n" + .' "SourceVpc": ['."\n" + .' "vpc-xx1",'."\n" + .' "vpc-xx2"'."\n" + .' ]'."\n" + .'}'], + 'authFreeWritePolicy' => ['title' => '写免密地址白名单策略。', 'description' => '免密写策略（支持IP段和VpcId）。', 'type' => 'string', 'example' => '{'."\n" + .' "SourceIp": ['."\n" + .' "192.168.1.0/24",'."\n" + .' "172.168.2.22"'."\n" + .' ],'."\n" + .' "SourceVpc": ['."\n" + .' "vpc-xx1",'."\n" + .' "vpc-xx2"'."\n" + .' ]'."\n" + .'}'], + 'authToken' => ['title' => 'authToken串', 'description' => 'authToken串。', 'type' => 'string', 'example' => 'eJwixxxxx'], + 'createTime' => ['title' => '实例创建时间，使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ', 'description' => '实例创建时间，使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ。', 'type' => 'string', 'example' => '2025-08-10T02:07:53Z'], + 'enableAuthFreeRead' => ['title' => '是否开启读免密。', 'description' => '是否开启读免密。', 'type' => 'boolean', 'example' => 'true'], + 'enableAuthFreeWrite' => ['title' => '是否开启写免密。', 'description' => '是否开启写免密。', 'type' => 'boolean', 'example' => 'true'], + 'enableAuthToken' => ['description' => '是否开启鉴权Token。', 'type' => 'boolean', 'example' => 'true'], + 'extraInfo' => [ + 'title' => '扩展信息（仅控制台请求才返回）', + 'description' => '扩展信息。', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '其他扩展信息。', 'example' => 'value'], + ], + 'httpApiInterUrl' => ['description' => 'HTTP 公网地址。', 'type' => 'string', 'example' => ' http://workspace-default-cms-xxxxxxx'], + 'httpApiIntraUrl' => ['description' => 'HTTP 私网地址。', 'type' => 'string', 'example' => ' http://workspace-default-cms-xxxxxxx'], + 'httpApiInternalUrl' => ['description' => 'HTTP内网地址', 'type' => 'string', 'example' => ' http://workspace-default-cms-xxxxxxx'], + 'instanceType' => ['title' => 'remote-write（Prometheus for Remote Write）', 'description' => 'Prometheus实例类型。', 'type' => 'string', 'example' => 'remote-write'], + 'paymentType' => ['title' => '计费方式：'."\n" + .'POSTPAY：按指标上报量后付费。'."\n" + .'POSTPAY_GB：按指标写入量后付费。', 'description' => '计费方式：'."\n" + .'POSTPAY：按指标上报量后付费。'."\n" + .'POSTPAY_GB：按指标写入量后付费。', 'type' => 'string', 'example' => 'POSTPAY'], + 'product' => ['title' => 'prom实例归属的产品（arms或cms）', 'description' => 'prom实例归属的产品（arms或cms）', 'type' => 'string', 'example' => 'cms'], + 'prometheusInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'rw-524ada714221af267c73122af2e1'], + 'prometheusInstanceName' => ['description' => '实例名称。', 'type' => 'string', 'example' => 'test-prom-name'], + 'pushGatewayInterUrl' => ['description' => 'PushGateway公网地址。', 'type' => 'string', 'example' => ' http://workspace-default-cms-xxxxxxx'], + 'pushGatewayIntraUrl' => ['description' => 'PushGateway私网地址。', 'type' => 'string', 'example' => ' http://workspace-default-cms-xxxxxxx'."\n"], + 'pushGatewayInternalUrl' => ['description' => 'PushGateway的内网地址', 'type' => 'string', 'example' => ' http://workspace-default-cms-xxxxxxx'], + 'regionId' => ['description' => '地域 ID。', 'type' => 'string', 'example' => 'cn-heyuan'], + 'remoteReadInterUrl' => ['description' => '公网读地址。', 'type' => 'string', 'example' => ' http://workspace-default-cms-xxxxxxx'], + 'remoteReadIntraUrl' => ['description' => '私网读地址。', 'type' => 'string', 'example' => 'https://workspace-default-cms-1xxxxxxxxxx'], + 'remoteReadInternalUrl' => ['description' => 'RemoteRead的内网地址', 'type' => 'string', 'example' => 'https://workspace-default-cms-1xxxxxxxxxx'], + 'remoteWriteInterUrl' => ['description' => '公网写地址。', 'type' => 'string', 'example' => 'https://workspace-default-cms-xxxxxxxxxx'], + 'remoteWriteIntraUrl' => ['description' => '私网写地址。', 'type' => 'string', 'example' => 'https://workspace-default-cms-xxxxxxxxxx'], + 'remoteWriteInternalUrl' => ['description' => 'RemoteWrite的内网地址', 'type' => 'string', 'example' => 'https://workspace-default-cms-xxxxxxxxxx'], + 'resourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-acfm3gn5i6bigbi'], + 'resourceType' => ['title' => '固定值：PrometheusInstance', 'description' => '固定值：PrometheusInstance。', 'type' => 'string', 'example' => 'Prometheus'], + 'status' => ['title' => '后端数据存储状态', 'description' => '实例状态。', 'type' => 'string', 'example' => 'Running'], + 'storageDuration' => ['title' => '存储时长（天）。', 'description' => '存储时长（天）。', 'type' => 'integer', 'format' => 'int32', 'example' => '90'], + 'supportAuthTypes' => [ + 'title' => '支持的认证鉴权类型。', + 'description' => '支持的认证鉴权类型。', + 'type' => 'array', + 'items' => [ + 'description' => '鉴权类型。', + 'type' => 'string', + 'enumValueTitles' => ['BasicAuth' => 'HTTP基础认证', 'AuthFree' => '免密', 'AuthToken' => 'Token认证'], + 'example' => 'BasicAuth', + 'enum' => ['BasicAuth', 'AuthFree', 'AuthToken'], + ], + ], + 'tags' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => '标签Key。', 'type' => 'string', 'example' => 'openStorage'], + 'value' => ['description' => '匹配值。', 'type' => 'string', 'example' => '130303196111114281'], + ], + ], + ], + 'userId' => ['description' => '用户ID。', 'type' => 'string', 'example' => '170731234567'], + 'version' => ['title' => '版本', 'description' => '版本。', 'type' => 'string', 'example' => 'V1'], + 'workspace' => ['title' => 'prom实例归属的工作空间', 'description' => 'Prometheus实例归属的工作空间。', 'type' => 'string', 'example' => 'ws1'], + 'folderUrl' => ['title' => '可视化大盘Url', 'description' => '可视化大盘目录URL。', 'type' => 'string', 'example' => 'https://gnew.console.aliyun.com/dashboards/f/c49a80d2a551d4a20a8c4b996b0be4e52/xxxxxxx'], + 'grafanaInstanceId' => ['title' => '绑定的托管grafana实例Id', 'description' => '绑定的托管grafana实例ID。', 'type' => 'string', 'example' => 'SHARED'], + 'grafanaInstanceName' => ['title' => '绑定的托管grafana实例名称', 'description' => '绑定的托管grafana实例名称。', 'type' => 'string', 'example' => '共享版'], + 'paymentTypeUpdateTime' => ['title' => '实例计费方式修改时间', 'description' => '实例计费方式修改时间（UTC时间格式）。', 'type' => 'string', 'example' => '2025-08-10T02:07:53Z'], + ], + ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求唯一标识。', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], ], - 'example' => 'false', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusInstance\\": {\\n \\"accessType\\": \\"readOnly\\",\\n \\"archiveDuration\\": 90,\\n \\"authFreeReadPolicy\\": \\"{\\\\n \\\\\\"SourceIp\\\\\\": [\\\\n \\\\\\"192.168.1.0/24\\\\\\",\\\\n \\\\\\"172.168.2.22\\\\\\"\\\\n ],\\\\n \\\\\\"SourceVpc\\\\\\": [\\\\n \\\\\\"vpc-xx1\\\\\\",\\\\n \\\\\\"vpc-xx2\\\\\\"\\\\n ]\\\\n}\\",\\n \\"authFreeWritePolicy\\": \\"{\\\\n \\\\\\"SourceIp\\\\\\": [\\\\n \\\\\\"192.168.1.0/24\\\\\\",\\\\n \\\\\\"172.168.2.22\\\\\\"\\\\n ],\\\\n \\\\\\"SourceVpc\\\\\\": [\\\\n \\\\\\"vpc-xx1\\\\\\",\\\\n \\\\\\"vpc-xx2\\\\\\"\\\\n ]\\\\n}\\",\\n \\"authToken\\": \\"eJwixxxxx\\",\\n \\"createTime\\": \\"2025-08-10T02:07:53Z\\",\\n \\"enableAuthFreeRead\\": true,\\n \\"enableAuthFreeWrite\\": true,\\n \\"enableAuthToken\\": true,\\n \\"extraInfo\\": {\\n \\"key\\": \\"value\\"\\n },\\n \\"httpApiInterUrl\\": \\" http://workspace-default-cms-xxxxxxx\\",\\n \\"httpApiIntraUrl\\": \\" http://workspace-default-cms-xxxxxxx\\",\\n \\"httpApiInternalUrl\\": \\" http://workspace-default-cms-xxxxxxx\\",\\n \\"instanceType\\": \\"remote-write\\",\\n \\"paymentType\\": \\"POSTPAY\\",\\n \\"product\\": \\"cms\\",\\n \\"prometheusInstanceId\\": \\"rw-524ada714221af267c73122af2e1\\",\\n \\"prometheusInstanceName\\": \\"test-prom-name\\",\\n \\"pushGatewayInterUrl\\": \\" http://workspace-default-cms-xxxxxxx\\",\\n \\"pushGatewayIntraUrl\\": \\" http://workspace-default-cms-xxxxxxx\\\\n\\",\\n \\"pushGatewayInternalUrl\\": \\" http://workspace-default-cms-xxxxxxx\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"remoteReadInterUrl\\": \\" http://workspace-default-cms-xxxxxxx\\",\\n \\"remoteReadIntraUrl\\": \\"https://workspace-default-cms-1xxxxxxxxxx\\",\\n \\"remoteReadInternalUrl\\": \\"https://workspace-default-cms-1xxxxxxxxxx\\",\\n \\"remoteWriteInterUrl\\": \\"https://workspace-default-cms-xxxxxxxxxx\\",\\n \\"remoteWriteIntraUrl\\": \\"https://workspace-default-cms-xxxxxxxxxx\\",\\n \\"remoteWriteInternalUrl\\": \\"https://workspace-default-cms-xxxxxxxxxx\\",\\n \\"resourceGroupId\\": \\"rg-acfm3gn5i6bigbi\\",\\n \\"resourceType\\": \\"Prometheus\\",\\n \\"status\\": \\"Running\\",\\n \\"storageDuration\\": 90,\\n \\"supportAuthTypes\\": [\\n \\"BasicAuth\\"\\n ],\\n \\"tags\\": [\\n {\\n \\"key\\": \\"openStorage\\",\\n \\"value\\": \\"130303196111114281\\"\\n }\\n ],\\n \\"userId\\": \\"170731234567\\",\\n \\"version\\": \\"V1\\",\\n \\"workspace\\": \\"ws1\\",\\n \\"folderUrl\\": \\"https://gnew.console.aliyun.com/dashboards/f/c49a80d2a551d4a20a8c4b996b0be4e52/xxxxxxx\\",\\n \\"grafanaInstanceId\\": \\"SHARED\\",\\n \\"grafanaInstanceName\\": \\"共享版\\",\\n \\"paymentTypeUpdateTime\\": \\"2025-08-10T02:07:53Z\\"\\n },\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', + 'title' => '获取Prometheus实例详细信息', + 'description' => '获取Prometheus实例详情。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '40', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPrometheusInstance'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'policyId', - 'in' => 'path', - 'schema' => [ - 'title' => '环境 ID。', - 'description' => '环境 ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-xxxxxxxxxxxxx', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetPrometheusInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'PrometheusInstance', 'arn' => 'acs:cms:{#regionId}:{#accountId}:prometheusinstance/{#prometheusInstanceId}'], + ], ], ], + ], + ], + 'GetPrometheusUserSetting' => [ + 'path' => '/prometheus-user-setting', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'addonName', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcmsCP2WWY'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'aliyunLang', 'in' => 'query', - 'schema' => [ - 'title' => 'Addon 名称，当 AddonName 赋值时，将忽略 ReleaseName 参数批量卸载所属于同一个 Addon 的所有 AddonRelease。', - 'description' => 'Addon 名称。当 AddonName 赋值时，将忽略 ReleaseName 参数批量卸载所属于同一个 Addon 的所有 AddonRelease。', - 'type' => 'string', - 'required' => false, - 'example' => 'cs-gpu', - ], + 'schema' => ['title' => '语言环境, 默认为中文 zh | en', 'description' => '语言环境, 默认为中文 zh | en', 'type' => 'string', 'required' => false, 'example' => 'zh', 'default' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求 ID。', - 'description' => '请求 ID', - 'type' => 'string', - 'example' => '264C3E89-BE6E-5F82-A484-CE9C2196C7DC', + 'prometheusUserSetting' => [ + 'description' => 'Prometheus用户配置详情。', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '配置值。', 'example' => 'value1'], ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '058550FA-DDBE-519E-9C6D-93521B9A5E90'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取Prometheus用户配置。', + 'summary' => '查询Prometheus用户配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-BE6E-5F82-A484-CE9C2196C7DC\\"\\n}","type":"json"}]', - 'title' => '卸载接入组件', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusUserSetting\\": {\\n \\"key\\": \\"value1\\"\\n },\\n \\"requestId\\": \\"058550FA-DDBE-519E-9C6D-93521B9A5E90\\"\\n}","type":"json"}]', ], - 'CreateAddonRelease' => [ - 'summary' => '安装接入组件，代表进行一次接入', - 'path' => '/integration-policies/{policyId}/addon-releases', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetPrometheusView' => [ + 'summary' => '查询指定Prometheus视图实例详情。', + 'path' => '/prometheus-views/{prometheusViewId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcmsCP2WWY'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'prometheusViewId', + 'in' => 'path', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rw-xxxxxx'], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2bhocin5e2na'], + ], + [ + 'name' => 'aliyunLang', + 'in' => 'query', + 'schema' => ['title' => '语言环境, 默认为中文 zh | en', 'description' => '语言环境, 默认为中文 zh | en。', 'type' => 'string', 'required' => false, 'example' => 'zh', 'default' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '请求体参数。', - 'description' => '请求体参数。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'addonName' => [ - 'title' => '需要接入监控的组件 Addon 名称。', - 'description' => '需要接入监控的组件 Addon 名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'cs-gpu', - ], - 'aliyunLang' => [ - 'title' => '组件的语言类型。', - 'description' => '组件的语言类型。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'en' => '英语', - 'zh' => '中文', - ], - 'example' => 'zh', - ], - 'dryRun' => [ - 'title' => '是否试运行，默认为 false。', - 'description' => '是否试运行，默认为 false。', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '试运行', - 'false' => '不试运行', - ], - 'example' => 'false', - ], - 'envType' => [ - 'title' => '环境类型。如果 Policy 类型为 CS 和 ECS，对应使用，其他类型统一为 Cloud。', - 'description' => '环境类型。如果 Policy 类型为 CS 和 ECS，对应使用，其他类型统一为 Cloud。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'CS' => '容器环境', - 'ECS' => 'ECS环境', - 'Cloud' => '云服务环境', + 'prometheusView' => [ + 'description' => '视图实例。', + 'type' => 'object', + 'properties' => [ + 'authFreeReadPolicy' => ['title' => '读免密地址白名单策略。', 'description' => '免密读策略（支持IP段和VpcId）。', 'type' => 'string', 'example' => '{'."\n" + .' "SourceIp": ['."\n" + .' "192.168.1.0/24",'."\n" + .' "172.168.2.22"'."\n" + .' ],'."\n" + .' "SourceVpc": ['."\n" + .' "vpc-xx1",'."\n" + .' "vpc-xx2"'."\n" + .' ]'."\n" + .'}'], + 'authToken' => ['title' => 'authToken串', 'description' => 'authToken串。', 'type' => 'string', 'example' => 'eJxxxxxx'], + 'createTime' => ['title' => '实例创建时间，使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ', 'description' => '实例创建时间，使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ。', 'type' => 'string', 'example' => '2025-08-10T02:07:53Z'], + 'enableAuthFreeRead' => ['title' => '是否开启读免密。', 'description' => '是否开启读免密。', 'type' => 'boolean', 'example' => 'true'], + 'enableAuthToken' => ['title' => '是否开启authToken。', 'description' => '是否开启authToken。', 'type' => 'boolean', 'example' => 'true'], + 'httpApiInterUrl' => ['description' => '公网HTTP地址。', 'type' => 'string', 'example' => 'http://xxxxxxxx'], + 'httpApiIntraUrl' => ['description' => '内网HTTP地址。', 'type' => 'string', 'example' => 'http://xxxxxxxx'], + 'httpApiInternalUrl' => ['description' => '内网HTTP地址。', 'type' => 'string', 'example' => 'https://workspace-xxx.cn-hangzhou-internal.log.aliyuncs.com/prometheus/workspace-xxx/aliyun-prom-rw-xxx'], + 'instanceType' => ['title' => '实例类型：'."\n" + .'prom-view：新版本聚合视图'."\n" + .'global-view：老版本聚合视图', 'description' => '实例类型，固定值prom-view。', 'type' => 'string', 'example' => 'prom-view'], + 'paymentType' => ['title' => '付费类型。目前固定值FREE（免费）。', 'description' => '付费类型。目前固定值FREE（免费）。', 'type' => 'string', 'example' => 'FREE'], + 'product' => ['title' => 'prom实例归属的产品（arms或cms）', 'description' => 'prom实例归属的产品。', 'type' => 'string', 'example' => 'cms'], + 'prometheusInstances' => [ + 'description' => 'Prometheus 实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Prometheus 实例列表。', + 'type' => 'object', + 'properties' => [ + 'prometheusInstanceId' => ['description' => '实例id。', 'type' => 'string', 'example' => 'rw-63549e054ff596a4149927961dff'], + 'regionId' => ['description' => '地域 ID', 'type' => 'string', 'example' => 'cn-north-2-gov-1'], + 'userId' => ['description' => '用户ID。', 'type' => 'string', 'example' => '122xxxxx'], + ], + ], + ], + 'prometheusViewId' => ['description' => 'Prometheus视图ID。', 'type' => 'string', 'example' => 'view-xxx'], + 'prometheusViewName' => ['description' => 'Prometheus 视图名称。', 'type' => 'string', 'example' => 'view1'], + 'regionId' => ['description' => '地域 ID', 'type' => 'string', 'example' => 'cn-shanghai'], + 'remoteReadInterUrl' => ['description' => 'remote read公网URL。', 'type' => 'string', 'example' => 'http://workspace-default-cms-xxx-cn-hangzhou.cn-hangzhou.log.aliyuncs.com/prometheus/workspace-default-cms-xxx-cn-hangzhou/xxx/api/v1/read'], + 'remoteReadIntraUrl' => ['description' => 'remote read内网URL。', 'type' => 'string', 'example' => 'http://workspace-default-cms-xxx-cn-hangzhou.cn-hangzhou-intranet.log.aliyuncs.com/prometheus/workspace-default-cms-xxx-cn-hangzhou/xxx/api/v1/read'], + 'remoteReadInternalUrl' => ['description' => 'RemoteRead的内网地址', 'type' => 'string', 'example' => 'http://workspace-default-cms-xxx-cn-hangzhou.cn-hangzhou-internal.log.aliyuncs.com/prometheus/workspace-default-cms-xxx-cn-hangzhou/xxx/api/v1/read'], + 'resourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-acfm3gn5i6bigbi'], + 'resourceType' => ['title' => '固定值：PrometheusView', 'description' => '固定值：PrometheusView', 'type' => 'string', 'example' => 'RegistryModule'], + 'status' => ['title' => '后端数据存储状态', 'description' => '后端数据存储状态', 'type' => 'string', 'example' => 'Pending2Running'], + 'supportAuthTypes' => [ + 'description' => '支持的认证类型。', + 'type' => 'array', + 'items' => ['description' => '支持的认证类型。', 'type' => 'string', 'example' => 'BasicAuth'], + ], + 'tags' => [ + 'description' => '实例的标签键。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'pagerDuty的集成key。', 'type' => 'string', 'example' => 'global_score_series'], + 'value' => ['description' => '标签Value。', 'type' => 'string', 'example' => '371293199010092839'], + ], + ], + ], + 'userId' => ['description' => '用户ID。', 'type' => 'string', 'example' => '11222'], + 'version' => ['title' => '版本', 'description' => '版本。', 'type' => 'string', 'example' => 'V1'], + 'workspace' => ['title' => '环境归属的工作空间', 'description' => '环境归属的工作空间', 'type' => 'string', 'example' => 'cms-monitor-test-aysls-pub-cn-fuzhou-monitor'], + 'folderUrl' => ['title' => '可观测大盘Url', 'description' => '可观测大盘URL。', 'type' => 'string', 'example' => 'https://xxxx'], + 'grafanaInstanceId' => ['title' => '绑定的托管grafana实例Id', 'description' => '绑定的托管grafana实例ID。', 'type' => 'string', 'example' => 'g-xxx '], + 'grafanaInstanceName' => ['title' => '绑定的托管grafana实例名称', 'description' => '绑定的托管grafana实例名称。', 'type' => 'string', 'example' => 'gxxx'], ], - 'example' => 'CS', - ], - 'parentAddonReleaseId' => [ - 'title' => '父级 AddonReleaseId。', - 'description' => '父级 AddonReleaseId。', - 'type' => 'string', - 'required' => false, - 'example' => 'policy-xxxxxxxxxxx', - ], - 'releaseName' => [ - 'title' => '接入后的插件名称，如果不指定则生成默认规则名称。', - 'description' => '接入后的插件名称。如果不指定则生成默认规则名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test-gpu-integration-name', - ], - 'values' => [ - 'title' => '输入的元数据。', - 'description' => '输入的元数据。', - 'type' => 'string', - 'required' => false, - 'example' => '{"install":{"mode":"auto-install","listenPort":"9400"},"discoverMode":"instances","discover":{"instances":"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44"},"scrapeInterval":"15","enableSecuritecs-nodeyGroupInjection":"true","metricTags":""}', - ], - 'version' => [ - 'title' => '需要接入监控的组件 Addon 版本。', - 'description' => '需要接入监控的组件 Addon 版本。', - 'type' => 'string', - 'required' => true, - 'example' => '0.0.2', - ], - 'workspace' => [ - 'title' => '安装组件资源的工作空间名称。'."\n", - 'description' => '安装组件资源的工作空间名称。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - 'entityRules' => [ - 'title' => '实体发现规则。', - 'description' => '字段规则', - 'required' => false, - '$ref' => '#/components/schemas/EntityDiscoverRule', ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusView\\": {\\n \\"authFreeReadPolicy\\": \\"{\\\\n \\\\\\"SourceIp\\\\\\": [\\\\n \\\\\\"192.168.1.0/24\\\\\\",\\\\n \\\\\\"172.168.2.22\\\\\\"\\\\n ],\\\\n \\\\\\"SourceVpc\\\\\\": [\\\\n \\\\\\"vpc-xx1\\\\\\",\\\\n \\\\\\"vpc-xx2\\\\\\"\\\\n ]\\\\n}\\",\\n \\"authToken\\": \\"eJxxxxxx\\",\\n \\"createTime\\": \\"2025-08-10T02:07:53Z\\",\\n \\"enableAuthFreeRead\\": true,\\n \\"enableAuthToken\\": true,\\n \\"httpApiInterUrl\\": \\"http://xxxxxxxx\\",\\n \\"httpApiIntraUrl\\": \\"http://xxxxxxxx\\",\\n \\"httpApiInternalUrl\\": \\"https://workspace-xxx.cn-hangzhou-internal.log.aliyuncs.com/prometheus/workspace-xxx/aliyun-prom-rw-xxx\\",\\n \\"instanceType\\": \\"prom-view\\",\\n \\"paymentType\\": \\"FREE\\",\\n \\"product\\": \\"cms\\",\\n \\"prometheusInstances\\": [\\n {\\n \\"prometheusInstanceId\\": \\"rw-63549e054ff596a4149927961dff\\",\\n \\"regionId\\": \\"cn-north-2-gov-1\\",\\n \\"userId\\": \\"122xxxxx\\"\\n }\\n ],\\n \\"prometheusViewId\\": \\"view-xxx\\",\\n \\"prometheusViewName\\": \\"view1\\",\\n \\"regionId\\": \\"cn-shanghai\\",\\n \\"remoteReadInterUrl\\": \\"http://workspace-default-cms-xxx-cn-hangzhou.cn-hangzhou.log.aliyuncs.com/prometheus/workspace-default-cms-xxx-cn-hangzhou/xxx/api/v1/read\\",\\n \\"remoteReadIntraUrl\\": \\"http://workspace-default-cms-xxx-cn-hangzhou.cn-hangzhou-intranet.log.aliyuncs.com/prometheus/workspace-default-cms-xxx-cn-hangzhou/xxx/api/v1/read\\",\\n \\"remoteReadInternalUrl\\": \\"http://workspace-default-cms-xxx-cn-hangzhou.cn-hangzhou-internal.log.aliyuncs.com/prometheus/workspace-default-cms-xxx-cn-hangzhou/xxx/api/v1/read\\",\\n \\"resourceGroupId\\": \\"rg-acfm3gn5i6bigbi\\",\\n \\"resourceType\\": \\"RegistryModule\\",\\n \\"status\\": \\"Pending2Running\\",\\n \\"supportAuthTypes\\": [\\n \\"BasicAuth\\"\\n ],\\n \\"tags\\": [\\n {\\n \\"key\\": \\"global_score_series\\",\\n \\"value\\": \\"371293199010092839\\"\\n }\\n ],\\n \\"userId\\": \\"11222\\",\\n \\"version\\": \\"V1\\",\\n \\"workspace\\": \\"cms-monitor-test-aysls-pub-cn-fuzhou-monitor\\",\\n \\"folderUrl\\": \\"https://xxxx\\",\\n \\"grafanaInstanceId\\": \\"g-xxx \\",\\n \\"grafanaInstanceName\\": \\"gxxx\\"\\n },\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8\\"\\n}","type":"json"}]', + 'title' => '查询指定Prometheus视图实例详情。', + 'description' => '查询指定Prometheus视图实例。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPrometheusView'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetPrometheusView', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'PrometheusView', 'arn' => 'acs:cms:{#regionId}:{#accountId}:prometheusview/{#prometheusViewId}'], ], - 'required' => false, ], ], + ], + ], + 'GetService' => [ + 'path' => '/workspace/{workspace}/service/{serviceId}', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'policyId', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'title' => '环境策略 ID。', - 'description' => '环境策略 ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-yyyyyyyyyy', - ], + 'schema' => ['title' => '工作空间', 'description' => '工作空间名称。', 'type' => 'string', 'required' => true, 'example' => 'workspace-test'], + ], + [ + 'name' => 'serviceId', + 'in' => 'path', + 'schema' => ['title' => '应用服务id', 'description' => '服务ID。', 'type' => 'string', 'required' => true, 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '返回数据。', - 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'release' => [ - 'title' => '接入组件信息。', - 'description' => '接入组件信息。', + 'requestId' => ['title' => '请求id', 'description' => '请求 ID', 'type' => 'string', 'example' => '264C3E89-BE6E-5F82-A484-CE9C2196C7DC'], + 'service' => [ + 'title' => '应用服务', + 'description' => '服务对象。', 'type' => 'object', 'properties' => [ - 'addonName' => [ - 'title' => '接入监控的组件 Addon 名称。', - 'description' => '接入监控的组件 Addon 名称。', + 'serviceId' => ['title' => '应用服务id', 'description' => '服务ID。', 'type' => 'string', 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb'."\n"], + 'serviceName' => ['title' => '应用资源名称', 'description' => '服务名称', 'type' => 'string', 'example' => 'demo-app'], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-05-13T03:32:55Z'], + 'serviceType' => [ + 'title' => '类型：TRACE（应用监控）/ RUM（用户体验监控）/ XTRACE（OT版）', + 'description' => '服务类型。', 'type' => 'string', - 'example' => 'cs-gpu', - ], - 'alertRuleCount' => [ - 'title' => '告警组数量。', - 'description' => '告警组数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', + 'enumValueTitles' => ['TRACE' => 'TRACE', 'RUM' => 'RUM', 'XTRACE' => 'XTRACE'], + 'example' => 'TRACE', ], - 'conditions' => [ - 'title' => '组件安装阶段信息。', - 'description' => '组件安装阶段信息。', + 'serviceStatus' => ['title' => '应用体验监控的服务状态，Running/Stopped/Created/Suspend', 'description' => '服务状态，仅当serviceType=RUM时有效。', 'type' => 'string', 'example' => 'Running'], + 'displayName' => ['title' => '别名', 'description' => '显示名称，仅当serviceType=RUM时有效。', 'type' => 'string', 'example' => 'demo应用'], + 'regionId' => ['title' => '地域 ID。', 'description' => '区域 ID', 'type' => 'string', 'example' => 'cn-heyuan'], + 'workspace' => ['title' => '工作空间', 'description' => '工作空间名称', 'type' => 'string', 'example' => 'default-cms-1106439496876715-cn-hangzhou'], + 'pid' => ['title' => '对应ARMS应用pid', 'description' => '兼容历史的ARMS应用ID', 'type' => 'string', 'example' => 'by6rjzro2j@0fe8dfa799e5906'], + 'description' => ['title' => '应用描述信息。', 'description' => '描述，仅当serviceType=RUM时有效。', 'type' => 'string', 'example' => 'test'], + 'attributes' => ['title' => '特征信息，key:value格式', 'description' => '扩展信息。', 'type' => 'string', 'example' => '{"language":"java"}'], + 'resourceGroupId' => ['title' => '资源组id', 'description' => '资源组id', 'type' => 'string', 'example' => 'rg-aekxxzuad5zzzz'], + 'tags' => [ + 'title' => '标签数组', + 'description' => '标签数组', 'type' => 'array', 'items' => [ - 'description' => '操作符，支持精确匹配、前缀匹配、正则表达式三种方式。', + 'title' => '标签', + 'description' => '标签', 'type' => 'object', 'properties' => [ - 'firstTransitionTime' => [ - 'title' => '第一次转换时间。', - 'description' => '第一次转换时间。', - 'type' => 'string', - 'example' => '2024-11-04T16:10:22+08:00', - ], - 'lastTransitionTime' => [ - 'title' => '最后一次转换时间。', - 'description' => '最后一次转换时间。', - 'type' => 'string', - 'example' => '2024-11-04T16:10:22+08:00', - ], - 'message' => [ - 'title' => '详细信息。', - 'description' => '详细信息。', - 'type' => 'string', - 'example' => 'The addon loaded successfully', - ], - 'status' => [ - 'title' => '阶段状态。', - 'description' => '阶段状态。', - 'type' => 'string', - 'example' => '{\'phase\': \'Created\', \'executionDetails\': [], \'invocations\': [], \'latestExecError\': {\'message\': \'\', \'code\': \'\', \'requestId\': \'\', \'extraInfo\': \'\', \'title\': \'\'}}', - ], - 'type' => [ - 'title' => '阶段类型。', - 'description' => '阶段类型。', - 'type' => 'string', - 'example' => 'Loaded', - ], + 'key' => ['title' => '标签key', 'description' => '标签key', 'type' => 'string', 'example' => 'env'], + 'value' => ['title' => '标签value', 'description' => '标签value', 'type' => 'string', 'example' => 'prod'], ], ], ], - 'config' => [ - 'title' => '组件配置。', - 'description' => '组件配置。', - 'type' => 'string', - 'example' => '{"install":{"mode":"auto-install","listenPort":"9400"},"discoverMode":"instances","discover":{"instances":"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44"},"scrapeInterval":"15","enableSecuritecs-nodeyGroupInjection":"true","metricTags":""}', - ], - 'createTime' => [ - 'title' => '接入时间。', - 'description' => '接入时间。', - 'type' => 'string', - 'example' => '2024-11-05T15:21:30+08:00', - ], - 'dashboardCount' => [ - 'title' => '大盘数量。', - 'description' => '大盘数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'environmentId' => [ - 'title' => '环境 ID。', - 'description' => '环境 ID。', - 'type' => 'string', - 'example' => 'policy-xxxxxxxxxxx', - ], - 'exporterCount' => [ - 'title' => '插件数量。', - 'description' => '插件数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'haveConfig' => [ - 'title' => '是否有配置。', - 'description' => '是否有配置。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'installUserId' => [ - 'title' => '安装的用户 ID。', - 'description' => '安装的用户 ID。', - 'type' => 'string', - 'example' => '1654218965xxxxxx', - ], - 'language' => [ - 'title' => '语言。', - 'description' => '语言。', - 'type' => 'string', - 'example' => 'zh', - ], - 'managed' => [ - 'title' => '是否为托管组件。', - 'description' => '是否为托管组件。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'parentAddonReleaseId' => [ - 'title' => '父级 AddonReleaseId。', - 'description' => '父级 AddonReleaseId。', - 'type' => 'string', - 'example' => 'policy-xxxxxxxxxxx', - ], - 'policyId' => [ - 'title' => '策略环境 ID。', - 'description' => '策略环境 ID。', - 'type' => 'string', - 'example' => 'policy-xxxxxxxxxx', - ], - 'regionId' => [ - 'title' => '地域 ID。', - 'description' => '地域 ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'releaseId' => [ - 'title' => '安装后的 ReleaseID。', - 'description' => '安装后的 ReleaseID。', - 'type' => 'string', - 'example' => '2e898e60-5e6a-46d1-a994-xxxxxxxxxx', - ], - 'releaseName' => [ - 'title' => 'Release 的名称。', - 'description' => 'Release 的名称。', - 'type' => 'string', - 'example' => 'test-gpu-integration-name', - ], - 'scene' => [ - 'title' => '组件场景。', - 'description' => '组件场景。', - 'type' => 'string', - 'example' => '1', - ], - 'status' => [ - 'title' => '组件状态。', - 'description' => '组件状态。', - 'type' => 'string', - 'example' => '200', - ], - 'updateTime' => [ - 'title' => '更新时间。', - 'description' => '更新时间。', - 'type' => 'string', - 'example' => '2024-09-13T02:21:02Z', - ], - 'userId' => [ - 'title' => '所属用户 ID。', - 'description' => '所属用户 ID。', - 'type' => 'string', - 'example' => '165421896xxxxxx', - ], - 'version' => [ - 'title' => '组件版本。', - 'description' => '组件版本。', - 'type' => 'string', - 'example' => '1.0.0', - ], - 'envType' => [ - 'title' => '环境类型。', - 'description' => '环境类型。', - 'type' => 'string', - 'example' => 'CS', - ], - 'workspace' => [ - 'title' => '工作空间。', - 'description' => '工作空间。', - 'type' => 'string', - 'example' => 'default', - ], - 'entityRules' => [ - 'title' => '实体详情。', - 'description' => '实体详情。', - '$ref' => '#/components/schemas/EntityGroupBase', - ], ], ], - 'requestId' => [ - 'title' => '请求 ID。', - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', - ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidService.NotFound', 'errorMessage' => 'The specified Service does not exist.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询应用可观测服务', + 'summary' => '查询应用可观测服务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '40', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetService'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"release\\": {\\n \\"addonName\\": \\"cs-gpu\\",\\n \\"alertRuleCount\\": 6,\\n \\"conditions\\": [\\n {\\n \\"firstTransitionTime\\": \\"2024-11-04T16:10:22+08:00\\",\\n \\"lastTransitionTime\\": \\"2024-11-04T16:10:22+08:00\\",\\n \\"message\\": \\"The addon loaded successfully\\",\\n \\"status\\": \\"{\'phase\': \'Created\', \'executionDetails\': [], \'invocations\': [], \'latestExecError\': {\'message\': \'\', \'code\': \'\', \'requestId\': \'\', \'extraInfo\': \'\', \'title\': \'\'}}\\",\\n \\"type\\": \\"Loaded\\"\\n }\\n ],\\n \\"config\\": \\"{\\\\\\"install\\\\\\":{\\\\\\"mode\\\\\\":\\\\\\"auto-install\\\\\\",\\\\\\"listenPort\\\\\\":\\\\\\"9400\\\\\\"},\\\\\\"discoverMode\\\\\\":\\\\\\"instances\\\\\\",\\\\\\"discover\\\\\\":{\\\\\\"instances\\\\\\":\\\\\\"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44\\\\\\"},\\\\\\"scrapeInterval\\\\\\":\\\\\\"15\\\\\\",\\\\\\"enableSecuritecs-nodeyGroupInjection\\\\\\":\\\\\\"true\\\\\\",\\\\\\"metricTags\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"createTime\\": \\"2024-11-05T15:21:30+08:00\\",\\n \\"dashboardCount\\": 3,\\n \\"environmentId\\": \\"policy-xxxxxxxxxxx\\",\\n \\"exporterCount\\": 2,\\n \\"haveConfig\\": true,\\n \\"installUserId\\": \\"1654218965xxxxxx\\",\\n \\"language\\": \\"zh\\",\\n \\"managed\\": true,\\n \\"parentAddonReleaseId\\": \\"policy-xxxxxxxxxxx\\",\\n \\"policyId\\": \\"policy-xxxxxxxxxx\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"releaseId\\": \\"2e898e60-5e6a-46d1-a994-xxxxxxxxxx\\",\\n \\"releaseName\\": \\"test-gpu-integration-name\\",\\n \\"scene\\": \\"1\\",\\n \\"status\\": \\"200\\",\\n \\"updateTime\\": \\"2024-09-13T02:21:02Z\\",\\n \\"userId\\": \\"165421896xxxxxx\\",\\n \\"version\\": \\"1.0.0\\",\\n \\"envType\\": \\"CS\\",\\n \\"workspace\\": \\"default\\",\\n \\"entityRules\\": {\\n \\"workspace\\": \\"\\",\\n \\"regionId\\": \\"\\",\\n \\"entityQueries\\": [\\n {\\n \\"entityType\\": \\"\\",\\n \\"spl\\": \\"\\"\\n }\\n ],\\n \\"description\\": \\"\\",\\n \\"entityGroupId\\": \\"\\",\\n \\"entityRules\\": {\\n \\"ipMatchRule\\": [\\n {\\n \\"ipFieldKey\\": \\"\\",\\n \\"ipCIDR\\": \\"\\"\\n }\\n ],\\n \\"instanceIds\\": [\\n \\"\\"\\n ],\\n \\"fieldRules\\": [\\n {\\n \\"op\\": \\"\\",\\n \\"fieldKey\\": \\"\\",\\n \\"fieldValues\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"annotations\\": [\\n {\\n \\"op\\": \\"\\",\\n \\"tagKey\\": \\"\\",\\n \\"tagValues\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"resourceGroupId\\": \\"\\",\\n \\"entityTypes\\": [\\n \\"\\"\\n ],\\n \\"regionIds\\": [\\n \\"\\"\\n ],\\n \\"tags\\": [\\n {\\n \\"op\\": \\"\\",\\n \\"tagKey\\": \\"\\",\\n \\"tagValues\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"labels\\": [\\n {\\n \\"op\\": \\"\\",\\n \\"tagKey\\": \\"\\",\\n \\"tagValues\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n },\\n \\"entityGroupName\\": \\"\\",\\n \\"userId\\": \\"\\"\\n }\\n },\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', - 'title' => '安装接入组件', - 'description' => '用于创建一个站点监控任务', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Service', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#Workspace}/service/{#ServiceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-BE6E-5F82-A484-CE9C2196C7DC\\",\\n \\"service\\": {\\n \\"serviceId\\": \\"cwzxvuc6uo@4bc6b15ad81f166174ffb\\\\n\\",\\n \\"serviceName\\": \\"demo-app\\",\\n \\"createTime\\": \\"2025-05-13T03:32:55Z\\",\\n \\"serviceType\\": \\"TRACE\\",\\n \\"serviceStatus\\": \\"Running\\",\\n \\"displayName\\": \\"demo应用\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"workspace\\": \\"default-cms-1106439496876715-cn-hangzhou\\",\\n \\"pid\\": \\"by6rjzro2j@0fe8dfa799e5906\\",\\n \\"description\\": \\"test\\",\\n \\"attributes\\": \\"{\\\\\\"language\\\\\\":\\\\\\"java\\\\\\"}\\",\\n \\"resourceGroupId\\": \\"rg-aekxxzuad5zzzz\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"env\\",\\n \\"value\\": \\"prod\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'GetServiceObservability' => [ - 'summary' => '获取应用可观测实例', 'path' => '/workspace/{workspace}/service-observability/{type}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'description' => 'CMS2.0工作空间', - 'type' => 'string', - 'required' => true, - 'example' => 'my-test-ws', - ], + 'schema' => ['description' => 'CMS2.0工作空间', 'type' => 'string', 'required' => true, 'example' => 'my-test-ws'], ], [ 'name' => 'type', @@ -13605,10 +11589,7 @@ 'description' => '应用可观测类型', 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'rum' => '用户体验监控', - 'apm' => '应用性能监控', - ], + 'enumValueTitles' => ['rum' => '用户体验监控', 'apm' => '应用性能监控'], 'example' => 'apm', ], ], @@ -13620,263 +11601,336 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '4852B9B5-345C-5CBC-A15F-786D83ECCBBA', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '4852B9B5-345C-5CBC-A15F-786D83ECCBBA'], 'type' => [ 'description' => '应用可观测类型', 'type' => 'string', - 'enumValueTitles' => [ - 'rum' => 'rum', - 'apm' => 'apm', - ], + 'enumValueTitles' => ['rum' => 'rum', 'apm' => 'apm'], 'example' => 'apm', ], - 'regionId' => [ - 'description' => '区域', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'workspace' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'example' => 'default-cms-1654218***343050-cn-hangzhou', - ], + 'regionId' => ['description' => '区域', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'workspace' => ['description' => '工作空间名称', 'type' => 'string', 'example' => 'default-cms-1654218***343050-cn-hangzhou'], 'status' => [ 'description' => '资源初始化状态', 'type' => 'string', - 'enumValueTitles' => [ - 'Running' => '正常', - ], + 'enumValueTitles' => ['Running' => '正常'], 'example' => 'Running', ], 'entryPointInfo' => [ 'description' => '接入点以及认证信息', 'type' => 'object', 'properties' => [ - 'authToken' => [ - 'description' => '上报数据的认证Token', - 'type' => 'string', - 'example' => 'gaddp****@de20f2***1ce***', - ], - 'publicDomain' => [ - 'description' => '公网访问地址。', - 'type' => 'string', - 'example' => 'project-xtrace-xxxx-cn-hangzhou.cn-hangzhou.log.aliyuncs.com', - ], - 'privateDomain' => [ - 'description' => '私网访问地址', - 'type' => 'string', - 'example' => 'project-xtrace-xxxx-cn-hangzhou.cn-hangzhou-intranet.log.aliyuncs.com', - ], - 'project' => [ - 'description' => 'SLS Project', - 'type' => 'string', - 'example' => 'proj-xtrace-xxxxx', - ], + 'authToken' => ['description' => '上报数据的认证Token', 'type' => 'string', 'example' => 'gaddp****@de20f2***1ce***'], + 'publicDomain' => ['description' => '公网访问地址。', 'type' => 'string', 'example' => 'project-xtrace-xxxx-cn-hangzhou.cn-hangzhou.log.aliyuncs.com'], + 'privateDomain' => ['description' => '私网访问地址', 'type' => 'string', 'example' => 'project-xtrace-xxxx-cn-hangzhou.cn-hangzhou-intranet.log.aliyuncs.com'], + 'project' => ['description' => 'SLS Project', 'type' => 'string', 'example' => 'proj-xtrace-xxxxx'], ], ], - 'feeType' => [ - 'description' => '计费类型', - 'type' => 'string', - 'example' => 'arms=serverless;xtrace=serverless', - ], + 'feeType' => ['description' => '计费类型', 'type' => 'string', 'example' => 'arms=serverless;xtrace=serverless'], 'settings' => [ 'description' => '系统配置', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{"trace_aggregate":"enable"}', - 'description' => '配置KV对', - ], + 'additionalProperties' => ['type' => 'string', 'example' => '{"trace_aggregate":"enable"}', 'description' => '配置KV对'], ], 'quotas' => [ 'description' => '限额配置', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{"arms_agent_hour": "48"}', - 'description' => '限额配置项Key。', - ], + 'additionalProperties' => ['type' => 'string', 'example' => '{"arms_agent_hour": "48"}', 'description' => '限额配置项Key。'], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4852B9B5-345C-5CBC-A15F-786D83ECCBBA\\",\\n \\"type\\": \\"apm\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"workspace\\": \\"default-cms-1654218***343050-cn-hangzhou\\",\\n \\"status\\": \\"Running\\",\\n \\"entryPointInfo\\": {\\n \\"authToken\\": \\"gaddp****@de20f2***1ce***\\",\\n \\"publicDomain\\": \\"project-xtrace-xxxx-cn-hangzhou.cn-hangzhou.log.aliyuncs.com\\",\\n \\"privateDomain\\": \\"project-xtrace-xxxx-cn-hangzhou.cn-hangzhou-intranet.log.aliyuncs.com\\",\\n \\"project\\": \\"proj-xtrace-xxxxx\\"\\n },\\n \\"feeType\\": \\"arms=serverless;xtrace=serverless\\",\\n \\"settings\\": {\\n \\"key\\": \\"{\\\\\\"trace_aggregate\\\\\\":\\\\\\"enable\\\\\\"}\\"\\n },\\n \\"quotas\\": {\\n \\"key\\": \\"{\\\\\\"arms_agent_hour\\\\\\": \\\\\\"48\\\\\\"}\\"\\n }\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '获取应用可观测', + 'summary' => '获取应用可观测实例', 'extraInfo' => 'settIngs系统配置支持如下：'."\n" .'* trace_aggregate : enable / disable，用于开源探针接入场景控制是否关闭指标生成', - ], - 'DeleteService' => [ - 'summary' => '删除应用可观测服务', - 'path' => '/workspace/{workspace}/service/{serviceId}', - 'methods' => [ - 'delete', + 'changeSet' => [ + ['createdAt' => '2025-07-23T04:58:08.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetServiceObservability'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetServiceObservability', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Workspace', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/service-observability/{#type}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4852B9B5-345C-5CBC-A15F-786D83ECCBBA\\",\\n \\"type\\": \\"apm\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"workspace\\": \\"default-cms-1654218***343050-cn-hangzhou\\",\\n \\"status\\": \\"Running\\",\\n \\"entryPointInfo\\": {\\n \\"authToken\\": \\"gaddp****@de20f2***1ce***\\",\\n \\"publicDomain\\": \\"project-xtrace-xxxx-cn-hangzhou.cn-hangzhou.log.aliyuncs.com\\",\\n \\"privateDomain\\": \\"project-xtrace-xxxx-cn-hangzhou.cn-hangzhou-intranet.log.aliyuncs.com\\",\\n \\"project\\": \\"proj-xtrace-xxxxx\\"\\n },\\n \\"feeType\\": \\"arms=serverless;xtrace=serverless\\",\\n \\"settings\\": {\\n \\"key\\": \\"{\\\\\\"trace_aggregate\\\\\\":\\\\\\"enable\\\\\\"}\\"\\n },\\n \\"quotas\\": {\\n \\"key\\": \\"{\\\\\\"arms_agent_hour\\\\\\": \\\\\\"48\\\\\\"}\\"\\n }\\n}","type":"json"}]', + ], + 'GetServiceRecord' => [ + 'path' => '/workspace/{workspace}/service/{serviceId}/record', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'title' => '工作空间', - 'description' => '工作空间名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - ], + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'workspace-test'], ], [ 'name' => 'serviceId', 'in' => 'path', + 'schema' => ['description' => '服务ID。', 'type' => 'string', 'required' => true, 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb'], + ], + [ + 'name' => 'recordType', + 'in' => 'query', 'schema' => [ - 'title' => '应用服务id', - 'description' => '服务ID。', + 'title' => '关联条目类型，目前支持:'."\n" + .'logCorrelation，标识应用日志关联', + 'description' => '关联条目类型，目前支持:'."\n" + .'logCorrelation，标识应用日志关联', 'type' => 'string', 'required' => true, - 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', + 'example' => 'logCorrelation', + 'enum' => ['logCorrelation'], ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求id', - 'description' => '请求 ID', - 'type' => 'string', - 'example' => '51B6A3E8-EA9E-5143-BE11-8E5F83474C95', + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'record' => [ + 'description' => '记录数', + 'type' => 'object', + 'properties' => [ + 'workspace' => ['title' => '工作空间', 'description' => '工作空间', 'type' => 'string', 'example' => 'default-cms-1610600919225911-cn-beijing'], + 'serviceId' => ['title' => '服务唯一标识', 'description' => '服务唯一标识', 'type' => 'string', 'example' => 'ckj0xn6ma3@b96491402f8e1f15a8c79'], + 'recordType' => ['title' => '关联条目类型，目前支持:'."\n" + .'logCorrelation，标识应用日志关联', 'description' => '关联条目类型，目前支持:'."\n" + .'logCorrelation，标识应用日志关联', 'type' => 'string', 'example' => 'logCorrelation'], + 'recordContent' => ['title' => '条目内容，一般为JSON格式，不同的recordType的格式不同；'."\n" + .'当recordType=logCorreation时，recordContent的示例请求内容为：{"project":"proj-xtrace-16c988dcfe21fcb73c5e6f234927d998-cn-hangzhou","storeName":"app-biz-log","regionId":"cn-hangzhou","bindType":"logstore","traceIdRelateField":""}', 'description' => '条目内容，JSON字符串格式，不同的recordType返回内容不同；', 'type' => 'string', 'example' => '{"project":"proj-xtrace-16c988dcfe21fcb73c5e6f234927d998-cn-hangzhou","storeName":"app-biz-log","regionId":"cn-hangzhou","bindType":"logstore","traceIdRelateField":""}'], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取服务关联条目', + 'summary' => '查询服务关联条目', + 'description' => '获取服务关联条目', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"51B6A3E8-EA9E-5143-BE11-8E5F83474C95\\"\\n}","type":"json"}]', - 'title' => '删除应用可观测服务', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"record\\": {\\n \\"workspace\\": \\"default-cms-1610600919225911-cn-beijing\\",\\n \\"serviceId\\": \\"ckj0xn6ma3@b96491402f8e1f15a8c79\\",\\n \\"recordType\\": \\"logCorrelation\\",\\n \\"recordContent\\": \\"{\\\\\\"project\\\\\\":\\\\\\"proj-xtrace-16c988dcfe21fcb73c5e6f234927d998-cn-hangzhou\\\\\\",\\\\\\"storeName\\\\\\":\\\\\\"app-biz-log\\\\\\",\\\\\\"regionId\\\\\\":\\\\\\"cn-hangzhou\\\\\\",\\\\\\"bindType\\\\\\":\\\\\\"logstore\\\\\\",\\\\\\"traceIdRelateField\\\\\\":\\\\\\"\\\\\\"}\\"\\n }\\n}","type":"json"}]', ], - 'UpdateService' => [ - 'summary' => '更新应用可观测服务', - 'path' => '/workspace/{workspace}/service/{serviceId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'GetUmodel' => [ + 'path' => '/workspace/{workspace}/umodel', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'workspace-test'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '工作空间', - 'description' => '工作空间名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', + 'type' => 'object', + 'properties' => [ + 'commonSchemaRef' => [ + 'description' => '目前无需填充该字段内容', + 'type' => 'array', + 'items' => [ + 'description' => '目前无需填充该字段内容', + 'type' => 'object', + 'properties' => [ + 'group' => ['description' => '公共Umodel Schema group', 'type' => 'string', 'example' => 'test-job-123123'], + 'version' => ['description' => '版本', 'type' => 'string', 'example' => '5'], + ], + ], + ], + 'description' => ['description' => 'Umodel描述', 'type' => 'string', 'example' => 'workspace test'], + 'regionId' => ['description' => '所在地域', 'type' => 'string', 'example' => 'cn-heyuan'], + 'requestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '123-123123-sdf-435-3123'], + 'workspace' => ['description' => '工作空间名称。', 'type' => 'string', 'example' => 'workspace-test'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取 Umodel', + 'summary' => '获取Umodel配置信息。', + 'description' => '获取Umodel配置信息', + 'changeSet' => [ + ['createdAt' => '2025-08-12T02:41:41.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUmodel'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'serviceId', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetUmodel', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Umodel', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/umodel'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"commonSchemaRef\\": [\\n {\\n \\"group\\": \\"test-job-123123\\",\\n \\"version\\": \\"5\\"\\n }\\n ],\\n \\"description\\": \\"workspace test\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"requestId\\": \\"123-123123-sdf-435-3123\\",\\n \\"workspace\\": \\"workspace-test\\"\\n}","type":"json"}]', + ], + 'GetUmodelCommonSchemaRef' => [ + 'path' => '/workspace/{workspace}/umodel/common-schema-ref', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'workspace', 'in' => 'path', + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'workspace-test'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '应用资源id', - 'description' => '服务ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', + 'type' => 'object', + 'properties' => [ + 'commonSchemaRef' => [ + 'description' => '引用的公共Umodel Schema。', + 'type' => 'array', + 'items' => [ + 'description' => '引用的公共Umodel Schema。', + 'type' => 'object', + 'properties' => [ + 'group' => ['description' => '公共Umodel Schema group', 'type' => 'string', 'example' => 'apm-common'], + 'version' => ['description' => '版本。', 'type' => 'string', 'example' => '0.1.0'], + ], + ], + ], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取引用的公共Umodel Schema', + 'summary' => '获取引用的公共Umodel Schema。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUmodelCommonSchemaRef'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetUmodelCommonSchemaRef', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Umodel', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/umodel'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"commonSchemaRef\\": [\\n {\\n \\"group\\": \\"apm-common\\",\\n \\"version\\": \\"0.1.0\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetUmodelData' => [ + 'summary' => '获取相关联的 Umodel 图数据。', + 'path' => '/workspace/{workspace}/umodel/graph', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'workspace-test'], + ], + [ + 'name' => 'method', + 'in' => 'query', + 'schema' => ['description' => '方法', 'type' => 'string', 'required' => true, 'example' => 'ListData'], + ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => '应用服务', - 'description' => '请求体参数。', + 'description' => '请求 Body', 'type' => 'object', 'properties' => [ - 'displayName' => [ - 'title' => '别名', - 'description' => '显示名称，仅当serviceType=RUM时有效。', - 'type' => 'string', - 'required' => false, - 'example' => 'api-monitor-test', - ], - 'description' => [ - 'title' => '应用描述信息。', - 'description' => '服务描述，仅当serviceType=RUM时有效。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'attributes' => [ - 'title' => '特征信息，key:value格式', - 'description' => '扩展属性。', - 'type' => 'string', - 'required' => false, - 'example' => '{"language":"java"}', - ], - 'serviceStatus' => [ - 'title' => '应用体验监控的服务状态，Running/Stopped/Created/Suspend', - 'description' => '服务状态，仅当serviceType=RUM时有效。', - 'type' => 'string', - 'required' => false, - 'example' => 'Stopped', - ], + 'content' => ['description' => '查询条件', 'type' => 'any', 'required' => false, 'example' => '{'."\n" + .' "filter": {'."\n" + .' "domains": []'."\n" + .' },'."\n" + .' "offset": 0,'."\n" + .' "size": 100000'."\n" + .'}'], ], 'required' => false, ], @@ -13885,537 +11939,679 @@ 'responses' => [ 200 => [ 'schema' => [ + 'description' => '返回结果', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求id', - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => '123-0F43-23423-AC43-34234', + 'nodes' => [ + 'description' => '节点列表', + 'type' => 'array', + 'items' => ['description' => '节点。', 'type' => 'any', 'example' => '{}'], ], - 'serviceId' => [ - 'title' => '应用服务id', - 'description' => '服务ID。', - 'type' => 'string', - 'example' => 'em87vd@c2e25bcfe0e21ce0***', + 'links' => [ + 'description' => '节点 link 关系列表', + 'type' => 'array', + 'items' => ['description' => '节点 link 关系', 'type' => 'any', 'example' => '{}'], + ], + 'totalNodesCount' => ['description' => '总节点数', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'totalLinksCount' => ['description' => '总节点 link 关系数', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'errors' => [ + 'description' => '错误信息', + 'type' => 'array', + 'items' => [ + 'description' => '错误信息', + 'type' => 'object', + 'properties' => [ + 'message' => ['description' => '详细信息', 'type' => 'string', 'example' => 'ok'], + 'type' => ['description' => '错误类型', 'type' => 'string', 'example' => 'external'], + ], + ], ], + 'requestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '123-123-234-345-123'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"123-0F43-23423-AC43-34234\\",\\n \\"serviceId\\": \\"em87vd@c2e25bcfe0e21ce0***\\"\\n}","type":"json"}]', - 'title' => '更新应用可观测服务', - ], - 'GetService' => [ - 'summary' => '查询应用可观测服务', - 'path' => '/workspace/{workspace}/service/{serviceId}', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取 Umodel Data', + 'description' => '查找Umodel', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUmodelData'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetUmodelData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Umodel', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/umodel'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"nodes\\": [\\n \\"{}\\"\\n ],\\n \\"links\\": [\\n \\"{}\\"\\n ],\\n \\"totalNodesCount\\": 0,\\n \\"totalLinksCount\\": 0,\\n \\"errors\\": [\\n {\\n \\"message\\": \\"ok\\",\\n \\"type\\": \\"external\\"\\n }\\n ],\\n \\"requestId\\": \\"123-123-234-345-123\\"\\n}","type":"json"}]', + ], + 'GetWorkspace' => [ + 'path' => '/workspace/{workspaceName}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'workspace', + 'name' => 'workspaceName', 'in' => 'path', + 'schema' => ['title' => '实例 ID。', 'description' => '实例 ID', 'type' => 'string', 'required' => true, 'example' => 'workspace-test-001'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '工作空间', - 'description' => '工作空间名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'createTime' => ['description' => '创建时间', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2025-03-11T08:21:58Z'], + 'description' => ['title' => '工作空间描述', 'description' => '工作空间描述', 'type' => 'string', 'example' => 'workspace test', 'pattern' => '', 'default' => ''], + 'lastModifyTime' => ['description' => '更新时间', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2025-03-11T08:21:58Z'], + 'regionId' => ['title' => '地域ID', 'description' => '地域 ID', 'type' => 'string', 'example' => 'cn-heyuan', 'pattern' => '', 'default' => ''], + 'requestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'slsProject' => ['title' => '日志服务项目名称', 'description' => '日志服务项目名称', 'type' => 'string', 'example' => 'sls-project-test-001', 'pattern' => '', 'default' => ''], + 'workspaceName' => ['title' => '工作空间名称', 'description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'workspace-test-001', 'pattern' => '', 'default' => ''], + 'displayName' => ['description' => '工作空间展示名称', 'type' => 'string', 'example' => 'workspace-test'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取工作空间', + 'summary' => '获取工作空间。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWorkspace'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'serviceId', - 'in' => 'path', - 'schema' => [ - 'title' => '应用服务id', - 'description' => '服务ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetWorkspace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Workspace', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspaceName}'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"createTime\\": \\"2025-03-11T08:21:58Z\\",\\n \\"description\\": \\"workspace test\\",\\n \\"lastModifyTime\\": \\"2025-03-11T08:21:58Z\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"slsProject\\": \\"sls-project-test-001\\",\\n \\"workspaceName\\": \\"workspace-test-001\\",\\n \\"displayName\\": \\"workspace-test\\"\\n}","type":"json"}]', + ], + 'ListAddonReleases' => [ + 'path' => '/integration-policies/{policyId}/addon-releases', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'policyId', + 'in' => 'path', + 'schema' => ['title' => '策略环境 ID。', 'description' => '策略环境 ID。', 'type' => 'string', 'required' => true, 'example' => 'policy-xxxxxxxxxxxx'], + ], + [ + 'name' => 'addonName', + 'in' => 'query', + 'schema' => ['title' => '组件 Addon 名称。', 'description' => '组件 Addon 名称。', 'type' => 'string', 'required' => false, 'example' => 'cs-gpu'], + ], + [ + 'name' => 'parentAddonReleaseId', + 'in' => 'query', + 'schema' => ['title' => '父级 AddonReleaseId。', 'description' => '父级 AddonReleaseId。', 'type' => 'string', 'required' => false, 'example' => 'policy-xxxxxxxxxxxxx'], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['type' => 'string'], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['type' => 'string'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求id', - 'description' => '请求 ID', - 'type' => 'string', - 'example' => '264C3E89-BE6E-5F82-A484-CE9C2196C7DC', - ], - 'service' => [ - 'title' => '应用服务', - 'description' => '服务对象。', - 'type' => 'object', - 'properties' => [ - 'serviceId' => [ - 'title' => '应用服务id', - 'description' => '服务ID。', - 'type' => 'string', - 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb'."\n", - ], - 'serviceName' => [ - 'title' => '应用资源名称', - 'description' => '服务名称', - 'type' => 'string', - 'example' => 'demo-app', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2025-05-13T03:32:55Z', - ], - 'serviceType' => [ - 'title' => '类型：TRACE（应用监控）/ RUM（用户体验监控）/ XTRACE（OT版）', - 'description' => '服务类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'TRACE' => 'TRACE', - 'RUM' => 'RUM', - 'XTRACE' => 'XTRACE', + 'releases' => [ + 'description' => '接入组件信息集。', + 'type' => 'array', + 'items' => [ + 'description' => '接入组件信息集。', + 'type' => 'object', + 'properties' => [ + 'addonName' => ['title' => 'Addon 名称。', 'description' => 'Addon 名称。', 'type' => 'string', 'example' => 'cs-gpu'], + 'alertRuleCount' => ['title' => '告警规则数量。', 'description' => '告警规则数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '6'], + 'conditions' => [ + 'title' => '安装阶段状况信息汇总。'."\n" + ."\n" + .'Type 包括四个：Loaded（加载配置），Installed（执行安装），Ready（执行安装后就绪检查），UnInstalled（执行卸载）。四个状况理论上顺序出现。'."\n" + ."\n" + .'Status: 可选值包括：Unknown(正处在当前阶段执行)，True（执行就绪），False（执行失败）'."\n" + ."\n" + .'完整状态判断说明：'."\n" + .'Loaded，Installed，Ready 只要有一个的 Status=False，则代表安装失败，Ready 的 Status=True，则代表安装成功，其他情况则代表正在安装中。'."\n" + ."\n" + .'UnInstalled 只要存在，则代表正在执行卸载。Status=True 则代表卸载成功，Status=Unknown 代表执行卸载中，Status=False 代表卸载失败。'."\n", + 'description' => '安装阶段信息。', + 'type' => 'array', + 'items' => [ + 'description' => '安装阶段信息。', + 'type' => 'object', + 'properties' => [ + 'firstTransitionTime' => ['title' => '第一次转换时间。', 'description' => '第一次转换时间。', 'type' => 'string', 'example' => '2024-11-04T16:10:22+08:00'], + 'lastTransitionTime' => ['title' => '最后一次转换时间。', 'description' => '最后一次转换时间。', 'type' => 'string', 'example' => '2024-11-04T16:10:22+08:00'], + 'message' => ['title' => '详细信息。', 'description' => '详细信息。', 'type' => 'string', 'example' => 'The addon loaded successfully'], + 'status' => ['title' => '阶段状态。', 'description' => '阶段状态。', 'type' => 'string', 'example' => 'True'], + 'type' => ['title' => '阶段类型。', 'description' => '阶段类型。', 'type' => 'string', 'example' => 'Loaded'], + ], + ], ], - 'example' => 'TRACE', - ], - 'serviceStatus' => [ - 'title' => '应用体验监控的服务状态，Running/Stopped/Created/Suspend', - 'description' => '服务状态，仅当serviceType=RUM时有效。', - 'type' => 'string', - 'example' => 'Running', - ], - 'displayName' => [ - 'title' => '别名', - 'description' => '显示名称，仅当serviceType=RUM时有效。', - 'type' => 'string', - 'example' => 'demo应用', - ], - 'regionId' => [ - 'title' => '地域 ID。', - 'description' => '区域 ID', - 'type' => 'string', - 'example' => 'cn-heyuan', - ], - 'workspace' => [ - 'title' => '工作空间', - 'description' => '工作空间名称', - 'type' => 'string', - 'example' => 'default-cms-1106439496876715-cn-hangzhou', - ], - 'pid' => [ - 'title' => '对应ARMS应用pid', - 'description' => '兼容历史的ARMS应用ID', - 'type' => 'string', - 'example' => 'by6rjzro2j@0fe8dfa799e5906', - ], - 'description' => [ - 'title' => '应用描述信息。', - 'description' => '描述，仅当serviceType=RUM时有效。', - 'type' => 'string', - 'example' => 'test', - ], - 'attributes' => [ - 'title' => '特征信息，key:value格式', - 'description' => '扩展信息。', - 'type' => 'string', - 'example' => '{"language":"java"}', - ], - 'resourceGroupId' => [ - 'title' => '资源组id', - 'description' => '资源组id', - 'type' => 'string', - 'example' => 'rg-aekxxzuad5zzzz', - ], - 'tags' => [ - 'title' => '标签数组', - 'description' => '标签数组', - 'type' => 'array', - 'items' => [ - 'title' => '标签', - 'description' => '标签', + 'config' => ['title' => '组件配置信息。', 'description' => '组件配置信息。', 'type' => 'string', 'example' => '{"install":{"mode":"auto-install","listenPort":"9400"},"discoverMode":"instances","discover":{"instances":"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44"},"scrapeInterval":"15","enableSecuritecs-nodeyGroupInjection":"true","metricTags":""}'], + 'createTime' => ['title' => '接入时间。', 'description' => '接入时间。', 'type' => 'string', 'example' => '2024-11-04T16:10:12+08:00'], + 'dashboardCount' => ['title' => '大盘数量。', 'description' => '大盘数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'environmentId' => ['title' => '环境 ID。', 'description' => '环境 ID。', 'type' => 'string', 'example' => 'policy-xxxxxxxxxxxx'], + 'exporterCount' => ['title' => '插件数量。', 'description' => '插件数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'haveConfig' => ['title' => '是否有配置。', 'description' => '是否有配置。', 'type' => 'boolean', 'example' => 'true'], + 'installUserId' => ['title' => '接入用户 ID。', 'description' => '接入用户 ID。', 'type' => 'string', 'example' => '175xxxxxxxxx'], + 'language' => ['title' => '语言。', 'description' => '语言。', 'type' => 'string', 'example' => 'zh'], + 'managed' => ['title' => '是否为托管组件。', 'description' => '是否为托管组件。', 'type' => 'boolean', 'example' => 'true'], + 'parentAddonReleaseId' => ['title' => '父级 AddonReleaseId。', 'description' => '父级 AddonReleaseId。', 'type' => 'string', 'example' => 'policy-xxxxxxxxxxxxxx'], + 'policyId' => ['title' => '策略 ID。', 'description' => '策略 ID。', 'type' => 'string', 'example' => 'policy-xxxxxxxxxxxxxx'], + 'regionId' => ['title' => '区域 ID。', 'description' => '区域 ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'releaseId' => ['title' => 'Release ID。', 'description' => 'Release ID。', 'type' => 'string', 'example' => '7339d808-66f9-4d40-83fa-xxxxxxxxxxx'], + 'releaseName' => ['title' => 'Release 名称。', 'description' => 'Release 名称。', 'type' => 'string', 'example' => 'test-gpu-integration-name'], + 'scene' => ['title' => '组件场景。', 'description' => '组件场景。', 'type' => 'string', 'example' => 'container'], + 'status' => ['title' => '状态。', 'description' => '状态。', 'type' => 'string', 'example' => 'running'], + 'updateTime' => ['title' => '更新时间。', 'description' => '更新时间。', 'type' => 'string', 'example' => '2024-11-04T16:10:23+08:00'], + 'userId' => ['title' => '所属用户 ID。', 'description' => '所属用户 ID。', 'type' => 'string', 'example' => '175xxxxxxxxxxxxx'], + 'version' => ['title' => '组件版本。', 'description' => '组件版本。', 'type' => 'string', 'example' => '0.0.2'], + 'envType' => ['title' => '环境类型。', 'description' => '环境类型。', 'type' => 'string', 'example' => 'CS'], + 'workspace' => ['title' => '工作空间。', 'description' => '工作空间。', 'type' => 'string', 'example' => 'default'], + 'subAddonRelease' => [ + 'title' => '子AddonRelease的统计信息', + 'description' => '子AddonRelease的统计信息。', 'type' => 'object', 'properties' => [ - 'key' => [ - 'title' => '标签key', - 'description' => '标签key', - 'type' => 'string', - 'example' => 'env', - ], - 'value' => [ - 'title' => '标签value', - 'description' => '标签value', - 'type' => 'string', - 'example' => 'prod', - ], + 'ready' => ['title' => '已就绪的子Release数量', 'description' => '已就绪的子Release数量', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'total' => ['title' => '子Release数量', 'description' => '子Release数量', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], ], ], + 'nextVersion' => ['description' => '剩余列表起始版本号。', 'type' => 'string', 'example' => 'None'], + 'entityRules' => ['title' => '实体详情。', 'description' => '实体详情。', '$ref' => '#/components/schemas/EntityGroupBase'], + 'apiVersion' => ['description' => '版本号', 'type' => 'string', 'example' => '2023-03-30'], ], ], ], + 'requestId' => ['title' => '请求 ID。', 'description' => '请求 ID。', 'type' => 'string', 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5'], + 'total' => ['title' => '组件数量。', 'description' => '组件数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'nextToken' => ['type' => 'string'], ], ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidService.NotFound', - 'errorMessage' => 'The specified Service does not exist.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查看接入组件列表', + 'summary' => 'addon的release列表', + 'description' => '查询接入配置列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAddonReleases'], ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:ListAddonReleases', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'AddonRelease', 'arn' => 'acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#PolicyId}/addonrelease/*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-BE6E-5F82-A484-CE9C2196C7DC\\",\\n \\"service\\": {\\n \\"serviceId\\": \\"cwzxvuc6uo@4bc6b15ad81f166174ffb\\\\n\\",\\n \\"serviceName\\": \\"demo-app\\",\\n \\"createTime\\": \\"2025-05-13T03:32:55Z\\",\\n \\"serviceType\\": \\"TRACE\\",\\n \\"serviceStatus\\": \\"Running\\",\\n \\"displayName\\": \\"demo应用\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"workspace\\": \\"default-cms-1106439496876715-cn-hangzhou\\",\\n \\"pid\\": \\"by6rjzro2j@0fe8dfa799e5906\\",\\n \\"description\\": \\"test\\",\\n \\"attributes\\": \\"{\\\\\\"language\\\\\\":\\\\\\"java\\\\\\"}\\",\\n \\"resourceGroupId\\": \\"rg-aekxxzuad5zzzz\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"env\\",\\n \\"value\\": \\"prod\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '查询应用可观测服务', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"releases\\": [\\n {\\n \\"addonName\\": \\"cs-gpu\\",\\n \\"alertRuleCount\\": 6,\\n \\"conditions\\": [\\n {\\n \\"firstTransitionTime\\": \\"2024-11-04T16:10:22+08:00\\",\\n \\"lastTransitionTime\\": \\"2024-11-04T16:10:22+08:00\\",\\n \\"message\\": \\"The addon loaded successfully\\",\\n \\"status\\": \\"True\\",\\n \\"type\\": \\"Loaded\\"\\n }\\n ],\\n \\"config\\": \\"{\\\\\\"install\\\\\\":{\\\\\\"mode\\\\\\":\\\\\\"auto-install\\\\\\",\\\\\\"listenPort\\\\\\":\\\\\\"9400\\\\\\"},\\\\\\"discoverMode\\\\\\":\\\\\\"instances\\\\\\",\\\\\\"discover\\\\\\":{\\\\\\"instances\\\\\\":\\\\\\"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44\\\\\\"},\\\\\\"scrapeInterval\\\\\\":\\\\\\"15\\\\\\",\\\\\\"enableSecuritecs-nodeyGroupInjection\\\\\\":\\\\\\"true\\\\\\",\\\\\\"metricTags\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"createTime\\": \\"2024-11-04T16:10:12+08:00\\",\\n \\"dashboardCount\\": 3,\\n \\"environmentId\\": \\"policy-xxxxxxxxxxxx\\",\\n \\"exporterCount\\": 2,\\n \\"haveConfig\\": true,\\n \\"installUserId\\": \\"175xxxxxxxxx\\",\\n \\"language\\": \\"zh\\",\\n \\"managed\\": true,\\n \\"parentAddonReleaseId\\": \\"policy-xxxxxxxxxxxxxx\\",\\n \\"policyId\\": \\"policy-xxxxxxxxxxxxxx\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"releaseId\\": \\"7339d808-66f9-4d40-83fa-xxxxxxxxxxx\\",\\n \\"releaseName\\": \\"test-gpu-integration-name\\",\\n \\"scene\\": \\"container\\",\\n \\"status\\": \\"running\\",\\n \\"updateTime\\": \\"2024-11-04T16:10:23+08:00\\",\\n \\"userId\\": \\"175xxxxxxxxxxxxx\\",\\n \\"version\\": \\"0.0.2\\",\\n \\"envType\\": \\"CS\\",\\n \\"workspace\\": \\"default\\",\\n \\"subAddonRelease\\": {\\n \\"ready\\": 2,\\n \\"total\\": 3\\n },\\n \\"nextVersion\\": \\"None\\",\\n \\"entityRules\\": {\\n \\"workspace\\": \\"default-cms-1654218***343050-cn-hangzhou\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"entityQueries\\": [\\n {\\n \\"entityType\\": \\"acs.ecs.instance\\",\\n \\"spl\\": \\".entity with(type=\'acs.ecs.instance\') | where region_id in (\'cn-beijing\')\\"\\n }\\n ],\\n \\"description\\": \\"ECS 实例\\",\\n \\"entityGroupId\\": \\"eg-1234567890\\",\\n \\"entityRules\\": {\\n \\"resourceGroupId\\": \\"rg-acfm2m7atreujs1\\",\\n \\"ipMatchRule\\": {\\n \\"ipFieldKey\\": \\"\\",\\n \\"ipCIDR\\": \\"\\"\\n },\\n \\"tags\\": [\\n {\\n \\"tagKey\\": \\"project\\",\\n \\"op\\": \\"in\\",\\n \\"tagValues\\": [\\n \\"demo\\"\\n ]\\n }\\n ],\\n \\"instanceIds\\": [\\n \\"i-bp1gj8wyq4fxk28k6iy2\\"\\n ],\\n \\"entityTypes\\": [\\n \\"acs.ecs.instance\\"\\n ],\\n \\"regionIds\\": [\\n \\"cn-shanghai\\"\\n ],\\n \\"labels\\": [\\n {\\n \\"tagKey\\": \\"project\\",\\n \\"op\\": \\"in\\",\\n \\"tagValues\\": [\\n \\"demo\\"\\n ]\\n }\\n ],\\n \\"annotations\\": [\\n {\\n \\"tagKey\\": \\"instanceId\\",\\n \\"op\\": \\"in\\",\\n \\"tagValues\\": [\\n \\"i-bp1gj8wyq4fxk28k6iy2\\\\n\\"\\n ]\\n }\\n ],\\n \\"fieldRules\\": [\\n {\\n \\"fieldKey\\": \\"instanceId\\",\\n \\"op\\": \\"in\\",\\n \\"fieldValues\\": [\\n \\"i-bp1gj8wyq4fxk28k6iy2\\"\\n ]\\n }\\n ]\\n },\\n \\"entityGroupName\\": \\"ECS 全部实体\\",\\n \\"userId\\": \\"1654218***343050\\"\\n },\\n \\"apiVersion\\": \\"2023-03-30\\"\\n }\\n ],\\n \\"requestId\\": \\"CD8BA7D6-995D-578D-9941-78B0FECD14B5\\",\\n \\"total\\": 1,\\n \\"nextToken\\": \\"\\"\\n}","type":"json"}]', ], - 'CreateService' => [ - 'summary' => '创建应用可观测服务', - 'path' => '/workspace/{workspace}/service', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListAddons' => [ + 'summary' => '新版接入中心产品列表(分组)。', + 'path' => '/addons', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'aliyunLang', + 'in' => 'query', + 'schema' => ['title' => '语言环境：zh / en'."\n" + .'默认为中文 zh', 'description' => '语言环境：zh / en'."\n" + .'默认为中文 zh', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + [ + 'name' => 'category', + 'in' => 'query', + 'schema' => ['title' => '标签筛选', 'description' => '标签筛选', 'type' => 'string', 'required' => false, 'example' => 'database'], + ], + [ + 'name' => 'search', + 'in' => 'query', + 'schema' => ['title' => 'addon名称', 'description' => '支持 Addon 名称、描述、关键词查询', 'type' => 'string', 'required' => false, 'example' => '105095'], + ], + [ + 'name' => 'regexp', + 'in' => 'query', + 'schema' => ['title' => '查询字段, 是否正则匹配, 默认为false'."\n", 'description' => '查询字段, 是否正则匹配, 默认为false'."\n", 'type' => 'boolean', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '请求体', 'type' => 'object', 'properties' => [ - 'serviceName' => [ - 'title' => '应用资源名称', - 'description' => '服务名称', - 'type' => 'string', - 'required' => true, - 'example' => 'mag_test', - ], - 'serviceType' => [ - 'title' => '类型：TRACE（应用监控）/ RUM（用户体验监控）/ XTRACE（OT版）', - 'description' => '服务类型', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'TRACE' => '应用性能监控', - 'RUM' => '用户体验监控', - 'XTRACE' => 'OpenTelemtry链路追踪', - ], - 'example' => 'TRACE', - ], - 'displayName' => [ - 'title' => '别名', - 'description' => '显示名称，仅当serviceType=RUM时有效。', - 'type' => 'string', - 'required' => false, - 'example' => 'mag测试应用', - ], - 'description' => [ - 'title' => '应用描述信息。', - 'description' => '服务描述，仅当serviceType=RUM时有效。', - 'type' => 'string', - 'required' => false, - 'example' => 'mag测试应用', - ], - 'attributes' => [ - 'title' => '特征信息，key:value格式', - 'description' => '扩展属性。', - 'type' => 'string', - 'required' => false, - 'example' => '{"language":"java"}', - ], - 'serviceStatus' => [ - 'title' => '应用体验监控的服务状态，Running/Stopped/Created/Suspend', - 'description' => '服务状态，创建服务无需指定。', - 'type' => 'string', - 'required' => false, - 'example' => 'Created', - ], - 'pid' => [ - 'title' => '对应ARMS应用pid', - 'description' => '应用ID，一般无需指定', - 'type' => 'string', - 'required' => false, - 'example' => 'bx3udsi5ie@ed2ba6beebdb6de', - ], - 'resourceGroupId' => [ - 'title' => '资源组id', - 'description' => '资源组id', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-xxxxxxx', - ], - 'tags' => [ - 'title' => '标签数组', - 'description' => '标签数组。', + 'addons' => [ + 'description' => '可用接入组件列表。', 'type' => 'array', 'items' => [ - 'title' => '标签', - 'description' => '标签。', + 'description' => '接入组件详情。', 'type' => 'object', 'properties' => [ - 'key' => [ - 'title' => '标签key', - 'description' => '标签`key`值。', - 'type' => 'string', - 'required' => false, - 'example' => 'env', + 'alias' => ['description' => '接入组件别名。', 'type' => 'string', 'example' => 'resume_vector_alias'], + 'categories' => [ + 'description' => '接入组件标签列表。', + 'type' => 'array', + 'items' => ['description' => '标签。', 'type' => 'string', 'example' => 'middleware'], ], - 'value' => [ - 'title' => '标签value', - 'description' => '标签`value`值。', - 'type' => 'string', - 'required' => false, - 'example' => 'prod', + 'dashboards' => [ + 'description' => '仪表盘的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '仪表盘信息。', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => '仪表盘描述。', 'type' => 'string', 'example' => 'test'], + 'name' => ['description' => '仪表盘名称。', 'type' => 'string', 'example' => 'rum_view_link_rum_api'], + 'url' => ['description' => '仪表盘效果图地址。', 'type' => 'string', 'example' => 'http://xxxxxxx'], + ], + ], ], + 'description' => ['description' => '描述', 'type' => 'string', 'example' => 'workspace api monitor test'], + 'environments' => [ + 'description' => '支持的接入策略类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '接入策略类型信息', + 'type' => 'object', + 'properties' => [ + 'dependencies' => [ + 'description' => '接入组件的依赖列表。', + 'type' => 'object', + 'properties' => [ + 'clusterTypes' => [ + 'description' => '支持的集群类型。', + 'type' => 'array', + 'items' => ['description' => '集群类型。', 'type' => 'string', 'example' => 'ManagedKubernetes/Default'], + ], + 'features' => [ + 'description' => '接入依赖的探针。', + 'type' => 'object', + 'additionalProperties' => ['type' => 'boolean', 'description' => '是否支持。', 'example' => 'true'], + ], + 'services' => [ + 'description' => '依赖的服务列表', + 'type' => 'array', + 'items' => ['description' => '服务名称', 'type' => 'string', 'example' => 'Prometheus'], + ], + ], + ], + 'description' => ['description' => '接入策略类型描述信息', 'type' => 'string', 'example' => 'o11y-demo-cn-heyuan'], + 'enable' => ['description' => '是否启用', 'type' => 'boolean', 'example' => 'false'], + 'label' => ['description' => '接入策略类型标签。', 'type' => 'string', 'example' => '容器环境'], + 'name' => ['description' => '接入策略类型名称。', 'type' => 'string', 'example' => 'CS'], + 'policies' => [ + 'description' => '接入策略配置。', + 'type' => 'object', + 'properties' => [ + 'alertDefaultStatus' => ['description' => '告警规则默认策略的启用状态。', 'type' => 'string', 'example' => 'RUNNING'], + 'defaultInstall' => ['description' => '是否默认安装', 'type' => 'boolean', 'example' => 'true'."\n"], + 'enableServiceAccount' => ['description' => '是否分配 Service Account 用以与 Console API 通信。', 'type' => 'boolean', 'example' => 'true'], + 'metricCheckRule' => [ + 'description' => '指标检测规则。', + 'type' => 'object', + 'properties' => [ + 'promQL' => [ + 'description' => 'PromQL 查询语句列表。', + 'type' => 'array', + 'items' => ['description' => 'PromQL 查询语句。', 'type' => 'string', 'example' => 'scraper_up{scraper=\\"ecs\\"}==1'], + ], + ], + ], + 'needRestartAfterIntegration' => ['description' => '是否在插件接入时完成安装后即进入 Pod 重启引导。', 'type' => 'boolean', 'example' => 'true'], + 'protocols' => [ + 'description' => '配置支持的协议类型。', + 'type' => 'array', + 'items' => [ + 'description' => '配置支持的协议类型详情。', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => '协议描述。', 'type' => 'string', 'example' => 'Support OpenTelemetry Protocal'], + 'icon' => ['description' => '图标URL。', 'type' => 'string', 'example' => 'http://xxxxxxx'], + 'label' => ['description' => '协议展示名称。', 'type' => 'string', 'example' => 'OpenTelemetry'], + 'name' => ['description' => '协议名称。', 'type' => 'string', 'example' => 'openTelemetry'], + ], + ], + ], + 'targetAddonName' => ['description' => '目标Addon名称。', 'type' => 'string', 'example' => 'cloud-acs-ecs'], + ], + ], + 'policyType' => ['description' => '接入中心策略类型', 'type' => 'string', 'example' => 'CS'], + 'commonSchemaRefs' => [ + 'description' => '关联的Common Schema列表', + 'type' => 'array', + 'items' => [ + 'description' => '关联的Common Schema信息', + 'type' => 'object', + 'properties' => [ + 'group' => ['description' => 'Common Schema 的分组名称', 'type' => 'string', 'example' => 'acs-ecs'], + 'version' => ['description' => 'Common Schema的版本', 'type' => 'string', 'example' => '0.1.4'], + ], + ], + ], + ], + ], + ], + 'icon' => ['description' => '图标URL地址', 'type' => 'string', 'example' => 'http://xxxxxxx'], + 'keywords' => [ + 'description' => '关键词列表', + 'type' => 'array', + 'items' => ['description' => '关键词', 'type' => 'string', 'example' => 'Container'], + ], + 'language' => ['description' => '语言。', 'type' => 'string', 'example' => 'zh'], + 'latestReleaseCreateTime' => ['description' => '最新一次创建时间。', 'type' => 'string', 'example' => '2025-09-03T03:15:56Z'], + 'name' => ['description' => '接入组件名称。', 'type' => 'string', 'example' => 'rum_api_dashboard_explorer_link_metric_set'], + 'once' => ['description' => '是否只能安装一次。', 'type' => 'boolean', 'example' => 'true'], + 'scene' => ['description' => '组件场景。', 'type' => 'string', 'example' => 'middleware'], + 'version' => ['description' => '组件版本。', 'type' => 'string', 'example' => '*'], + 'weight' => ['description' => '接入组件展示权重。', 'type' => 'string', 'example' => '99'], ], - 'required' => false, ], - 'required' => false, ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], - 'required' => false, + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询接入组件列表', + 'description' => '用于创建一个站点监控任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"addons\\": [\\n {\\n \\"alias\\": \\"resume_vector_alias\\",\\n \\"categories\\": [\\n \\"middleware\\"\\n ],\\n \\"dashboards\\": [\\n {\\n \\"description\\": \\"test\\",\\n \\"name\\": \\"rum_view_link_rum_api\\",\\n \\"url\\": \\"http://xxxxxxx\\"\\n }\\n ],\\n \\"description\\": \\"workspace api monitor test\\",\\n \\"environments\\": [\\n {\\n \\"dependencies\\": {\\n \\"clusterTypes\\": [\\n \\"ManagedKubernetes/Default\\"\\n ],\\n \\"features\\": {\\n \\"key\\": true\\n },\\n \\"services\\": [\\n \\"Prometheus\\"\\n ]\\n },\\n \\"description\\": \\"o11y-demo-cn-heyuan\\",\\n \\"enable\\": false,\\n \\"label\\": \\"容器环境\\",\\n \\"name\\": \\"CS\\",\\n \\"policies\\": {\\n \\"alertDefaultStatus\\": \\"RUNNING\\",\\n \\"defaultInstall\\": true,\\n \\"enableServiceAccount\\": true,\\n \\"metricCheckRule\\": {\\n \\"promQL\\": [\\n \\"scraper_up{scraper=\\\\\\\\\\\\\\"ecs\\\\\\\\\\\\\\"}==1\\"\\n ]\\n },\\n \\"needRestartAfterIntegration\\": true,\\n \\"protocols\\": [\\n {\\n \\"description\\": \\"Support OpenTelemetry Protocal\\",\\n \\"icon\\": \\"http://xxxxxxx\\",\\n \\"label\\": \\"OpenTelemetry\\",\\n \\"name\\": \\"openTelemetry\\"\\n }\\n ],\\n \\"targetAddonName\\": \\"cloud-acs-ecs\\"\\n },\\n \\"policyType\\": \\"CS\\",\\n \\"commonSchemaRefs\\": [\\n {\\n \\"group\\": \\"acs-ecs\\",\\n \\"version\\": \\"0.1.4\\"\\n }\\n ]\\n }\\n ],\\n \\"icon\\": \\"http://xxxxxxx\\",\\n \\"keywords\\": [\\n \\"Container\\"\\n ],\\n \\"language\\": \\"zh\\",\\n \\"latestReleaseCreateTime\\": \\"2025-09-03T03:15:56Z\\",\\n \\"name\\": \\"rum_api_dashboard_explorer_link_metric_set\\",\\n \\"once\\": true,\\n \\"scene\\": \\"middleware\\",\\n \\"version\\": \\"*\\",\\n \\"weight\\": \\"99\\"\\n }\\n ],\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + ], + 'ListAggTaskGroups' => [ + 'summary' => '查询聚合任务组列表。', + 'path' => '/prometheus-instances/{instanceId}/agg-task-groups', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'workspace', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'instanceId', 'in' => 'path', + 'schema' => ['title' => '聚合任务组所属的 Prometheus 实例的 id，聚合任务从这个实例中读取数据', 'description' => '聚合任务组所属的 Prometheus 实例ID，聚合任务从这个实例中读取数据。', 'type' => 'string', 'required' => true, 'example' => 'rw-pq4apob9jm'], + ], + [ + 'name' => 'filterAggTaskGroupIds', + 'in' => 'query', + 'schema' => ['title' => '聚合任务组的 id 列表，需要能被 JSON 解析', 'description' => '聚合任务组的 id 列表，需要能被 JSON 解析。', 'type' => 'string', 'required' => false, 'example' => '["aggTaskGroup-xxx"]'], + ], + [ + 'name' => 'filterAggTaskGroupNames', + 'in' => 'query', + 'schema' => ['title' => '聚合任务组名称列表，需要能被 JSON 解析', 'description' => '聚合任务组名称列表，需要能被 JSON 解析。', 'type' => 'string', 'required' => false, 'example' => '["apiserver_request_total"]'], + ], + [ + 'name' => 'status', + 'in' => 'query', 'schema' => [ - 'title' => '工作空间', - 'description' => '工作空间名称', + 'title' => '聚合任务组状态，“Running” 或者 “Stopped”。默认 Running', + 'description' => '聚合任务组状态，“Running” 或者 “Stopped”。默认 Running。', 'type' => 'string', - 'required' => true, - 'example' => 'default-cms-1793369865235921-cn-shenzhen', + 'required' => false, + 'enumValueTitles' => ['Stopped' => '已禁用', 'Running' => '已启动'], + 'example' => 'Running', + 'enum' => ['Running', 'Stopped'], ], ], + [ + 'name' => 'targetPrometheusId', + 'in' => 'query', + 'schema' => ['title' => '聚合任务组的目标 Prometheus 实例 id', 'description' => '聚合任务组的目标 Prometheus 实例ID。', 'type' => 'string', 'required' => false, 'example' => 'rw-pq4apob9jm'], + ], + [ + 'name' => 'tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '资源组标签'."\n" + ."\n", + 'description' => '资源组标签。', + 'type' => 'array', + 'items' => [ + 'description' => '资源组标签。', + 'type' => 'object', + 'properties' => [ + 'key' => ['title' => '资源组标签的键'."\n" + ."\n", 'description' => '资源组标签的键。', 'type' => 'string', 'required' => false, 'example' => 'key1'], + 'value' => ['title' => '资源组标签的值'."\n" + ."\n", 'description' => '资源组标签的值。', 'type' => 'string', 'required' => false, 'example' => 'value1'], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['title' => '返回的最多记录数', 'description' => '返回的最多记录数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '20', 'default' => '20'], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['title' => '查询令牌', 'description' => '查询令牌。', 'type' => 'string', 'required' => false, 'example' => '28036394xxx', 'maxLength' => 128], + ], + [ + 'name' => 'query', + 'in' => 'query', + 'schema' => ['title' => '名称搜索，支持模糊匹配', 'description' => '名称搜索。支持模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '出参结构体', + 'description' => '出参结构体。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求id', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '3A2FA9E9-9CF1-5CB1-A808-52828F14310D', - ], - 'serviceId' => [ - 'title' => '应用服务id', - 'description' => '服务ID', - 'type' => 'string', - 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', - ], - 'pid' => [ - 'title' => '对应ARMS应用pid', - 'description' => '兼容历史的ARMS应用ID', - 'type' => 'string', - 'example' => 'cwzxvuc6uo@d60088ad4797d26', + 'aggTaskGroups' => [ + 'title' => '聚合任务组列表', + 'description' => '聚合任务组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '聚合任务。', + 'type' => 'object', + 'properties' => [ + 'aggTaskGroupConfigHash' => ['title' => '聚合任务组配置的摘要'."\n" + ."\n", 'description' => '聚合任务组配置的摘要。', 'type' => 'string', 'example' => 'a54136014xxx'], + 'aggTaskGroupId' => ['title' => '聚合任务组 id'."\n" + ."\n", 'description' => '聚合任务组ID。', 'type' => 'string', 'example' => 'aggTaskGroup-xxxx'], + 'aggTaskGroupName' => ['title' => '聚合任务组名称'."\n" + ."\n", 'description' => '聚合任务组名称。', 'type' => 'string', 'example' => 'pipeline-aggtask-group'], + 'cronExpr' => ['title' => '调度模式选择“Cron”情况下，聚合任务组的调度表达式', 'description' => '调度模式选择“Cron”情况下，聚合任务组的调度表达式。', 'type' => 'string', 'example' => '0 10 8 1 * ? *'], + 'delay' => ['title' => '调度的固定延迟时间'."\n" + ."\n", 'description' => '调度的固定延迟时间（秒）。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'description' => ['title' => '聚合任务组描述'."\n" + ."\n", 'description' => '聚合任务组描述。', 'type' => 'string', 'example' => 'workspace api monitor update test'], + 'fromTime' => ['title' => '调度开始时间对应的的秒级时间戳', 'description' => '调度开始时间对应的的秒级时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1757409499000'], + 'interval' => ['title' => '调度间隔', 'description' => '调度间隔。', 'type' => 'string', 'example' => '2025-04-24 00:00:00,2025-04-24 00:00:00'], + 'maxRetries' => ['title' => '执行聚合任务的最大重试次数'."\n" + ."\n", 'description' => '执行聚合任务的最大重试次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'maxRunTimeInSeconds' => ['title' => '执行聚合任务的最大重试时间'."\n" + ."\n", 'description' => '执行聚合任务的最大重试时间（秒）。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'regionId' => ['title' => '地域 id'."\n" + ."\n", 'description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'scheduleMode' => ['title' => '调度模式'."\n" + ."\n", 'description' => '调度模式。', 'type' => 'string', 'example' => 'FixedRate'], + 'scheduleTimeExpr' => ['title' => '调度时间表达式'."\n" + ."\n", 'description' => '调度时间表达式。', 'type' => 'string', 'example' => '@m'], + 'sourcePrometheusId' => ['title' => '聚合任务组的源 Prometheus 实例 id', 'description' => '聚合任务组的源 Prometheus 实例ID。', 'type' => 'string', 'example' => 'rw-xxx'], + 'status' => ['title' => '聚合任务组状态'."\n" + ."\n", 'description' => '聚合任务组状态。', 'type' => 'string', 'example' => 'Running'], + 'targetPrometheusId' => ['title' => '聚合任务组的目标 Prometheus 实例 id', 'description' => '聚合任务组的目标 Prometheus 实例ID。', 'type' => 'string', 'example' => 'rw-xxx'], + 'toTime' => ['title' => '调度结束时间对应的秒级时间戳'."\n" + ."\n", 'description' => '调度结束时间对应的秒级时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'updateTime' => ['title' => '聚合任务组的更新时间'."\n" + ."\n", 'description' => '聚合任务组的更新时间（Unix时间戳）。', 'type' => 'string', 'example' => '1757409499000'], + ], + ], ], + 'maxResults' => ['title' => '返回的最多记录数', 'description' => '返回的最多记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'default' => '0'], + 'nextToken' => ['title' => '下一次查询的令牌', 'description' => '下一次查询的令牌。', 'type' => 'string', 'example' => 'aa9d0e569b880xxx', 'maxLength' => 128], + 'requestId' => ['title' => '请求 id'."\n" + ."\n", 'description' => '请求ID。', 'type' => 'string', 'example' => '7BF1F4D6-B9A8-5F0B-8C1D-4347FFCB798E'], + 'totalCount' => ['title' => '总实例数', 'description' => '总实例数。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3A2FA9E9-9CF1-5CB1-A808-52828F14310D\\",\\n \\"serviceId\\": \\"cwzxvuc6uo@4bc6b15ad81f166174ffb\\",\\n \\"pid\\": \\"cwzxvuc6uo@d60088ad4797d26\\"\\n}","type":"json"}]', - 'title' => '创建应用可观测服务', - 'requestParamsDescription' => '扩展属性attributes，'."\n" - .'serviceType=TRACE时，可选属性language，可选值java/python/golang；'."\n" - .'serviceType=XTRACE时，可选属性language，可选值参考开源值https://opentelemetry.io/docs/specs/semconv/registry/attributes/telemetry/。', - ], - 'ListServices' => [ - 'summary' => '批量查询应用可观测服务', - 'path' => '/workspace/{workspace}/services', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"aggTaskGroups\\": [\\n {\\n \\"aggTaskGroupConfigHash\\": \\"a54136014xxx\\",\\n \\"aggTaskGroupId\\": \\"aggTaskGroup-xxxx\\",\\n \\"aggTaskGroupName\\": \\"pipeline-aggtask-group\\",\\n \\"cronExpr\\": \\"0 10 8 1 * ? *\\",\\n \\"delay\\": 30,\\n \\"description\\": \\"workspace api monitor update test\\",\\n \\"fromTime\\": 1757409499000,\\n \\"interval\\": \\"2025-04-24 00:00:00,2025-04-24 00:00:00\\",\\n \\"maxRetries\\": 2,\\n \\"maxRunTimeInSeconds\\": 200,\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"scheduleMode\\": \\"FixedRate\\",\\n \\"scheduleTimeExpr\\": \\"@m\\",\\n \\"sourcePrometheusId\\": \\"rw-xxx\\",\\n \\"status\\": \\"Running\\",\\n \\"targetPrometheusId\\": \\"rw-xxx\\",\\n \\"toTime\\": 0,\\n \\"updateTime\\": \\"1757409499000\\"\\n }\\n ],\\n \\"maxResults\\": 100,\\n \\"nextToken\\": \\"aa9d0e569b880xxx\\",\\n \\"requestId\\": \\"7BF1F4D6-B9A8-5F0B-8C1D-4347FFCB798E\\",\\n \\"totalCount\\": 5\\n}","type":"json"}]', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], - 'schemes' => [ - 'https', + 'title' => '查询聚合任务组列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAggTaskGroups'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + ], + 'ListAlertActions' => [ + 'summary' => '查询告警行动集成', + 'path' => '/alertActions', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'high', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'nextToken', - 'in' => 'query', - 'schema' => [ - 'title' => '翻页的 token，从 NextToken 开始按字典序返回文件信息列表。第一次调用此接口时，设置为空。', - 'description' => '下一次查询的token，为空表示最后一页', - 'type' => 'string', - 'required' => false, - 'example' => '7-b81a-4bc9-bbfa-a50cc6988667', - ], - ], - [ - 'name' => 'maxResults', + 'name' => 'alertActionIds', 'in' => 'query', - 'allowEmptyValue' => false, + 'style' => 'json', 'schema' => [ - 'title' => '查询一页数量，最大500。', - 'description' => 'MaxResults本次请求所返回的最大记录条数', - 'type' => 'integer', - 'format' => 'int32', + 'description' => '行动集成唯一标识。', + 'type' => 'array', + 'items' => ['description' => '行动集成唯一标识。', 'type' => 'string', 'required' => false, 'example' => 'testId'], 'required' => false, - 'maximum' => '500', - 'minimum' => '0', - 'exclusiveMinimum' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'workspace', - 'in' => 'path', - 'schema' => [ - 'title' => '工作空间', - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', ], ], [ - 'name' => 'serviceType', + 'name' => 'type', 'in' => 'query', 'schema' => [ - 'title' => '类型：TRACE（应用监控）/ RUM（用户体验监控）/ XTRACE（OT版）', - 'description' => '服务类型', + 'description' => '行动集成类型。', 'type' => 'string', 'required' => false, - 'example' => 'apm', - 'enum' => [ - 'TRACE', - 'XTRACE', - 'RUM', - ], + 'example' => 'FC', + 'enum' => ['FC', 'MNS', 'OPEN_API', 'SLS', 'ESS', 'PAGER_DUTY', 'WEBHOOK', 'EB', 'FC3'], ], ], [ - 'name' => 'serviceName', + 'name' => 'alertActionName', 'in' => 'query', - 'schema' => [ - 'title' => '应用服务名称', - 'description' => '应用服务名称', - 'type' => 'string', - 'required' => false, - 'example' => 'app-demo', - ], + 'schema' => ['description' => '行动集成名称。', 'type' => 'string', 'required' => false, 'example' => 'testName'], ], [ - 'name' => 'resourceGroupId', + 'name' => 'pageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '资源组id', - 'description' => '资源组id', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aekxxzuad5zzzz', - ], + 'schema' => ['description' => '页面。默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'tags', + 'name' => 'pageSize', 'in' => 'query', - 'allowEmptyValue' => true, - 'style' => 'json', - 'schema' => [ - 'title' => '标签数组', - 'description' => '标签数组', - 'type' => 'array', - 'items' => [ - 'title' => '标签', - 'description' => '标签', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'title' => '标签key', - 'description' => '标签key', - 'type' => 'string', - 'required' => false, - 'example' => 'evn', - ], - 'value' => [ - 'title' => '标签value', - 'description' => '标签value', - 'type' => 'string', - 'required' => false, - 'example' => 'prod', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['description' => '每页大小。默认100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], ], ], 'responses' => [ @@ -14423,327 +12619,342 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求 ID。', - 'description' => '请求 ID', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', - ], - 'nextToken' => [ - 'title' => '分页标识。返回值 nextToken 非空代表还有剩余数据。把 nextToken 作为参数继续查询会获得下一页。', - 'description' => '分页Token', - 'type' => 'string', - 'example' => '2-ba4d-4b9f-aa24-dcb067a30f1c', - ], - 'totalCount' => [ - 'title' => '总应用服务数量', - 'description' => '总条数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '66', - ], - 'maxResults' => [ - 'title' => '查询一页数量。', - 'description' => '最大返回结果数，最大值200', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'services' => [ - 'title' => '应用服务列表', - 'description' => '服务信息列表', + 'requestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'total' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '9'], + 'pageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'pageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'alertActions' => [ + 'description' => '行动集成配置列表。', 'type' => 'array', 'items' => [ - 'title' => '应用服务', - 'description' => '服务信息', + 'description' => '行动集成配置列表。', 'type' => 'object', 'properties' => [ - 'serviceId' => [ - 'title' => '应用服务id', - 'description' => '服务ID', - 'type' => 'string', - 'example' => 'jm2pl0yoqf@d4905cb11a4f218dfb0a8', - ], - 'serviceName' => [ - 'title' => '应用资源名称', - 'description' => '服务名称', - 'type' => 'string', - 'example' => 'demo-app', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2025-07-01T02:23:59Z', - ], - 'serviceType' => [ - 'title' => '类型：TRACE（应用监控）/ RUM（用户体验监控）/ XTRACE（OT版）', - 'description' => '服务类型', - 'type' => 'string', - 'example' => 'TRACE', + 'alertActionId' => ['description' => '行动集成唯一标识。', 'type' => 'string', 'example' => 'test'], + 'mnsParam' => [ + 'description' => '轻量消息队列（原 MNS）参数。', + 'type' => 'object', + 'properties' => [ + 'mnsType' => ['description' => '轻量消息队列（原 MNS）资源类型。', 'type' => 'string', 'example' => 'queue'], + 'name' => ['description' => '资源名称。'."\n" + ."\n" + .'- 如果资源类型为 queue，则资源名称为队列名称。'."\n" + .'- 如果资源类型为 topic，则资源名称为主题名称。', 'type' => 'string', 'example' => 'test'], + 'regionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + ], ], - 'serviceStatus' => [ - 'title' => '应用体验监控的服务状态，running/stopped/created/suspend', - 'description' => '服务状态，仅当serviceType=RUM时有效。', - 'type' => 'string', - 'example' => 'Running', + 'type' => ['description' => '行动集成类型。', 'type' => 'string', 'example' => 'FC'], + 'slsParam' => [ + 'description' => '日志服务参数。', + 'type' => 'object', + 'properties' => [ + 'logstore' => ['description' => '日志服务Logstore名称。', 'type' => 'string', 'example' => 'test'], + 'project' => ['description' => '日志服务Project名称。', 'type' => 'string', 'example' => 'test'], + 'regionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + ], ], - 'displayName' => [ - 'title' => '别名', - 'description' => '显示名称，仅当serviceType=RUM时有效。', - 'type' => 'string', - 'example' => 'test', + 'alertActionName' => ['description' => '行动集成名称。', 'type' => 'string', 'example' => 'testName'], + 'essParam' => [ + 'description' => '弹性伸缩参数。', + 'type' => 'object', + 'properties' => [ + 'essGroupId' => ['description' => '弹性伸缩组id', 'type' => 'string', 'example' => 'testId'], + 'essRuleId' => ['description' => '弹性伸缩规则id。', 'type' => 'string', 'example' => 'testId'], + 'regionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-beijing'], + ], ], - 'pid' => [ - 'title' => '对应ARMS应用pid', - 'description' => '兼容历史的ARMS应用ID', - 'type' => 'string', - 'example' => 'kgcsf@192197e828d51aa', + 'fcParam' => [ + 'description' => '函数计算参数。', + 'type' => 'object', + 'properties' => [ + 'function' => ['description' => '函数计算服务的函数名称。', 'type' => 'string', 'example' => 'test'], + 'regionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-beijing'], + 'service' => ['description' => '函数计算的服务名称。', 'type' => 'string', 'example' => 'test'], + ], ], - 'description' => [ - 'title' => '应用描述信息。', - 'description' => '服务描述，仅当serviceType=RUM时有效。', - 'type' => 'string', - 'example' => 'workspace api monitor test', + 'pagerDutyParam' => [ + 'description' => 'pageDuty参数', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'pagerDuty的集成key。', 'type' => 'string', 'example' => 'fsfer4543t5t65g4t4'], + 'url' => ['description' => 'pagerDuty的集成webhook。支持V1和V2版', 'type' => 'string', 'example' => 'https://events.pagerduty.com/v2/enqueue'], + ], ], - 'attributes' => [ - 'title' => '特征信息，key:value格式', - 'description' => '扩展信息。', - 'type' => 'string', - 'example' => '{"language":"java"}', + 'webhookParam' => [ + 'description' => 'webhook参数', + 'type' => 'object', + 'properties' => [ + 'method' => ['description' => 'webhook请求方法。', 'type' => 'string', 'example' => 'GET'], + 'url' => ['description' => '报警回调的URL地址。', 'type' => 'string', 'example' => 'http://www.test.com'], + 'contentType' => ['description' => '数据格式，请求方法为POST时生效。', 'type' => 'string', 'example' => 'JSON'], + 'headers' => [ + 'description' => '请求头。', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => '{\'X-Total-Count\': 0}', 'description' => '请求头。'], + ], + ], ], - 'workspace' => [ - 'title' => '工作空间', - 'description' => '工作空间。', - 'type' => 'string', - 'example' => 'default-cms-1192928460540589-cn-hangzhou', + 'fc3Param' => [ + 'description' => '函数计算3.0参数。', + 'type' => 'object', + 'properties' => [ + 'regionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-qingdao'], + 'function' => ['description' => '函数计算服务的函数名称。', 'type' => 'string', 'example' => 'test'], + 'qualifier' => ['description' => '函数的版本或别名。', 'type' => 'string', 'example' => 'test'], + ], ], - 'resourceGroupId' => [ - 'title' => '资源组id', - 'description' => '资源组id', - 'type' => 'string', - 'example' => 'rg-aekxxzuad5zzzz', + 'ebParam' => [ + 'description' => '事件总线。', + 'type' => 'object', + 'properties' => [ + 'regionId' => ['description' => '区域 ID。', 'type' => 'string', 'example' => 'cn-heyuan'], + 'eventBusName' => ['description' => '事件总线名称。', 'type' => 'string', 'example' => 'test'], + 'subject' => ['description' => '主题。', 'type' => 'string', 'example' => 'test'], + 'ebSource' => ['description' => '事件提供方。', 'type' => 'string', 'example' => 'test'], + ], ], ], ], ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询告警行动集成', + 'changeSet' => [ + ['createdAt' => '2025-07-01T06:49:23.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2024-11-04T06:29:21.000Z', 'description' => 'OpenAPI 下线'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\",\\n \\"nextToken\\": \\"2-ba4d-4b9f-aa24-dcb067a30f1c\\",\\n \\"totalCount\\": 66,\\n \\"maxResults\\": 10,\\n \\"services\\": [\\n {\\n \\"serviceId\\": \\"jm2pl0yoqf@d4905cb11a4f218dfb0a8\\",\\n \\"serviceName\\": \\"demo-app\\",\\n \\"createTime\\": \\"2025-07-01T02:23:59Z\\",\\n \\"serviceType\\": \\"TRACE\\",\\n \\"serviceStatus\\": \\"Running\\",\\n \\"displayName\\": \\"test\\",\\n \\"pid\\": \\"kgcsf@192197e828d51aa\\",\\n \\"description\\": \\"workspace api monitor test\\",\\n \\"attributes\\": \\"{\\\\\\"language\\\\\\":\\\\\\"java\\\\\\"}\\",\\n \\"workspace\\": \\"default-cms-1192928460540589-cn-hangzhou\\",\\n \\"resourceGroupId\\": \\"rg-aekxxzuad5zzzz\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '批量查询应用可观测服务', - ], - 'CreatePrometheusVirtualInstance' => [ - 'summary' => '创建Prometheus监控虚拟实例', - 'path' => '/virtual-instances', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAlertActions'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:ListAlertActions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'AlertAction', 'arn' => 'acs:cms:{#regionId}:{#accountId}:alertaction/*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"total\\": 9,\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 100,\\n \\"alertActions\\": [\\n {\\n \\"alertActionId\\": \\"test\\",\\n \\"mnsParam\\": {\\n \\"mnsType\\": \\"queue\\",\\n \\"name\\": \\"test\\",\\n \\"regionId\\": \\"cn-hangzhou\\"\\n },\\n \\"type\\": \\"FC\\",\\n \\"slsParam\\": {\\n \\"logstore\\": \\"test\\",\\n \\"project\\": \\"test\\",\\n \\"regionId\\": \\"cn-hangzhou\\"\\n },\\n \\"alertActionName\\": \\"testName\\",\\n \\"essParam\\": {\\n \\"essGroupId\\": \\"testId\\",\\n \\"essRuleId\\": \\"testId\\",\\n \\"regionId\\": \\"cn-beijing\\"\\n },\\n \\"fcParam\\": {\\n \\"function\\": \\"test\\",\\n \\"regionId\\": \\"cn-beijing\\",\\n \\"service\\": \\"test\\"\\n },\\n \\"pagerDutyParam\\": {\\n \\"key\\": \\"fsfer4543t5t65g4t4\\",\\n \\"url\\": \\"https://events.pagerduty.com/v2/enqueue\\"\\n },\\n \\"webhookParam\\": {\\n \\"method\\": \\"GET\\",\\n \\"url\\": \\"http://www.test.com\\",\\n \\"contentType\\": \\"JSON\\",\\n \\"headers\\": {\\n \\"key\\": \\"{\'X-Total-Count\': 0}\\"\\n }\\n },\\n \\"fc3Param\\": {\\n \\"regionId\\": \\"cn-qingdao\\",\\n \\"function\\": \\"test\\",\\n \\"qualifier\\": \\"test\\"\\n },\\n \\"ebParam\\": {\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"eventBusName\\": \\"test\\",\\n \\"subject\\": \\"test\\",\\n \\"ebSource\\": \\"test\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListAlertRobots' => [ + 'summary' => '查询机器人', + 'path' => '/robots', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => '每页大小。默认100', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'default' => '100'], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => '页面。默认为1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'default' => '1'], + ], + [ + 'name' => 'robotIds', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '请求体。', - 'type' => 'object', - 'properties' => [ - 'namespace' => [ - 'title' => '每个云产品在每个Regin只能创建一个虚拟实例', - 'description' => '每个云产品在每个Regin只能创建一个虚拟实例。', - 'type' => 'string', - 'required' => true, - 'example' => 'cms_prometheus', - ], + 'description' => '机器人ID。', + 'type' => 'array', + 'items' => ['description' => '机器人ID。', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'required' => false, + ], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => ['description' => '机器人名称。支持前缀模糊搜索', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'types', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '机器人类型。', + 'type' => 'array', + 'items' => [ + 'description' => '机器人类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'DING', + 'enum' => ['DING', 'WEIXIN', 'FEISHU', 'SLACK'], ], 'required' => false, ], ], + [ + 'name' => 'workspace', + 'in' => 'query', + 'schema' => ['type' => 'string'], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应内容结构', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '0B9377D9-C56B-5C2E-A8A4-************', - ], - 'instance' => [ - 'title' => '实例ID', - 'description' => '实例ID', - 'type' => 'object', - 'properties' => [ - 'instanceId' => [ - 'title' => '地域ID', - 'description' => '地域ID', - 'type' => 'string', - 'example' => 'rw-e815960b4c9ebc5c3d89790c7e82', - ], - 'regionId' => [ - 'title' => '用户ID', - 'description' => '用户ID', - 'type' => 'string', - 'example' => 'cn-zhengzhou-jva', - ], - 'userId' => [ - 'title' => '用户ID', - 'description' => '用户ID', - 'type' => 'string', - 'example' => '167212345678', - ], - 'namespace' => [ - 'title' => '云产品', - 'description' => '云产品', - 'type' => 'string', - 'example' => 'ack-csi-fuse', - ], - 'httpApiUrl' => [ - 'title' => 'HTTP API查询地址', - 'description' => 'HTTP API查询地址', - 'type' => 'string', - 'example' => 'http://xxxxxxx', - ], - 'createdAt' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '1751520976660', + 'pageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'pageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求 ID', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'robots' => [ + 'description' => '机器人ID。', + 'type' => 'array', + 'items' => [ + 'description' => '机器人ID。', + 'type' => 'object', + 'properties' => [ + 'lang' => ['description' => '语言。', 'type' => 'string', 'example' => 'zh_CN'], + 'name' => ['description' => '机器人名称。', 'type' => 'string', 'example' => 'test'], + 'robotId' => ['description' => '机器人唯一ID。', 'type' => 'string', 'example' => 'test'], + 'type' => ['description' => '机器人类型。', 'type' => 'string', 'example' => 'DING'], + 'url' => ['description' => '机器人webhook。', 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=*******'], + 'workspace' => ['type' => 'string'], + 'digitalEmployeeName' => ['type' => 'string'], + 'robotSignKey' => ['type' => 'string'], ], ], ], + 'total' => ['description' => '总记录数', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.', 'description' => '参数%s缺失或不合法。'], + ], + 500 => [ + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => '服务运行错误。'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-************\\",\\n \\"instance\\": {\\n \\"instanceId\\": \\"rw-e815960b4c9ebc5c3d89790c7e82\\",\\n \\"regionId\\": \\"cn-zhengzhou-jva\\",\\n \\"userId\\": \\"167212345678\\",\\n \\"namespace\\": \\"ack-csi-fuse\\",\\n \\"httpApiUrl\\": \\"http://xxxxxxx\\",\\n \\"createdAt\\": \\"1751520976660\\"\\n }\\n}","type":"json"}]', - 'title' => '创建Prometheus监控虚拟实例', - 'description' => '创建Prometheus监控虚拟实例。', - ], - 'ListPrometheusVirtualInstances' => [ - 'summary' => '获取Prometheus虚拟实例', - 'path' => '/virtual-instances', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 20,\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"robots\\": [\\n {\\n \\"lang\\": \\"zh_CN\\",\\n \\"name\\": \\"test\\",\\n \\"robotId\\": \\"test\\",\\n \\"type\\": \\"DING\\",\\n \\"url\\": \\"https://oapi.dingtalk.com/robot/send?access_token=*******\\",\\n \\"workspace\\": \\"\\",\\n \\"digitalEmployeeName\\": \\"\\",\\n \\"robotSignKey\\": \\"\\"\\n }\\n ],\\n \\"total\\": 3\\n}","type":"json"}]', + 'title' => '查询告警机器人', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:ListAlertRobots', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'AlertRobot', 'arn' => 'acs:cms:{#regionId}:{#accountId}:robot/{#robotId}'], + ], + ], + ], ], + ], + 'ListAlertWebhooks' => [ + 'path' => '/webhooks', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'namespace', + 'name' => 'pageSize', 'in' => 'query', + 'schema' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'default' => '100'], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码。默认值：1。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'default' => '1'], + ], + [ + 'name' => 'webhookIds', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '可选云产品', - 'description' => '可选云产品。', - 'type' => 'string', + 'description' => 'webhook唯一标识。', + 'type' => 'array', + 'items' => ['description' => 'webhook唯一标识。', 'type' => 'string', 'required' => false, 'example' => 'wh-def456uvw012'], 'required' => false, - 'example' => 'ack-csi-fuse', ], ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => ['description' => 'webhook名称。', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'workspace', + 'in' => 'query', + 'schema' => ['type' => 'string'], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应内容结构', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'instances' => [ - 'description' => '实例信息。', + 'pageNumber' => ['description' => '页码，默认1。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'pageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '8A33DBEA-*****-*****-*****-*****'], + 'total' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '8'], + 'webhooks' => [ + 'description' => 'webhooks', 'type' => 'array', 'items' => [ - 'description' => '实例信息。', + 'description' => 'webhook', 'type' => 'object', 'properties' => [ - 'instanceId' => [ - 'description' => '适用数据源类型：PROMETHEUS_DS'."\n" - ."\n" - .'prometheus实例ID', - 'type' => 'string', - 'example' => 'rw-b8cfbbe94194ac37fe83f3d2d16a', - ], - 'httpApiUrl' => [ - 'description' => 'HTTP API地址。', - 'type' => 'string', - 'example' => 'http://xxxxxxxx', - ], - 'userId' => [ - 'description' => '用户ID。', - 'type' => 'string', - 'example' => '17073812345', - ], - 'regionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-shanghai-cloudspe', - ], - 'namespace' => [ - 'description' => '适用查询类型：CMS_BASIC_QUERY。'."\n" - ."\n" - .'指标的命名空间', - 'type' => 'string', - 'example' => 'arms-prom', - ], - 'createdAt' => [ - 'description' => '创建时间', - 'type' => 'string', - 'example' => '1750315319946', - ], + 'contentType' => ['description' => '数据内容类型。支持'."\n" + .'- JSON'."\n" + .'- FORM', 'type' => 'string', 'example' => 'JSON'], + 'headers' => ['description' => 'headers', 'type' => 'object', 'example' => 'key'], + 'lang' => ['description' => '语言。支持：'."\n" + .'- zh_CN'."\n" + .'- en_US', 'type' => 'string', 'example' => 'zh_CN'], + 'method' => ['description' => '请求方法。支持'."\n" + .'- GET'."\n" + .'- POST', 'type' => 'string', 'example' => 'GET'], + 'name' => ['description' => 'webhook名称。', 'type' => 'string', 'example' => 'test'], + 'url' => ['description' => '报警回调的URL地址。', 'type' => 'string', 'example' => 'http://aliyun.com/test'], + 'webhookId' => ['description' => 'webhook唯一标识。', 'type' => 'string', 'example' => 'test'], + 'workspace' => ['type' => 'string'], ], ], ], @@ -14751,1129 +12962,808 @@ ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"instances\\": [\\n {\\n \\"instanceId\\": \\"rw-b8cfbbe94194ac37fe83f3d2d16a\\",\\n \\"httpApiUrl\\": \\"http://xxxxxxxx\\",\\n \\"userId\\": \\"17073812345\\",\\n \\"regionId\\": \\"cn-shanghai-cloudspe\\",\\n \\"namespace\\": \\"arms-prom\\",\\n \\"createdAt\\": \\"1750315319946\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取Prometheus虚拟实例列表', - 'description' => '用于创建一个站点监控任务', - ], - 'GetAggTaskGroup' => [ - 'summary' => '查询聚合任务组详情。', - 'path' => '/prometheus-instances/{instanceId}/agg-task-groups/{groupId}', - 'methods' => [ - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.', 'description' => '参数%s缺失或不合法。'], + ], + 500 => [ + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => '服务运行错误。'], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询报警webhook', + 'summary' => '查询Webhook', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"requestId\\": \\"8A33DBEA-*****-*****-*****-*****\\",\\n \\"total\\": 8,\\n \\"webhooks\\": [\\n {\\n \\"contentType\\": \\"JSON\\",\\n \\"headers\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"lang\\": \\"zh_CN\\",\\n \\"method\\": \\"GET\\",\\n \\"name\\": \\"test\\",\\n \\"url\\": \\"http://aliyun.com/test\\",\\n \\"webhookId\\": \\"test\\",\\n \\"workspace\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListBizTraces' => [ + 'summary' => '业务链路列表', + 'path' => '/bizTraces', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'instanceId', - 'in' => 'path', - 'schema' => [ - 'title' => '聚合任务组所属的 Prometheus 实例的 id，聚合任务从这个实例中读取数据', - 'description' => '聚合任务组所属的 Prometheus 实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rw-xxx', - ], + 'name' => 'workspace', + 'in' => 'query', + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => false, 'example' => 'default-cms-xxxxxx-cn-beijing'], ], [ - 'name' => 'groupId', - 'in' => 'path', - 'schema' => [ - 'title' => '聚合任务组 id', - 'description' => '聚合任务组ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'aggTaskGroup-xxx', - ], + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => '最大返回结果数，最大值100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => '分页Token', 'type' => 'string', 'required' => false, 'example' => 'aa9d0e569b88098a0e3155c29b473201a'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '出参结构体', - 'description' => '出参结构体。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'aggTaskGroup' => [ - 'title' => '聚合任务组', - 'description' => '聚合任务组。', - 'type' => 'object', - 'properties' => [ - 'aggTaskGroupConfig' => [ - 'title' => '聚合任务组配置', - 'description' => '聚合任务组配置。', - 'type' => 'string', - 'example' => 'groups:'."\n" - .'- name: "node.rules"'."\n" - .' interval: "60s"'."\n" - .' rules:'."\n" - .' - record: "node_namespace_pod:kube_pod_info:"'."\n" - .' expr: "max(label_replace(kube_pod_info{job=\\"kubernetes-pods-kube-state-metrics\\"\\'."\n" - .' }, \\"pod\\", \\"$1\\", \\"pod\\", \\"(.*)\\")) by (node, namespace, pod, cluster)"', - ], - 'aggTaskGroupConfigHash' => [ - 'title' => '聚合任务组配置的摘要', - 'description' => '聚合任务组配置的摘要。', - 'type' => 'string', - 'example' => 'a54136xxx', - ], - 'aggTaskGroupId' => [ - 'title' => '聚合任务组 id', - 'description' => '聚合任务组ID。', - 'type' => 'string', - 'example' => 'aggTaskGroup-xx', - ], - 'aggTaskGroupName' => [ - 'title' => '聚合任务组名称', - 'description' => '聚合任务组名称。', - 'type' => 'string', - 'example' => 'pipeline-aggtask-group', - ], - 'cronExpr' => [ - 'title' => '调度模式选择“Cron”情况下，聚合任务组的调度表达式', - 'description' => '调度模式选择“Cron”情况下，聚合任务组的调度表达式。', - 'type' => 'string', - 'example' => '0 1 3 * * ? *', - ], - 'delay' => [ - 'title' => '调度的固定延迟时间', - 'description' => '调度的固定延迟时间（秒）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'description' => [ - 'title' => '聚合任务组描述'."\n" - ."\n", - 'description' => '聚合任务组描述。', - 'type' => 'string', - 'example' => 'test', - ], - 'fromTime' => [ - 'title' => '调度开始时间对应的的秒级时间戳', - 'description' => '调度开始时间对应的的秒级时间戳（暂未生效）。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1757409495', - ], - 'maxRetries' => [ - 'title' => '执行聚合任务的最大重试次数', - 'description' => '执行聚合任务的最大重试次数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'maxRunTimeInSeconds' => [ - 'title' => '执行聚合任务的最大重试时间', - 'description' => '执行聚合任务的最大重试时间。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'precheckString' => [ - 'title' => '预检测配置', - 'description' => '预检测配置。', - 'type' => 'string', - 'example' => '{"policy":"skip","prometheusId":"rw-xx","query":"noPrecheck","threshold":0.5,"timeout":15,"type":"none"}', - ], - 'regionId' => [ - 'title' => '地域 id', - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-zhangjiakou', - ], - 'scheduleMode' => [ - 'title' => '调度模式', - 'description' => '调度模式。', - 'type' => 'string', - 'example' => 'FixedRate', - ], - 'scheduleTimeExpr' => [ - 'title' => '调度时间表达式', - 'description' => '调度时间表达式。', - 'type' => 'string', - 'example' => '@m', - ], - 'sourcePrometheusId' => [ - 'title' => '聚合任务组的源 Prometheus 实例 id', - 'description' => '聚合任务组的源 Prometheus实例ID。', - 'type' => 'string', - 'example' => 'rw-xxx', - ], - 'status' => [ - 'title' => '聚合任务组状态', - 'description' => '聚合任务组状态。', - 'type' => 'string', - 'example' => 'Running', - ], - 'tags' => [ - 'title' => '资源组标签', - 'description' => '资源组标签。', - 'type' => 'array', - 'items' => [ - 'description' => '标签。', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'title' => '资源组标签的键', - 'description' => '资源组标签的键。', - 'type' => 'string', - 'example' => 'key1', - ], - 'value' => [ - 'title' => '资源组标签的值', - 'description' => '资源组标签的值。', - 'type' => 'string', - 'example' => 'value1', - ], - ], - ], - ], - 'targetPrometheusId' => [ - 'title' => '聚合任务组的目标 Prometheus 实例 id', - 'description' => '聚合任务组的目标 Prometheus 实例ID。', - 'type' => 'string', - 'example' => 'rw-xxx', - ], - 'toTime' => [ - 'title' => '调度结束时间对应的秒级时间戳', - 'description' => '调度结束时间对应的秒级时间戳。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1757409495', - ], - 'updateTime' => [ - 'title' => '聚合任务组的更新时间', - 'description' => '聚合任务组的更新时间（时间戳）。', - 'type' => 'string', - 'example' => '1757409499000', - ], - 'userId' => [ - 'title' => '聚合任务组所属用户', - 'description' => '聚合任务组所属用户。', - 'type' => 'string', - 'example' => '123xxx', - ], - ], - ], - 'requestId' => [ - 'title' => '请求 id', - 'description' => '请求 id', - 'type' => 'string', - 'example' => '68DAF543-35DF-5762-BE90-F5C00B5DC036', - ], - 'success' => [ - 'title' => '请求是否成功', - 'description' => '请求是否成功', - 'type' => 'boolean', - 'example' => 'True', + 'requestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-*****'], + 'maxResults' => ['description' => '最大返回结果数，最大值100', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'nextToken' => ['description' => '下一次查询的令牌。', 'type' => 'string', 'example' => 'aa9d0e569b88098a0e3155c29b473201a'], + 'totalCount' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '66'], + 'items' => [ + 'description' => '业务链路列表', + 'type' => 'array', + 'items' => ['description' => '业务链路', '$ref' => '#/components/schemas/BizTraceConfig'], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询业务链路列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"aggTaskGroup\\": {\\n \\"aggTaskGroupConfig\\": \\"groups:\\\\n- name: \\\\\\"node.rules\\\\\\"\\\\n interval: \\\\\\"60s\\\\\\"\\\\n rules:\\\\n - record: \\\\\\"node_namespace_pod:kube_pod_info:\\\\\\"\\\\n expr: \\\\\\"max(label_replace(kube_pod_info{job=\\\\\\\\\\\\\\"kubernetes-pods-kube-state-metrics\\\\\\\\\\\\\\"\\\\\\\\\\\\n }, \\\\\\\\\\\\\\"pod\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"$1\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"pod\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"(.*)\\\\\\\\\\\\\\")) by (node, namespace, pod, cluster)\\\\\\"\\",\\n \\"aggTaskGroupConfigHash\\": \\"a54136xxx\\",\\n \\"aggTaskGroupId\\": \\"aggTaskGroup-xx\\",\\n \\"aggTaskGroupName\\": \\"pipeline-aggtask-group\\",\\n \\"cronExpr\\": \\"0 1 3 * * ? *\\",\\n \\"delay\\": 2,\\n \\"description\\": \\"test\\",\\n \\"fromTime\\": 1757409495,\\n \\"maxRetries\\": 2,\\n \\"maxRunTimeInSeconds\\": 50,\\n \\"precheckString\\": \\"{\\\\\\"policy\\\\\\":\\\\\\"skip\\\\\\",\\\\\\"prometheusId\\\\\\":\\\\\\"rw-xx\\\\\\",\\\\\\"query\\\\\\":\\\\\\"noPrecheck\\\\\\",\\\\\\"threshold\\\\\\":0.5,\\\\\\"timeout\\\\\\":15,\\\\\\"type\\\\\\":\\\\\\"none\\\\\\"}\\",\\n \\"regionId\\": \\"cn-zhangjiakou\\",\\n \\"scheduleMode\\": \\"FixedRate\\",\\n \\"scheduleTimeExpr\\": \\"@m\\",\\n \\"sourcePrometheusId\\": \\"rw-xxx\\",\\n \\"status\\": \\"Running\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"key1\\",\\n \\"value\\": \\"value1\\"\\n }\\n ],\\n \\"targetPrometheusId\\": \\"rw-xxx\\",\\n \\"toTime\\": 1757409495,\\n \\"updateTime\\": \\"1757409499000\\",\\n \\"userId\\": \\"123xxx\\"\\n },\\n \\"requestId\\": \\"68DAF543-35DF-5762-BE90-F5C00B5DC036\\",\\n \\"success\\": true\\n}","type":"json"}]', - 'title' => '查询聚合任务组', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-*****\\",\\n \\"maxResults\\": 20,\\n \\"nextToken\\": \\"aa9d0e569b88098a0e3155c29b473201a\\",\\n \\"totalCount\\": 66,\\n \\"items\\": [\\n {\\n \\"workspace\\": \\"default-cms-xxxxxxx-cn-hangzhou\\",\\n \\"bizTraceId\\": \\"e339260ed64c95d\\",\\n \\"bizTraceName\\": \\"just test\\",\\n \\"bizTraceCode\\": \\"label_env\\",\\n \\"ruleConfig\\": \\"[{\\\\\\"entrancePid\\\\\\":\\\\\\"xxxxx@b57c44xx6e86\\\\\\",\\\\\\"rpcMatcher\\\\\\":{\\\\\\"matchType\\\\\\":\\\\\\"EQUALS\\\\\\",\\\\\\"pattern\\\\\\":\\\\\\"/createApp\\\\\\"},\\\\\\"characteristics\\\\\\":{\\\\\\"operation\\\\\\":\\\\\\"AND\\\\\\",\\\\\\"rules\\\\\\":[{\\\\\\"target\\\\\\":\\\\\\"CUSTOM_EXTRACT\\\\\\",\\\\\\"matcher\\\\\\":{\\\\\\"matchType\\\\\\":\\\\\\"CONTAINS\\\\\\",\\\\\\"pattern\\\\\\":[]}}]}}]\\",\\n \\"advancedConfig\\": \\"{\\\\\\"sample\\\\\\":{\\\\\\"strategy\\\\\\":\\\\\\"BY_APP\\\\\\"}}\\",\\n \\"createTime\\": \\"2025-12-12 00:00:00\\",\\n \\"regionId\\": \\"cn-beijing\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'CreateAggTaskGroup' => [ - 'summary' => '创建聚合任务组。', - 'path' => '/prometheus-instances/{instanceId}/agg-task-groups', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListContactGroups' => [ + 'summary' => '查询联系人组', + 'path' => '/contactGroups', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'instanceId', - 'in' => 'path', + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => '每页大小。默认100', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'default' => '100'], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => '页面。默认为1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'default' => '1'], + ], + [ + 'name' => 'contactGroupIds', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '聚合任务组的源 Prometheus 实例 id', - 'description' => '聚合任务组的源 Prometheus 实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pq4apob9jm', + 'description' => '联系组ID。', + 'type' => 'array', + 'items' => ['description' => '联系组ID。', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'required' => false, ], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'name', + 'in' => 'query', + 'schema' => ['description' => '联系人名称', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'workspace', + 'in' => 'query', + 'schema' => ['type' => 'string'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '入参结构体', - 'description' => '入参结构体。', + 'title' => 'Schema of Response', + 'description' => '响应内容结构', 'type' => 'object', 'properties' => [ - 'aggTaskGroupConfig' => [ - 'title' => '聚合任务组配置。目前仅支持 “RecordingRuleYaml” 格式，要求符合开源 Prometheus 的 RecordingRule 的格式要求', - 'description' => '聚合任务组配置。'."\n" - .'目前仅支持 “RecordingRuleYaml” 格式，要求符合开源 Prometheus 的 RecordingRule 的格式要求。', - 'type' => 'string', - 'required' => true, - 'example' => 'groups:'."\n" - .'- name: "node.rules"'."\n" - .' interval: "60s"'."\n" - .' rules:'."\n" - .' - record: "node_namespace_pod:kube_pod_info:"'."\n" - .' expr: "max(label_replace(kube_pod_info{job=\\"kubernetes-pods-kube-state-metrics\\"\\'."\n" - .' }, \\"pod\\", \\"$1\\", \\"pod\\", \\"(.*)\\")) by (node, namespace, pod, cluster)"'."\n", - ], - 'aggTaskGroupConfigType' => [ - 'title' => '聚合任务组配置类型，默认 “RecordingRuleYaml”（开源 Prometheus 的 RecordingRule 格式）', - 'description' => '聚合任务组配置类型，默认 “RecordingRuleYaml”（开源 Prometheus 的 RecordingRule 格式）。', - 'type' => 'string', - 'required' => false, - 'example' => 'RecordingRuleYaml', - 'default' => 'RecordingRuleYaml', - ], - 'aggTaskGroupName' => [ - 'title' => '聚合任务组名称', - 'description' => '聚合任务组名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-group', - ], - 'cronExpr' => [ - 'title' => '调度模式选择“Cron”情况下，具体的调度表达式。例如“0/1 * * * *”，表示从 0 分开始，每隔 1 分钟调度一次', - 'description' => '调度模式选择“Cron”情况下，具体的调度表达式。例如“0/1 * * * *”，表示从 0 分开始，每隔 1 分钟调度一次。', - 'type' => 'string', - 'required' => false, - 'example' => '0/1 * * * *', - ], - 'delay' => [ - 'title' => '调度的固定延迟时间，单位：秒，默认 30 ', - 'description' => '调度的固定延迟时间。单位：秒，默认30。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '120', - 'minimum' => '0', - 'example' => '30', - 'default' => '30', - ], - 'description' => [ - 'title' => '聚合任务组描述', - 'description' => '聚合任务组描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], - 'fromTime' => [ - 'title' => '调度开始时间对应的的秒级时间戳', - 'description' => '调度开始时间对应的的秒级时间戳。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1724996015', - ], - 'maxRetries' => [ - 'title' => '执行聚合任务的最大重试次数，默认 20', - 'description' => '执行聚合任务的最大重试次数，默认 20。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - 'default' => '20', - ], - 'maxRunTimeInSeconds' => [ - 'title' => '执行聚合任务的最大重试时间，单位：秒，默认 600', - 'description' => '执行聚合任务的最大重试时间，单位：秒，默认 600。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '600', - 'default' => '600', - ], - 'precheckString' => [ - 'title' => '预检测配置，默认不配置。输入的字符串需要能被正确 JSON 解析', - 'description' => '预检测配置，默认不配置。输入的字符串需要能被正确 JSON 解析。', - 'type' => 'string', - 'required' => false, - 'example' => '{"policy":"skip","prometheusId":"xxx","query":"scalar(sum(count_over_time(up{job=\\"_arms/kubelet/cadvisor\\"}[15s])) / 21)","threshold":0.5,"timeout":15,"type":"promql"}', - ], - 'scheduleMode' => [ - 'title' => '调度模式，“Cron” 或 “FixedRate”，默认 “FixedRate”', - 'description' => '调度模式，“Cron” 或 “FixedRate”，默认 “FixedRate”。', - 'type' => 'string', - 'required' => false, - 'example' => 'FixedRate', - 'default' => 'FixedRate', - 'enum' => [ - 'FixedRate', - 'Cron', - ], - ], - 'scheduleTimeExpr' => [ - 'title' => '调度时间表达式，推荐 “@s” 或者 “@m”，表示调度时间窗口对齐的粒度，默认 “@m”', - 'description' => '调度时间表达式，推荐 “@s” 或者 “@m”，表示调度时间窗口对齐的粒度，默认 “@m”。', - 'type' => 'string', - 'required' => false, - 'example' => '@m', - 'default' => '@m', - ], - 'status' => [ - 'title' => '聚合任务组状态，“Running” 或者 “Stopped”。默认 Running', - 'description' => '聚合任务组状态，“Running” 或者 “Stopped”。默认 Running。', - 'type' => 'string', - 'required' => false, - 'example' => 'Running', - 'default' => 'Running', - 'enum' => [ - 'Running', - 'Stopped', - ], - ], - 'tags' => [ - 'title' => '资源组标签', - 'description' => '资源组标签。', + 'contactGroups' => [ + 'description' => '联系组。', 'type' => 'array', 'items' => [ - 'description' => '资源标签value值。', + 'description' => '联系组。', 'type' => 'object', 'properties' => [ - 'key' => [ - 'title' => '资源组标签的键', - 'description' => '资源组标签的键。', - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], - 'value' => [ - 'title' => '资源组标签的值', - 'description' => '资源组标签的值。', - 'type' => 'string', - 'required' => false, - 'example' => 'value1', + 'contactGroupId' => ['description' => '联系组唯一标识。', 'type' => 'string', 'example' => 'test'], + 'contactIds' => [ + 'description' => '联系人ID。', + 'type' => 'array', + 'items' => ['description' => '联系人ID。', 'type' => 'string', 'example' => '[\\"演示会议\\"]'], + 'example' => '["Demo meeting"]', ], + 'name' => ['description' => '联系人名称。', 'type' => 'string', 'example' => 'test'], + 'workspace' => ['type' => 'string'], ], - 'required' => false, ], - 'required' => false, - ], - 'targetPrometheusId' => [ - 'title' => '聚合任务组的目标 Prometheus 实例 id', - 'description' => '聚合任务组的目标 Prometheus 实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rw-pq4apob9jm', - ], - 'toTime' => [ - 'title' => '调度结束时间对应的秒级时间戳，0 表示不停止调度', - 'description' => '调度结束时间对应的秒级时间戳，0 表示不停止调度。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', ], + 'pageNumber' => ['description' => '页面。默认为1', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'pageSize' => ['description' => '每页大小。默认100', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求的唯一标识 ID', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'total' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '15'], ], - 'required' => false, ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.', 'description' => '参数%s缺失或不合法。'], + ], + 500 => [ + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => '服务运行错误。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"contactGroups\\": [\\n {\\n \\"contactGroupId\\": \\"test\\",\\n \\"contactIds\\": [\\n \\"[\\\\\\\\\\\\\\"演示会议\\\\\\\\\\\\\\"]\\"\\n ],\\n \\"name\\": \\"test\\",\\n \\"workspace\\": \\"\\"\\n }\\n ],\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"total\\": 15\\n}","type":"json"}]', + 'title' => '查询联系组', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'overrideIfExists', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:ListContactGroups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'ContactGroup', 'arn' => 'acs:cms:{#regionId}:{#accountId}:contactgroup/{#contactGroupId}'], + ], + ], + ], + ], + ], + 'ListContacts' => [ + 'summary' => '查询联系人', + 'path' => '/contact', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcmsOZILZ5'], + ], + 'parameters' => [ + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => '每页大小。默认100', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'default' => '100'], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => '页面。默认为1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'default' => '1'], + ], + [ + 'name' => 'contactIds', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '创建聚合任务组时，存在同名资源是否覆盖更新', - 'description' => '创建聚合任务组时，存在同名资源是否覆盖更新。', - 'type' => 'boolean', + 'description' => '联系人ID。', + 'type' => 'array', + 'items' => ['description' => '联系人ID。', 'type' => 'string', 'required' => false, 'example' => 'test'], 'required' => false, - 'example' => 'true', - 'default' => 'false', ], ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => ['description' => '联系人名称', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'phone', + 'in' => 'query', + 'schema' => ['description' => '联系人手机号。', 'type' => 'string', 'required' => false, 'example' => '15012345678'], + ], + [ + 'name' => 'email', + 'in' => 'query', + 'schema' => ['description' => '联系人邮箱地址。', 'type' => 'string', 'required' => false, 'example' => 'test@aliyun.com'], + ], + [ + 'name' => 'groupId', + 'in' => 'query', + 'schema' => ['description' => '联系人所在联系组 ID', 'type' => 'string', 'required' => false, 'example' => 'group-id-123'], + ], + [ + 'name' => 'queryUngroupedContacts', + 'in' => 'query', + 'schema' => ['title' => '是否查询未分组联系人', 'description' => '只查询未分组联系人。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'workspace', + 'in' => 'query', + 'schema' => ['type' => 'string'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '出参结构体', - 'description' => '出参结构体。', + 'title' => 'Schema of Response', + 'description' => '响应内容结构', 'type' => 'object', 'properties' => [ - 'aggTaskGroupConfigHash' => [ - 'title' => '聚合任务组配置的摘要', - 'description' => '聚合任务组配置的摘要。', - 'type' => 'string', - 'example' => 'a54136014dc386a92c83a6ef1e97ff22', - ], - 'aggTaskGroupId' => [ - 'title' => '聚合任务组 id', - 'description' => '聚合任务组ID。', - 'type' => 'string', - 'example' => 'aggTaskGroup-f4b8e50525cf41c894488c0c71ec483f', - ], - 'aggTaskGroupName' => [ - 'title' => '聚合任务组名称', - 'description' => '聚合任务组名称。', - 'type' => 'string', - 'example' => 'pipeline-aggtask-group', - ], - 'requestId' => [ - 'title' => '请求 id', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '16C0A6D6-C3E7-511D-A60B-A87FD85F5BA7', - ], - 'sourcePrometheusId' => [ - 'title' => '聚合任务组的源 Prometheus 实例 id', - 'description' => '聚合任务组的源 Prometheus 实例ID。', - 'type' => 'string', - 'example' => 'rw-ecc04af14729b1a16e40a0d10068', - ], - 'status' => [ - 'title' => '聚合任务组的当前状态', - 'description' => '聚合任务组的当前状态。', - 'type' => 'string', - 'example' => 'Pending2Running', + 'contacts' => [ + 'description' => '联系人列表。', + 'type' => 'array', + 'items' => [ + 'description' => '联系人详情。', + 'type' => 'object', + 'properties' => [ + 'contactId' => ['description' => '值班人ID。', 'type' => 'string', 'example' => 'test'], + 'email' => ['description' => '联系人邮箱地址。', 'type' => 'string', 'example' => 'test@aliyun.com'], + 'emailVerify' => ['description' => '邮箱是否已激活。', 'type' => 'boolean', 'example' => 'true'], + 'groupList' => [ + 'description' => '联系人所在联系组。', + 'type' => 'array', + 'items' => ['description' => '联系人所在联系组。', 'type' => 'string', 'example' => 'groupId'], + ], + 'lang' => ['description' => '语言。', 'type' => 'string', 'example' => 'zh_CN'], + 'name' => ['description' => '联系人名称。', 'type' => 'string', 'example' => 'test'], + 'phone' => ['description' => '联系人手机号。', 'type' => 'string', 'example' => '130123456789'], + 'phoneVerify' => ['description' => '联系人手机号是否已激活。', 'type' => 'boolean', 'example' => 'true'], + 'updateTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2024-10-22 02:21:51'], + 'imUserIds' => [ + 'description' => 'IM 用户 ID 映射，支持多种即时通讯工具', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => '{"dingtalk": "abc123", "wechat": "def456"}', 'description' => 'IM 用户 ID 映射，支持多种即时通讯工具'], + ], + 'workspace' => ['type' => 'string'], + ], + ], ], + 'pageNumber' => ['description' => '页面。默认为1', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'pageSize' => ['description' => '每页大小。默认100', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'total' => ['description' => '总记录数', 'type' => 'integer', 'format' => 'int64', 'example' => '56'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"aggTaskGroupConfigHash\\": \\"a54136014dc386a92c83a6ef1e97ff22\\",\\n \\"aggTaskGroupId\\": \\"aggTaskGroup-f4b8e50525cf41c894488c0c71ec483f\\",\\n \\"aggTaskGroupName\\": \\"pipeline-aggtask-group\\",\\n \\"requestId\\": \\"16C0A6D6-C3E7-511D-A60B-A87FD85F5BA7\\",\\n \\"sourcePrometheusId\\": \\"rw-ecc04af14729b1a16e40a0d10068\\",\\n \\"status\\": \\"Pending2Running\\"\\n}","type":"json"}]', - 'title' => '创建聚合任务组', - ], - 'DeleteAggTaskGroup' => [ - 'summary' => '删除聚合任务组。', - 'path' => '/prometheus-instances/{instanceId}/agg-task-groups/{groupId}', - 'methods' => [ - 'delete', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.', 'description' => '参数%s缺失或不合法。'], + ], + 500 => [ + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => '服务运行错误。'], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询联系人', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"contacts\\": [\\n {\\n \\"contactId\\": \\"test\\",\\n \\"email\\": \\"test@aliyun.com\\",\\n \\"emailVerify\\": true,\\n \\"groupList\\": [\\n \\"groupId\\"\\n ],\\n \\"lang\\": \\"zh_CN\\",\\n \\"name\\": \\"test\\",\\n \\"phone\\": \\"130123456789\\",\\n \\"phoneVerify\\": true,\\n \\"updateTime\\": \\"2024-10-22 02:21:51\\",\\n \\"imUserIds\\": {\\n \\"key\\": \\"{\\\\\\"dingtalk\\\\\\": \\\\\\"abc123\\\\\\", \\\\\\"wechat\\\\\\": \\\\\\"def456\\\\\\"}\\"\\n },\\n \\"workspace\\": \\"\\"\\n }\\n ],\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 20,\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"total\\": 56\\n}","type":"json"}]', + ], + 'ListContextStoreAPIKeys' => [ + 'path' => '/workspace/{workspace}/contextstore/{contextStoreName}/apikey', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'instanceId', + 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'title' => '聚合任务组所属的 Prometheus 实例的 id，聚合任务从这个实例中读取数据', - 'description' => '聚合任务组所属的 Prometheus 实例ID，聚合任务从这个实例中读取数据。', - 'type' => 'string', - 'required' => true, - 'example' => 'rw-pq4apob9jm', - ], + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => false, 'example' => 'workspace-test'], ], [ - 'name' => 'groupId', + 'name' => 'contextStoreName', 'in' => 'path', - 'schema' => [ - 'title' => '聚合任务组 id', - 'description' => '聚合任务组ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'aggTaskGroup-xxx', - ], + 'schema' => ['description' => '上下文库', 'type' => 'string', 'required' => false, 'example' => 'test-context-Store'], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => '分页Token', 'type' => 'string', 'required' => false, 'example' => '615dfe7fd00f699ea94d5e63ba564aaf22450858c58f1387cc78f883b2254ab47232ce40fa95d9cb'], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => '最大返回数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '出参结构体', - 'description' => '出参结构体。', + 'title' => 'Schema of Response', + 'description' => '响应数据', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求 id', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', + 'requestId' => ['title' => 'Id of the request', 'description' => '请求Id', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'nextToken' => ['description' => '分页Token', 'type' => 'string', 'example' => 'xCs4wJD41qEejNkappMSJ1OL2Ky2GeKLqmBLJrC61WrgUOj9F-31jHbo5Kgqzifv'], + 'maxResults' => ['description' => '最大返回数量', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'total' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '454'], + 'results' => [ + 'description' => '返回值', + 'type' => 'array', + 'items' => [ + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'API Key 的显示名称，用于标识用途', 'type' => 'string', 'example' => 'Production Service Key'], + 'apiKey' => ['description' => '完整的 API Key 值', 'type' => 'string', 'example' => 'sk-3ac8d45d741e4f31b81aa6ee984ce9fd'], + 'createTime' => ['description' => '创建时间', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1778205145'], + 'workspace' => ['description' => '工作空间ID', 'type' => 'string', 'example' => 'test-workspace'], + 'contextStoreName' => ['description' => '上下文库名称', 'type' => 'string', 'example' => 'test-context-Store'], + ], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取 API Key 列表', + 'summary' => '获取 API Key 列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', - 'title' => '删除聚合任务组', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"nextToken\\": \\"xCs4wJD41qEejNkappMSJ1OL2Ky2GeKLqmBLJrC61WrgUOj9F-31jHbo5Kgqzifv\\",\\n \\"maxResults\\": 100,\\n \\"total\\": 454,\\n \\"results\\": [\\n {\\n \\"name\\": \\"Production Service Key\\",\\n \\"apiKey\\": \\"sk-3ac8d45d741e4f31b81aa6ee984ce9fd\\",\\n \\"createTime\\": \\"1778205145\\",\\n \\"workspace\\": \\"test-workspace\\",\\n \\"contextStoreName\\": \\"test-context-Store\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'UpdateAggTaskGroupStatus' => [ - 'summary' => '更新聚合任务组状态。', - 'path' => '/prometheus-instances/{instanceId}/agg-task-groups/{groupId}/status', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'ListContextStores' => [ + 'summary' => '查询上下文库列表', + 'path' => '/workspace/{workspace}/contextstore', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'instanceId', + 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'title' => '聚合任务组所属的 Prometheus 实例的 id，聚合任务从这个实例中读取数据', - 'description' => '聚合任务组所属的 Prometheus 实例的ID。聚合任务从这个实例中读取数据。', - 'type' => 'string', - 'required' => true, - 'example' => 'rw-pq4apob9jm', - ], + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'maxLength' => 64, 'minLength' => 2], ], [ - 'name' => 'groupId', - 'in' => 'path', - 'schema' => [ - 'title' => '聚合任务组 id', - 'description' => '聚合任务组ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'aggTaskGroup-xxx', - ], + 'name' => 'contextStoreName', + 'in' => 'query', + 'schema' => ['description' => '上下文库名称', 'type' => 'string', 'required' => false, 'example' => 'test-context-store'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'contextType', + 'in' => 'query', + 'schema' => ['description' => '上下文类型', 'type' => 'string', 'required' => false, 'example' => 'memory'], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => '最大返回数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => '分页Token', 'type' => 'string', 'required' => false, 'example' => 'OCAQV0pBqldexv7EidbIZw=='], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '入参结构体', - 'description' => '入参结构体。', + 'description' => '响应数据', 'type' => 'object', 'properties' => [ - 'status' => [ - 'title' => '聚合任务组状态，“Running” 或者 “Stopped”。默认 Running', - 'description' => '聚合任务组状态，“Running” 或者 “Stopped”。默认 Running。', - 'type' => 'string', - 'required' => true, - 'example' => 'Running', - 'enum' => [ - 'Running', - 'Stopped', + 'requestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'nextToken' => ['description' => '分页Token', 'type' => 'string', 'example' => '2-ba4d-4b9f-aa24-dcb067a30f1c'], + 'maxResults' => ['description' => '最大返回结果数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'total' => ['description' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '56'], + 'results' => [ + 'description' => '返回值', + 'type' => 'array', + 'items' => [ + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'contextStoreName' => ['description' => '上下文库名称', 'type' => 'string', 'example' => 'test-context-store'], + 'workspace' => ['description' => '工作空间ID', 'type' => 'string', 'example' => 'workspace-test'], + 'regionId' => ['description' => '地域ID', 'type' => 'string', 'example' => 'cn-heyuan'], + 'contextType' => ['description' => '上下文类型', 'type' => 'string', 'example' => 'memory'], + 'description' => ['description' => '描述信息', 'type' => 'string', 'example' => 'test'], + 'status' => ['description' => '状态', 'type' => 'string', 'example' => 'active'], + 'createTime' => ['description' => '创建时间', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '173847364841938'], + 'updateTime' => ['description' => '更新时间', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '173847364841938'], + ], ], ], ], - 'required' => false, ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询上下文库列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"nextToken\\": \\"2-ba4d-4b9f-aa24-dcb067a30f1c\\",\\n \\"maxResults\\": 100,\\n \\"total\\": 56,\\n \\"results\\": [\\n {\\n \\"contextStoreName\\": \\"test-context-store\\",\\n \\"workspace\\": \\"workspace-test\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"contextType\\": \\"memory\\",\\n \\"description\\": \\"test\\",\\n \\"status\\": \\"active\\",\\n \\"createTime\\": \\"173847364841938\\",\\n \\"updateTime\\": \\"173847364841938\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListDatasets' => [ + 'summary' => '查询数据集列表', + 'path' => '/workspace/{workspace}/dataset', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'maxLength' => 64, 'minLength' => 2], + ], + [ + 'name' => 'datasetName', + 'in' => 'query', + 'schema' => ['description' => '数据集名称', 'type' => 'string', 'required' => false, 'example' => 'test_dataset'], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => '最大返回结果数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => '分页 Token', 'type' => 'string', 'required' => false, 'example' => 'd9a48d977f45aa6fcf6981ed13b885b3fab0b124c12dcbbe70edce5d81ba****************'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '出参结构体', - 'description' => '出参结构体。', + 'title' => 'Schema of Response', + 'description' => '响应数据', 'type' => 'object', 'properties' => [ - 'aggTaskGroupConfigHash' => [ - 'title' => '聚合任务组配置的摘要', - 'description' => '聚合任务组配置的摘要。', - 'type' => 'string', - 'example' => 'a54136014dc386a92c83a6ef1e97ff22', - ], - 'aggTaskGroupId' => [ - 'title' => '聚合任务组 id', - 'description' => '聚合任务组ID。', - 'type' => 'string', - 'example' => 'aggTaskGroup-xxx', - ], - 'aggTaskGroupName' => [ - 'title' => '聚合任务组名称', - 'description' => '聚合任务组名称。', - 'type' => 'string', - 'example' => 'pipeline-aggtask-group', - ], - 'requestId' => [ - 'title' => '请求 id', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-***', - ], - 'sourcePrometheusId' => [ - 'title' => '聚合任务组的源 Prometheus 实例 id', - 'description' => '聚合任务组的源 Prometheus 实例ID。', - 'type' => 'string', - 'example' => 'rw-xxx', - ], - 'status' => [ - 'title' => '聚合任务组的当前状态', - 'description' => '聚合任务组的当前状态。', - 'type' => 'string', - 'example' => 'Running', + 'nextToken' => ['description' => '分页Token', 'type' => 'string', 'example' => 'd9a48d977f45aa6fcf6981ed13b885b3fab0b124c12dcbbe70edce5d81ba****************'], + 'maxResults' => ['description' => '最大返回结果数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'requestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'total' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '96'], + 'datasets' => [ + 'description' => '结果集', + 'type' => 'array', + 'items' => [ + 'description' => '结果集', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => '描述', 'type' => 'string', 'example' => 'test dataset'], + 'createTime' => ['description' => '创建时间', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1695090077'], + 'updateTime' => ['description' => '更新时间', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1695090077'], + 'datasetName' => ['description' => '数据集名称', 'type' => 'string', 'example' => 'test_dataset'], + 'workspace' => ['description' => '工作空间ID', 'type' => 'string', 'example' => 'workspace-test'], + 'regionId' => ['description' => '地域ID', 'type' => 'string', 'example' => 'cn-hangzhou'], + ], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询数据集列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"aggTaskGroupConfigHash\\": \\"a54136014dc386a92c83a6ef1e97ff22\\",\\n \\"aggTaskGroupId\\": \\"aggTaskGroup-xxx\\",\\n \\"aggTaskGroupName\\": \\"pipeline-aggtask-group\\",\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-***\\",\\n \\"sourcePrometheusId\\": \\"rw-xxx\\",\\n \\"status\\": \\"Running\\"\\n}","type":"json"}]', - 'title' => '更新聚合任务组状态', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"nextToken\\": \\"d9a48d977f45aa6fcf6981ed13b885b3fab0b124c12dcbbe70edce5d81ba****************\\",\\n \\"maxResults\\": 100,\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"total\\": 96,\\n \\"datasets\\": [\\n {\\n \\"description\\": \\"test dataset\\",\\n \\"createTime\\": \\"1695090077\\",\\n \\"updateTime\\": \\"1695090077\\",\\n \\"datasetName\\": \\"test_dataset\\",\\n \\"workspace\\": \\"workspace-test\\",\\n \\"regionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'UpdateAggTaskGroup' => [ - 'summary' => '应用聚合任务组。', - 'path' => '/prometheus-instances/{instanceId}/agg-task-groups/{groupId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'ListDeliveryTasks' => [ + 'summary' => '获取数据投递任务列表。', + 'path' => '/delivery-tasks', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'instanceId', - 'in' => 'path', - 'schema' => [ - 'title' => '聚合任务组所属的 Prometheus 实例的 id，聚合任务从这个实例中读取数据', - 'description' => '聚合任务组所属的 Prometheus 实例ID。聚合任务从这个实例中读取数据。', - 'type' => 'string', - 'required' => true, - 'example' => 'rw-pq4apob9jm', - ], + 'name' => 'keyWords', + 'in' => 'query', + 'schema' => ['description' => '按任务名称或任务 ID 模糊查询（like 语义）', 'type' => 'string', 'required' => false, 'example' => 'test-task'], ], [ - 'name' => 'groupId', - 'in' => 'path', - 'schema' => [ - 'title' => '聚合任务组 id', - 'description' => '聚合任务组ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'aggTaskGroup-xxxx', - ], + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组 ID', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2bhocin5e2na'], ], [ - 'name' => 'body', - 'in' => 'body', + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => '翻页 Token，首次请求不填，后续传入上次返回的 nextToken', 'type' => 'string', 'required' => false, 'example' => 'sjC5rekx93Ew7K7VcmI3wkBZBYQ-GphB2ilQu3zJCGxoZuicwyJznfo2riTjr-lq'], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => '每页返回数量，默认 20，最大 100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '100'], + ], + [ + 'name' => 'tag', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '入参结构体', - 'description' => '入参结构体。', + 'description' => '标签列表', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表', + 'type' => 'object', + 'properties' => [ + 'value' => ['description' => '标签值', 'type' => 'string', 'required' => false, 'example' => 'value1'], + 'key' => ['description' => '标签键', 'type' => 'string', 'required' => false, 'example' => 'testKey'], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回值结构体', 'type' => 'object', 'properties' => [ - 'aggTaskGroupConfig' => [ - 'title' => '聚合任务组配置。目前仅支持 “RecordingRuleYaml” 格式，要求符合开源 Prometheus 的 RecordingRule 的格式要求', - 'description' => '聚合任务组配置。目前仅支持 “RecordingRuleYaml” 格式，要求符合开源 Prometheus 的 RecordingRule 的格式要求。', - 'type' => 'string', - 'required' => true, - 'example' => 'groups:'."\n" - .'- name: "node.rules"'."\n" - .' interval: "60s"'."\n" - .' rules:'."\n" - .' - record: "node_namespace_pod:kube_pod_info:"'."\n" - .' expr: "max(label_replace(kube_pod_info{job=\\"kubernetes-pods-kube-state-metrics\\"\\'."\n" - .' }, \\"pod\\", \\"$1\\", \\"pod\\", \\"(.*)\\")) by (node, namespace, pod, cluster)"', - ], - 'aggTaskGroupConfigType' => [ - 'title' => '聚合任务组配置类型，默认 “RecordingRuleYaml”（开源 Prometheus 的 RecordingRule 格式）', - 'description' => '聚合任务组配置类型，默认 “RecordingRuleYaml”（开源 Prometheus 的 RecordingRule 格式）。', - 'type' => 'string', - 'required' => false, - 'example' => 'RecordingRuleYaml', - 'default' => 'RecordingRuleYaml', - ], - 'aggTaskGroupName' => [ - 'title' => '聚合任务组名称', - 'description' => '聚合任务组名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test-group', - ], - 'cronExpr' => [ - 'title' => '调度模式选择“Cron”情况下，具体的调度表达式。例如“0/1 * * * *”，表示从 0 分开始，每隔 1 分钟调度一次', - 'description' => '调度模式选择“Cron”情况下，具体的调度表达式。例如“0/1 * * * *”，表示从 0 分开始，每隔 1 分钟调度一次。', - 'type' => 'string', - 'required' => false, - 'example' => '0/1 * * * *', - ], - 'delay' => [ - 'title' => '调度的固定延迟时间，单位：秒，默认 30', - 'description' => '调度的固定延迟时间，单位：秒，默认 30。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '120', - 'minimum' => '0', - 'example' => '30', - 'default' => '30', - ], - 'description' => [ - 'title' => '聚合任务组描述', - 'description' => '聚合任务组描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], - 'fromTime' => [ - 'title' => '调度开始时间对应的的秒级时间戳', - 'description' => '调度开始时间对应的的秒级时间戳。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1724996015', - ], - 'maxRetries' => [ - 'title' => '执行聚合任务的最大重试次数，默认 20', - 'description' => '执行聚合任务的最大重试次数，默认 20。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - 'default' => '20', - ], - 'maxRunTimeInSeconds' => [ - 'title' => '执行聚合任务的最大重试时间，单位：秒，默认 600', - 'description' => '执行聚合任务的最大重试时间，单位：秒，默认 600。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '600', - 'default' => '600', - ], - 'precheckString' => [ - 'title' => '预检测配置，默认不配置。输入的字符串需要能被正确 JSON 解析', - 'description' => '预检测配置，默认不配置。输入的字符串需要能被正确 JSON 解析。', - 'type' => 'string', - 'required' => false, - 'example' => '{"policy":"skip","prometheusId":"xxx","query":"scalar(sum(count_over_time(up{job=\\"_arms/kubelet/cadvisor\\"}[15s])) / 21)","threshold":0.5,"timeout":15,"type":"promql"}', - ], - 'scheduleMode' => [ - 'title' => '调度模式，“Cron” 或 “FixedRate”，默认 “FixedRate”', - 'description' => '调度模式，“Cron” 或 “FixedRate”，默认 “FixedRate”。', - 'type' => 'string', - 'required' => false, - 'example' => 'FixedRate', - 'default' => 'FixedRate', - 'enum' => [ - 'FixedRate', - 'Cron', - ], - ], - 'scheduleTimeExpr' => [ - 'title' => '调度时间表达式，推荐 “@s” 或者 “@m”，表示调度时间窗口对齐的粒度，默认 “@m”', - 'description' => '调度时间表达式，推荐 “@s” 或者 “@m”，表示调度时间窗口对齐的粒度，默认 “@m”。', - 'type' => 'string', - 'required' => false, - 'example' => '@m', - 'default' => '@m', - ], - 'status' => [ - 'title' => '聚合任务组状态，“Running” 或者 “Stopped”。默认 Running', - 'description' => '聚合任务组状态，“Running” 或者 “Stopped”。默认 Running。', - 'type' => 'string', - 'required' => false, - 'example' => 'Running', - 'default' => 'Running', - 'enum' => [ - 'Running', - 'Stopped', - ], - ], - 'tags' => [ - 'title' => '资源组标签', - 'description' => '资源组标签。', + 'maxResults' => ['description' => '最大返回结果数，最大值 100', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'nextToken' => ['description' => '下一页分页 Token', 'type' => 'string', 'example' => '2-ba4d-4b9f-aa24-dcb067a30f1c'], + 'totalCount' => ['description' => '总任务数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'deliveryTasks' => [ + 'description' => '投递任务列表', 'type' => 'array', 'items' => [ - 'description' => '标签。', + 'description' => '投递任务', 'type' => 'object', 'properties' => [ - 'key' => [ - 'title' => '资源组标签的键', - 'description' => '资源组标签的键。', + 'labelFiltersType' => [ + 'description' => '指标过滤模式', 'type' => 'string', - 'required' => false, - 'example' => 'key1', + 'enumValueTitles' => ['Deny' => 'Deny', 'Allow' => 'Allow'], + 'example' => 'Allow', + ], + 'externalLabels' => [ + 'description' => '为所有投递指标附加的额外 label，key 为 label 名，value 为 label 值', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => 'region: cn-hangzhou', 'description' => 'externalLabelsKey → externalLabelsValue，例如 region → cn-hangzhou'], ], - 'value' => [ - 'title' => '资源组标签的值', - 'description' => '资源组标签的值。', + 'sinkList' => [ + 'description' => '投递目标列表，支持配置多个 sink', + 'type' => 'array', + 'items' => [ + 'description' => '投递目标配置', + 'type' => 'object', + 'properties' => [ + 'sinkConfigs' => [ + 'description' => '投递目标详细配置，key/value 含义因 sinkType 不同而不同', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '各 sinkType 支持的配置项', 'example' => 'Url: http://xxxx/api/v1/write'], + ], + 'sinkType' => [ + 'description' => '投递目标类型', + 'type' => 'string', + 'enumValueTitles' => ['AcsKafka' => 'AcsKafka', 'Prometheus' => 'Prometheus', 'AcsMaxcompute' => 'AcsMaxcompute'], + 'example' => 'Prometheus', + ], + ], + ], + ], + 'taskDescription' => ['description' => '任务描述', 'type' => 'string', 'example' => 'my delivery task'], + 'updateTime' => ['description' => '更新时间', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2026-01-22T09:02:01Z'], + 'tags' => [ + 'description' => '标签', + 'type' => 'array', + 'items' => [ + 'description' => '标签', + 'type' => 'object', + 'properties' => [ + 'value' => ['description' => '标签值', 'type' => 'string', 'example' => 'value'], + 'key' => ['description' => '标签键', 'type' => 'string', 'example' => 'key'], + ], + ], + ], + 'dataSourceId' => ['description' => '数据源 ID（Prometheus 实例 ID）', 'type' => 'string', 'example' => 'rw-5f2b4c7e66342s'], + 'createTime' => ['description' => '创建时间', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2026-01-22T09:02:01Z'], + 'labelFilters' => [ + 'description' => '指标过滤条件，配合 labelFiltersType 使用，key 为指标 label 名，value 为匹配值', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => '__name__: up', 'description' => 'filterKey → filterValue，例如 __name__ → up，job → my_job'], + ], + 'taskName' => ['description' => '任务名称'."\n", 'type' => 'string', 'example' => 'test-task'], + 'resourceGroupId' => ['description' => '资源组 ID', 'type' => 'string', 'example' => 'rg-acfm3gn5i6bigbi'], + 'taskId' => ['description' => '任务ID', 'type' => 'string', 'example' => 'db21f8a126d96953'], + 'status' => [ + 'description' => '任务当前状态', 'type' => 'string', - 'required' => false, - 'example' => 'value1', + 'enumValueTitles' => ['Enable' => 'Enable', 'Disable' => 'Disable'], + 'example' => 'Enable', + ], + 'extraInfo' => [ + 'description' => '扩展信息。', + 'type' => 'object', + 'properties' => [ + 'taskNameList' => [ + 'description' => 'EventBridge 任务列表', + 'type' => 'array', + 'items' => ['description' => 'EventBridge 任务', 'type' => 'string', 'example' => 'prometheus-deliver-98e367d8fb8cc83b-0'], + ], + ], ], ], - 'required' => false, ], - 'required' => false, - ], - 'targetPrometheusId' => [ - 'title' => '聚合任务组的目标 Prometheus 实例 id', - 'description' => '聚合任务组的目标 Prometheus 实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rw-pq4apob9jm', - ], - 'toTime' => [ - 'title' => '调度结束时间对应的秒级时间戳，0 表示不停止调度', - 'description' => '调度结束时间对应的秒级时间戳，0 表示不停止调度。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', ], + 'requestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '7D7DF334-B2F2-5453-AD51-A27B337E3191'], ], - 'required' => false, ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '出参结构体', - 'description' => '出参结构体', - 'type' => 'object', - 'properties' => [ - 'aggTaskGroupConfigHash' => [ - 'title' => '聚合任务组配置的摘要', - 'description' => '聚合任务组配置的摘要', - 'type' => 'string', - 'example' => 'a54136014dc386a92c83a6ef1e97ff22', - ], - 'aggTaskGroupId' => [ - 'title' => '聚合任务组 id', - 'description' => '聚合任务组 id', - 'type' => 'string', - 'example' => 'aggTaskGroup-5fb2c3ade63a4709bcb059d13493b7b8', - ], - 'aggTaskGroupName' => [ - 'title' => '聚合任务组名称', - 'description' => '聚合任务组名称', - 'type' => 'string', - 'example' => 'pipeline-aggtask-group', - ], - 'requestId' => [ - 'title' => '请求 id', - 'description' => '请求 id', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], - 'sourcePrometheusId' => [ - 'title' => '聚合任务组的源 Prometheus 实例 id', - 'description' => '聚合任务组的源 Prometheus 实例 id', - 'type' => 'string', - 'example' => 'rw-083e17834e279f8c627fe91a2d72', - ], - 'status' => [ - 'title' => '聚合任务组的当前状态', - 'description' => '聚合任务组的当前状态', - 'type' => 'string', - 'example' => 'Running', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取数据投递任务列表', + 'description' => '删除一个指定的站点监控任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:ListDeliveryTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'DeliveryTask', 'arn' => 'acs:cms:{#regionId}:{#accountId}:deliverytask/*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"aggTaskGroupConfigHash\\": \\"a54136014dc386a92c83a6ef1e97ff22\\",\\n \\"aggTaskGroupId\\": \\"aggTaskGroup-5fb2c3ade63a4709bcb059d13493b7b8\\",\\n \\"aggTaskGroupName\\": \\"pipeline-aggtask-group\\",\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"sourcePrometheusId\\": \\"rw-083e17834e279f8c627fe91a2d72\\",\\n \\"status\\": \\"Running\\"\\n}","type":"json"}]', - 'title' => '更新聚合任务组', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"maxResults\\": 100,\\n \\"nextToken\\": \\"2-ba4d-4b9f-aa24-dcb067a30f1c\\",\\n \\"totalCount\\": 100,\\n \\"deliveryTasks\\": [\\n {\\n \\"labelFiltersType\\": \\"Allow\\",\\n \\"externalLabels\\": {\\n \\"key\\": \\"region: cn-hangzhou\\"\\n },\\n \\"sinkList\\": [\\n {\\n \\"sinkConfigs\\": {\\n \\"key\\": \\"Url: http://xxxx/api/v1/write\\"\\n },\\n \\"sinkType\\": \\"Prometheus\\"\\n }\\n ],\\n \\"taskDescription\\": \\"my delivery task\\",\\n \\"updateTime\\": \\"2026-01-22T09:02:01Z\\",\\n \\"tags\\": [\\n {\\n \\"value\\": \\"value\\",\\n \\"key\\": \\"key\\"\\n }\\n ],\\n \\"dataSourceId\\": \\"rw-5f2b4c7e66342s\\",\\n \\"createTime\\": \\"2026-01-22T09:02:01Z\\",\\n \\"labelFilters\\": {\\n \\"key\\": \\"__name__: up\\"\\n },\\n \\"taskName\\": \\"test-task\\",\\n \\"resourceGroupId\\": \\"rg-acfm3gn5i6bigbi\\",\\n \\"taskId\\": \\"db21f8a126d96953\\",\\n \\"status\\": \\"Enable\\",\\n \\"extraInfo\\": {\\n \\"taskNameList\\": [\\n \\"prometheus-deliver-98e367d8fb8cc83b-0\\"\\n ]\\n }\\n }\\n ],\\n \\"requestId\\": \\"7D7DF334-B2F2-5453-AD51-A27B337E3191\\"\\n}","type":"json"}]', ], - 'ListAggTaskGroups' => [ - 'summary' => '查询聚合任务组列表。', - 'path' => '/prometheus-instances/{instanceId}/agg-task-groups', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListIntegrationPolicies' => [ + 'path' => '/integration-policies', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'instanceId', - 'in' => 'path', - 'schema' => [ - 'title' => '聚合任务组所属的 Prometheus 实例的 id，聚合任务从这个实例中读取数据', - 'description' => '聚合任务组所属的 Prometheus 实例ID，聚合任务从这个实例中读取数据。', - 'type' => 'string', - 'required' => true, - 'example' => 'rw-pq4apob9jm', - ], + 'name' => 'policyId', + 'in' => 'query', + 'schema' => ['description' => '策略 ID。', 'type' => 'string', 'required' => false, 'example' => 'policy-93817a401f78435596d745a97d2e85a1'], ], [ - 'name' => 'filterAggTaskGroupIds', + 'name' => 'policyName', 'in' => 'query', - 'schema' => [ - 'title' => '聚合任务组的 id 列表，需要能被 JSON 解析', - 'description' => '聚合任务组的 id 列表，需要能被 JSON 解析。', - 'type' => 'string', - 'required' => false, - 'example' => '["aggTaskGroup-xxx"]', - ], + 'schema' => ['description' => '规则名称。', 'type' => 'string', 'required' => false, 'example' => 'prod-database'], ], [ - 'name' => 'filterAggTaskGroupNames', + 'name' => 'policyType', 'in' => 'query', - 'schema' => [ - 'title' => '聚合任务组名称列表，需要能被 JSON 解析', - 'description' => '聚合任务组名称列表，需要能被 JSON 解析。', - 'type' => 'string', - 'required' => false, - 'example' => '["apiserver_request_total"]', - ], + 'schema' => ['description' => '策略类型', 'type' => 'string', 'required' => false, 'example' => 'CS'], ], [ - 'name' => 'status', + 'name' => 'addonName', 'in' => 'query', - 'schema' => [ - 'title' => '聚合任务组状态，“Running” 或者 “Stopped”。默认 Running', - 'description' => '聚合任务组状态，“Running” 或者 “Stopped”。默认 Running。', - 'type' => 'string', - 'required' => false, - 'example' => 'Running', - 'enum' => [ - 'Running', - 'Stopped', - ], - ], + 'schema' => ['description' => 'Addon 名称。', 'type' => 'string', 'required' => false, 'example' => 'cs-default'], ], [ - 'name' => 'targetPrometheusId', + 'name' => 'filterRegionIds', 'in' => 'query', - 'schema' => [ - 'title' => '聚合任务组的目标 Prometheus 实例 id', - 'description' => '聚合任务组的目标 Prometheus 实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rw-pq4apob9jm', - ], + 'schema' => ['description' => '用于Region查询，以英文逗号分隔', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing,cn-hangzhou'], ], [ - 'name' => 'tags', + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组id。', 'type' => 'string', 'required' => false, 'example' => 'rg-xxxxx'], + ], + [ + 'name' => 'tag', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '资源组标签'."\n" - ."\n", - 'description' => '资源组标签。', + 'description' => '标签列表。', 'type' => 'array', 'items' => [ - 'description' => '资源组标签。', + 'description' => '标签列表，JSON格式。', 'type' => 'object', 'properties' => [ - 'key' => [ - 'title' => '资源组标签的键'."\n" - ."\n", - 'description' => '资源组标签的键。', - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], - 'value' => [ - 'title' => '资源组标签的值'."\n" - ."\n", - 'description' => '资源组标签的值。', - 'type' => 'string', - 'required' => false, - 'example' => 'value1', - ], + 'key' => ['description' => '标签键', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'value' => ['description' => '标签值', 'type' => 'string', 'required' => false, 'example' => 'value'], ], 'required' => false, ], @@ -15881,267 +13771,446 @@ ], ], [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => '用来返回更多结果。第一次查询不需要提供这个参数，后续查询所需使用的Token，从返回结果中获取。', 'type' => 'string', 'required' => false, 'example' => 'mvnX6zqg3P'], + ], + [ 'name' => 'maxResults', 'in' => 'query', - 'schema' => [ - 'title' => '返回的最多记录数', - 'description' => '返回的最多记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '20', - 'default' => '20', - ], + 'schema' => ['description' => '最大返回结果数。默认30，最大值100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ - 'name' => 'nextToken', + 'name' => 'entityGroupIds', 'in' => 'query', - 'schema' => [ - 'title' => '查询令牌', - 'description' => '查询令牌。', - 'type' => 'string', - 'required' => false, - 'example' => '28036394xxx', - 'maxLength' => 128, - ], + 'schema' => ['description' => '实体ID的过滤，以英文逗号分隔', 'type' => 'string', 'required' => false, 'example' => 'eg-1,eg-2,eg-3'], + ], + [ + 'name' => 'workspace', + 'in' => 'query', + 'schema' => ['description' => '工作空间。', 'type' => 'string', 'required' => false, 'example' => 'demo'], ], [ 'name' => 'query', 'in' => 'query', - 'schema' => [ - 'title' => '名称搜索，支持模糊匹配', - 'description' => '名称搜索。支持模糊匹配。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => '用于通用查询', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'prometheusInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例id。', 'type' => 'string', 'required' => false, 'example' => 'cmee-622d27c2e87d49debceeebc7c642610e'], + ], + [ + 'name' => 'bindResourceId', + 'in' => 'query', + 'schema' => ['title' => '绑定的资源Id', 'description' => '绑定的资源Id', 'type' => 'string', 'required' => false, 'example' => '622d27c2e87d49debceeebc7c642610e'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '出参结构体', - 'description' => '出参结构体。', 'type' => 'object', 'properties' => [ - 'aggTaskGroups' => [ - 'title' => '聚合任务组列表', - 'description' => '聚合任务组列表。', + 'maxResults' => ['description' => '分页大小'."\n" + .'默认值:'."\n" + .' 50'."\n" + .'最大值:'."\n" + .' 50', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'nextToken' => ['description' => '分页Token', 'type' => 'string', 'example' => '44ANBjKZmQeKnaB1fXRq06w7sFYK3MUcCALMD9qQbmEiE'], + 'policies' => [ + 'description' => '接入策略列表', 'type' => 'array', 'items' => [ - 'description' => '聚合任务。', + 'description' => '接入策略', 'type' => 'object', 'properties' => [ - 'aggTaskGroupConfigHash' => [ - 'title' => '聚合任务组配置的摘要'."\n" - ."\n", - 'description' => '聚合任务组配置的摘要。', - 'type' => 'string', - 'example' => 'a54136014xxx', - ], - 'aggTaskGroupId' => [ - 'title' => '聚合任务组 id'."\n" - ."\n", - 'description' => '聚合任务组ID。', - 'type' => 'string', - 'example' => 'aggTaskGroup-xxxx', - ], - 'aggTaskGroupName' => [ - 'title' => '聚合任务组名称'."\n" - ."\n", - 'description' => '聚合任务组名称。', - 'type' => 'string', - 'example' => 'pipeline-aggtask-group', - ], - 'cronExpr' => [ - 'title' => '调度模式选择“Cron”情况下，聚合任务组的调度表达式', - 'description' => '调度模式选择“Cron”情况下，聚合任务组的调度表达式。', - 'type' => 'string', - 'example' => '0 10 8 1 * ? *', - ], - 'delay' => [ - 'title' => '调度的固定延迟时间'."\n" - ."\n", - 'description' => '调度的固定延迟时间（秒）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'description' => [ - 'title' => '聚合任务组描述'."\n" - ."\n", - 'description' => '聚合任务组描述。', - 'type' => 'string', - 'example' => 'workspace api monitor update test', - ], - 'fromTime' => [ - 'title' => '调度开始时间对应的的秒级时间戳', - 'description' => '调度开始时间对应的的秒级时间戳。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1757409499000', - ], - 'interval' => [ - 'title' => '调度间隔', - 'description' => '调度间隔。', - 'type' => 'string', - 'example' => '2025-04-24 00:00:00,2025-04-24 00:00:00', - ], - 'maxRetries' => [ - 'title' => '执行聚合任务的最大重试次数'."\n" - ."\n", - 'description' => '执行聚合任务的最大重试次数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'maxRunTimeInSeconds' => [ - 'title' => '执行聚合任务的最大重试时间'."\n" - ."\n", - 'description' => '执行聚合任务的最大重试时间（秒）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'bindResource' => [ + 'description' => '绑定的资源信息', + 'type' => 'object', + 'properties' => [ + 'clusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'cv68tt87d78vyc89zy9v'], + 'clusterType' => ['description' => '集群类型。', 'type' => 'string', 'example' => 'ManagedKubernetes'], + 'vpcCidr' => ['description' => 'VPC网段', 'type' => 'string', 'example' => '100.100.0.1/16'], + 'vpcId' => ['description' => '虚拟专有网络。', 'type' => 'string', 'example' => 'vpc-uf664nyle5khp5d4d7hdo'], + ], ], - 'regionId' => [ - 'title' => '地域 id'."\n" - ."\n", - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', + 'entityGroup' => [ + 'description' => '实体组', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => '描述。', 'type' => 'string', 'example' => 'xxxx'], + 'entityGroupId' => ['description' => '实体组ID', 'type' => 'string', 'example' => 'eg-b79f65d11fb94e779867cf937c3a3002'], + 'entityGroupName' => ['description' => '实体组名称', 'type' => 'string', 'example' => 'test-eg'], + 'entityRules' => [ + 'description' => '实体组', + 'type' => 'object', + 'properties' => [ + 'annotations' => [ + 'description' => '注释', + 'type' => 'array', + 'items' => [ + 'description' => '注释', + 'type' => 'object', + 'properties' => [ + 'op' => ['description' => '执行的操作。', 'type' => 'string', 'example' => 'add'], + 'tagKey' => ['description' => '标签的键。', 'type' => 'string', 'example' => 'key'], + 'tagValues' => [ + 'description' => '标签的值', + 'type' => 'array', + 'items' => ['description' => '标签的值', 'type' => 'string', 'example' => 'value'], + ], + ], + ], + ], + 'entityTypes' => [ + 'description' => '实体类型列表', + 'type' => 'array', + 'items' => ['description' => '实体类型', 'type' => 'string', 'example' => 'ECS'], + ], + 'fieldRules' => [ + 'description' => '字段规则', + 'type' => 'array', + 'items' => [ + 'description' => '字段规则', + 'type' => 'object', + 'properties' => [ + 'fieldKey' => ['description' => '字段的唯一标识。', 'type' => 'string', 'example' => 'test'], + 'fieldValues' => [ + 'description' => '字段内容，多值用英文,分隔。', + 'type' => 'array', + 'items' => ['description' => '字段内容，多值用英文,分隔。', 'type' => 'string', 'example' => 'field1,fieled2'], + ], + 'op' => ['description' => '执行的操作。', 'type' => 'string', 'example' => 'add'], + ], + ], + ], + 'instanceIds' => [ + 'description' => '实例ID。', + 'type' => 'array', + 'items' => ['description' => '实例ID。', 'type' => 'string', 'example' => '6fq8fvvcb,owqeq789r'], + ], + 'ipMatchRule' => [ + 'description' => 'IP匹配规则', + 'type' => 'object', + 'properties' => [ + 'ipCidr' => ['description' => 'IP网段', 'type' => 'string', 'example' => '100.100.1.0/16'], + 'ipFieldKey' => ['description' => 'IP字段的key', 'type' => 'string', 'example' => 'xxxx'], + ], + ], + 'labels' => [ + 'description' => '标签', + 'type' => 'array', + 'items' => [ + 'description' => '标签`value`值。', + 'type' => 'object', + 'properties' => [ + 'op' => ['description' => '执行的操作。', 'type' => 'string', 'example' => 'add'], + 'tagKey' => ['description' => '标签键。', 'type' => 'string', 'example' => 'test'], + 'tagValues' => [ + 'description' => '标签的值', + 'type' => 'array', + 'items' => ['description' => '标签的值', 'type' => 'string', 'example' => 'value1'], + ], + ], + ], + ], + 'regionIds' => [ + 'description' => '地域ID列表', + 'type' => 'array', + 'items' => ['description' => '地域ID', 'type' => 'string', 'example' => 'cn-beijing,cn-hangzhou'], + ], + 'resourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-5i6dbwxfxuqihk7k'], + 'tags' => [ + 'description' => '实例的标签信息。', + 'type' => 'array', + 'items' => [ + 'description' => '标签值', + 'type' => 'object', + 'properties' => [ + 'op' => ['description' => '执行的操作。', 'type' => 'string', 'example' => 'add'], + 'tagKey' => ['description' => '标签键。', 'type' => 'string', 'example' => 'key'], + 'tagValues' => [ + 'description' => '标签值。', + 'type' => 'array', + 'items' => ['description' => '标签值。', 'type' => 'string', 'example' => 'value1'], + ], + ], + ], + ], + ], + ], + 'query' => ['description' => '搜索的关键词，支持文档库名称和描述', 'type' => 'string', 'example' => 'Haval'], + 'regionId' => ['description' => '区域 ID。', 'type' => 'string', 'example' => 'cn-heyuan'], + 'userId' => ['description' => '用户ID', 'type' => 'string', 'example' => '1236812738'], + 'workspace' => ['description' => '工作空间。', 'type' => 'string', 'example' => 'test-api'], + ], ], - 'scheduleMode' => [ - 'title' => '调度模式'."\n" - ."\n", - 'description' => '调度模式。', - 'type' => 'string', - 'example' => 'FixedRate', + 'managedInfo' => [ + 'description' => '策略网络管理信息。', + 'type' => 'object', + 'properties' => [ + 'securityGroupId' => ['description' => '安全组ID', 'type' => 'string', 'example' => 'sg-xxxxx'], + 'vswitchId' => ['description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-xxxxxx'], + 'eniId' => ['title' => '托管探针的eni网卡id。例如: eni-xxxx。', 'description' => '托管探针的eni网卡id。例如: eni-xxxx。', 'type' => 'string', 'example' => 'eni-12345678'], + ], ], - 'scheduleTimeExpr' => [ - 'title' => '调度时间表达式'."\n" - ."\n", - 'description' => '调度时间表达式。', + 'policyId' => ['description' => '策略 ID。', 'type' => 'string', 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e'], + 'policyName' => ['description' => '规则名称。', 'type' => 'string', 'example' => '6f5HSsg3AP'], + 'policyType' => ['description' => '接入中心策略类型', 'type' => 'string', 'example' => 'ECS'], + 'regionId' => ['description' => '区域 ID。', 'type' => 'string', 'example' => 'cn-heyuan'], + 'resourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-xxxxx'], + 'userId' => ['description' => '用户ID', 'type' => 'string', 'example' => '128470923'], + 'workspace' => ['description' => '工作空间。', 'type' => 'string', 'example' => 'test-api'], + 'feePackage' => [ + 'description' => '计费类型。', 'type' => 'string', - 'example' => '@m', + 'enumValueTitles' => ['CS_Pro' => 'CS_Pro', 'CS_Basic' => 'CS_Basic'], + 'example' => 'CS_Pro', ], - 'sourcePrometheusId' => [ - 'title' => '聚合任务组的源 Prometheus 实例 id', - 'description' => '聚合任务组的源 Prometheus 实例ID。', - 'type' => 'string', - 'example' => 'rw-xxx', + 'subAddonRelease' => [ + 'description' => '子Release数量', + 'type' => 'object', + 'properties' => [ + 'total' => ['description' => '规则数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '278'], + 'ready' => ['description' => '已就绪的子Release数量', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + ], ], - 'status' => [ - 'title' => '聚合任务组状态'."\n" - ."\n", - 'description' => '聚合任务组状态。', - 'type' => 'string', - 'example' => 'Running', + 'csUmodelStatus' => ['description' => '容器环境umodel安装状态。', 'type' => 'boolean', 'example' => 'true'], + ], + ], + ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5'], + 'totalCount' => ['description' => '条目总数', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询接入中心策略列表信息', + 'summary' => '查询接入中心策略列表信息', + 'description' => '查询集成列表', + 'changeSet' => [ + ['createdAt' => '2025-10-30T12:36:57.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2025-10-30T11:46:59.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2025-10-15T12:10:46.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-10-14T08:04:01.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntegrationPolicies'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:ListIntegrationPolicies', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"maxResults\\": 100,\\n \\"nextToken\\": \\"44ANBjKZmQeKnaB1fXRq06w7sFYK3MUcCALMD9qQbmEiE\\",\\n \\"policies\\": [\\n {\\n \\"bindResource\\": {\\n \\"clusterId\\": \\"cv68tt87d78vyc89zy9v\\",\\n \\"clusterType\\": \\"ManagedKubernetes\\",\\n \\"vpcCidr\\": \\"100.100.0.1/16\\",\\n \\"vpcId\\": \\"vpc-uf664nyle5khp5d4d7hdo\\"\\n },\\n \\"entityGroup\\": {\\n \\"description\\": \\"xxxx\\",\\n \\"entityGroupId\\": \\"eg-b79f65d11fb94e779867cf937c3a3002\\",\\n \\"entityGroupName\\": \\"test-eg\\",\\n \\"entityRules\\": {\\n \\"annotations\\": [\\n {\\n \\"op\\": \\"add\\",\\n \\"tagKey\\": \\"key\\",\\n \\"tagValues\\": [\\n \\"value\\"\\n ]\\n }\\n ],\\n \\"entityTypes\\": [\\n \\"ECS\\"\\n ],\\n \\"fieldRules\\": [\\n {\\n \\"fieldKey\\": \\"test\\",\\n \\"fieldValues\\": [\\n \\"field1,fieled2\\"\\n ],\\n \\"op\\": \\"add\\"\\n }\\n ],\\n \\"instanceIds\\": [\\n \\"6fq8fvvcb,owqeq789r\\"\\n ],\\n \\"ipMatchRule\\": {\\n \\"ipCidr\\": \\"100.100.1.0/16\\",\\n \\"ipFieldKey\\": \\"xxxx\\"\\n },\\n \\"labels\\": [\\n {\\n \\"op\\": \\"add\\",\\n \\"tagKey\\": \\"test\\",\\n \\"tagValues\\": [\\n \\"value1\\"\\n ]\\n }\\n ],\\n \\"regionIds\\": [\\n \\"cn-beijing,cn-hangzhou\\"\\n ],\\n \\"resourceGroupId\\": \\"rg-5i6dbwxfxuqihk7k\\",\\n \\"tags\\": [\\n {\\n \\"op\\": \\"add\\",\\n \\"tagKey\\": \\"key\\",\\n \\"tagValues\\": [\\n \\"value1\\"\\n ]\\n }\\n ]\\n },\\n \\"query\\": \\"Haval\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"userId\\": \\"1236812738\\",\\n \\"workspace\\": \\"test-api\\"\\n },\\n \\"managedInfo\\": {\\n \\"securityGroupId\\": \\"sg-xxxxx\\",\\n \\"vswitchId\\": \\"vsw-xxxxxx\\",\\n \\"eniId\\": \\"eni-12345678\\"\\n },\\n \\"policyId\\": \\"policy-ac38a7cb02d14ff48bc9f97d0a75063e\\",\\n \\"policyName\\": \\"6f5HSsg3AP\\",\\n \\"policyType\\": \\"ECS\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"resourceGroupId\\": \\"rg-xxxxx\\",\\n \\"userId\\": \\"128470923\\",\\n \\"workspace\\": \\"test-api\\",\\n \\"feePackage\\": \\"CS_Pro\\",\\n \\"subAddonRelease\\": {\\n \\"total\\": 278,\\n \\"ready\\": 30\\n },\\n \\"csUmodelStatus\\": true\\n }\\n ],\\n \\"requestId\\": \\"CD8BA7D6-995D-578D-9941-78B0FECD14B5\\",\\n \\"totalCount\\": 0\\n}","type":"json"}]', + ], + 'ListIntegrationPolicyAddons' => [ + 'summary' => '获取当前策略安装的Addon列表。', + 'path' => '/integration-policies/{policyId}/addons', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'policyId', + 'in' => 'path', + 'schema' => ['title' => '环境id', 'description' => '环境id', 'type' => 'string', 'required' => true, 'example' => 'policy-3563e6bf338141b3b92c118e2c318c37'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'addons' => [ + 'description' => 'Addon列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Addon信息。', + 'type' => 'object', + 'properties' => [ + 'alias' => ['description' => '展示名。', 'type' => 'string', 'example' => 'MySQL'], + 'categories' => [ + 'description' => '类别。', + 'type' => 'array', + 'items' => ['description' => '类别。', 'type' => 'string', 'example' => 'database'], ], - 'targetPrometheusId' => [ - 'title' => '聚合任务组的目标 Prometheus 实例 id', - 'description' => '聚合任务组的目标 Prometheus 实例ID。', - 'type' => 'string', - 'example' => 'rw-xxx', + '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://xxxxxxx'], + ], + ], ], - 'toTime' => [ - 'title' => '调度结束时间对应的秒级时间戳'."\n" - ."\n", - 'description' => '调度结束时间对应的秒级时间戳。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', + 'description' => ['description' => '描述。', 'type' => 'string', 'example' => 'Observability integration.'], + 'environments' => [ + 'description' => '支持的环境列表。', + 'type' => 'array', + 'items' => [ + 'description' => '环境信息。', + 'type' => 'object', + 'properties' => [ + 'dependencies' => [ + 'description' => '依赖。', + 'type' => 'object', + 'properties' => [ + 'clusterTypes' => [ + 'description' => '对集群类型的依赖。', + 'type' => 'array', + 'items' => ['description' => '集群类型。', 'type' => 'string', 'example' => 'ACK'], + ], + 'features' => [ + 'description' => '对探针的依赖。', + 'type' => 'object', + 'additionalProperties' => ['type' => 'boolean', 'description' => 'metric-agent', 'example' => 'true'], + ], + 'services' => [ + 'description' => '对产品 Code 的依赖。', + 'type' => 'array', + 'items' => ['description' => '服务名称', 'type' => 'string', 'example' => 'Prometheus'], + ], + ], + ], + 'description' => ['description' => '描述。', 'type' => 'string', 'example' => 'o11y-demo-cn-heyuan'], + 'enable' => ['description' => '是否启用', 'type' => 'boolean', 'example' => 'true'], + 'label' => ['description' => '环境展示名称。', 'type' => 'string', 'example' => 'Cloud'], + 'name' => ['description' => '环境名称。', 'type' => 'string', 'example' => 'Cloud'], + 'policies' => [ + 'description' => '策略。', + 'type' => 'object', + 'properties' => [ + 'alertDefaultStatus' => ['description' => '告警规则默认策略的启用状态。', 'type' => 'string', 'example' => 'RUNNING'], + 'defaultInstall' => ['description' => '是否默认安装', 'type' => 'boolean', 'example' => 'true'."\n"], + 'enableServiceAccount' => ['description' => '是否分配 Service Account 用以与 Console API 通信。', 'type' => 'boolean', 'example' => 'true'], + 'metricCheckRule' => [ + 'description' => '指标检测规则。', + 'type' => 'object', + 'properties' => [ + 'promQl' => [ + 'description' => 'Prom查询语句。', + 'type' => 'array', + 'items' => ['description' => 'Prom查询语句', 'type' => 'string', 'example' => 'up{job="mysql"} > 0'], + ], + ], + ], + 'needRestartAfterIntegration' => ['description' => '是否在插件接入时完成安装后即进入 Pod 重启引导。', 'type' => 'boolean', 'example' => 'true'], + 'protocols' => [ + 'description' => '协议。', + 'type' => 'array', + 'items' => [ + 'description' => '协议。', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => '描述', 'type' => 'string', 'example' => 'test'], + 'icon' => ['description' => '图标', 'type' => 'string', 'example' => ' https://img.alixxxx'], + 'label' => ['description' => '展示名称。', 'type' => 'string', 'example' => 'Golang'], + 'name' => ['description' => '协议名称。', 'type' => 'string', 'example' => 'golang'], + ], + ], + ], + 'targetAddonName' => ['description' => '目标Addon名称。', 'type' => 'string', 'example' => 'mysql'], + ], + ], + ], + ], ], - 'updateTime' => [ - 'title' => '聚合任务组的更新时间'."\n" - ."\n", - 'description' => '聚合任务组的更新时间。', - 'type' => 'string', - 'example' => '1757409499000', + 'icon' => ['description' => '组件图标。', 'type' => 'string', 'example' => 'asert/mysql.svg'], + 'keywords' => [ + 'description' => '关键词', + 'type' => 'array', + 'items' => ['description' => '关键词', 'type' => 'string', 'example' => 'container'], ], + 'language' => ['description' => '语言。', 'type' => 'string', 'example' => 'zh'], + 'latestReleaseCreateTime' => ['description' => '最新一次创建时间。', 'type' => 'string', 'example' => '2025-09-03T03:15:56Z'], + 'name' => ['description' => 'Addon名称。', 'type' => 'string', 'example' => 'mysql'], + 'once' => ['description' => '是否只能安装一次。', 'type' => 'boolean', 'example' => 'true'], + 'scene' => ['description' => '组件场景。', 'type' => 'string', 'example' => 'container'], + 'version' => ['description' => '组件版本。', 'type' => 'string', 'example' => '0.1.1'], + 'weight' => ['description' => '权重。', 'type' => 'integer', 'format' => 'int32', 'example' => '99'], ], ], ], - 'maxResults' => [ - 'title' => '返回的最多记录数', - 'description' => '返回的最多记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - 'default' => '0', - ], - 'nextToken' => [ - 'title' => '下一次查询的令牌', - 'description' => '下一次查询的令牌。', - 'type' => 'string', - 'example' => 'aa9d0e569b880xxx', - 'maxLength' => 128, - ], - 'requestId' => [ - 'title' => '请求 id'."\n" - ."\n", - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7BF1F4D6-B9A8-5F0B-8C1D-4347FFCB798E', - ], - 'totalCount' => [ - 'title' => '总实例数', - 'description' => '总实例数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '7E00EF90-CEF9-57C9-9AE9-5AA937D37C03'], + 'total' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取当前策略安装的Addon列表', + 'description' => '获取当前策略安装的Addon列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"aggTaskGroups\\": [\\n {\\n \\"aggTaskGroupConfigHash\\": \\"a54136014xxx\\",\\n \\"aggTaskGroupId\\": \\"aggTaskGroup-xxxx\\",\\n \\"aggTaskGroupName\\": \\"pipeline-aggtask-group\\",\\n \\"cronExpr\\": \\"0 10 8 1 * ? *\\",\\n \\"delay\\": 30,\\n \\"description\\": \\"workspace api monitor update test\\",\\n \\"fromTime\\": 1757409499000,\\n \\"interval\\": \\"2025-04-24 00:00:00,2025-04-24 00:00:00\\",\\n \\"maxRetries\\": 2,\\n \\"maxRunTimeInSeconds\\": 200,\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"scheduleMode\\": \\"FixedRate\\",\\n \\"scheduleTimeExpr\\": \\"@m\\",\\n \\"sourcePrometheusId\\": \\"rw-xxx\\",\\n \\"status\\": \\"Running\\",\\n \\"targetPrometheusId\\": \\"rw-xxx\\",\\n \\"toTime\\": 0,\\n \\"updateTime\\": \\"1757409499000\\"\\n }\\n ],\\n \\"maxResults\\": 100,\\n \\"nextToken\\": \\"aa9d0e569b880xxx\\",\\n \\"requestId\\": \\"7BF1F4D6-B9A8-5F0B-8C1D-4347FFCB798E\\",\\n \\"totalCount\\": 5\\n}","type":"json"}]', - 'title' => '查询聚合任务组列表', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"addons\\": [\\n {\\n \\"alias\\": \\"MySQL\\",\\n \\"categories\\": [\\n \\"database\\"\\n ],\\n \\"dashboards\\": [\\n {\\n \\"description\\": \\"用于mysql的监控大盘\\",\\n \\"name\\": \\"MySQL Overview\\",\\n \\"url\\": \\"http://xxxxxxx\\"\\n }\\n ],\\n \\"description\\": \\"Observability integration.\\",\\n \\"environments\\": [\\n {\\n \\"dependencies\\": {\\n \\"clusterTypes\\": [\\n \\"ACK\\"\\n ],\\n \\"features\\": {\\n \\"key\\": true\\n },\\n \\"services\\": [\\n \\"Prometheus\\"\\n ]\\n },\\n \\"description\\": \\"o11y-demo-cn-heyuan\\",\\n \\"enable\\": true,\\n \\"label\\": \\"Cloud\\",\\n \\"name\\": \\"Cloud\\",\\n \\"policies\\": {\\n \\"alertDefaultStatus\\": \\"RUNNING\\",\\n \\"defaultInstall\\": true,\\n \\"enableServiceAccount\\": true,\\n \\"metricCheckRule\\": {\\n \\"promQl\\": [\\n \\"up{job=\\\\\\"mysql\\\\\\"} > 0\\"\\n ]\\n },\\n \\"needRestartAfterIntegration\\": true,\\n \\"protocols\\": [\\n {\\n \\"description\\": \\"test\\",\\n \\"icon\\": \\" https://img.alixxxx\\",\\n \\"label\\": \\"Golang\\",\\n \\"name\\": \\"golang\\"\\n }\\n ],\\n \\"targetAddonName\\": \\"mysql\\"\\n }\\n }\\n ],\\n \\"icon\\": \\"asert/mysql.svg\\",\\n \\"keywords\\": [\\n \\"container\\"\\n ],\\n \\"language\\": \\"zh\\",\\n \\"latestReleaseCreateTime\\": \\"2025-09-03T03:15:56Z\\",\\n \\"name\\": \\"mysql\\",\\n \\"once\\": true,\\n \\"scene\\": \\"container\\",\\n \\"version\\": \\"0.1.1\\",\\n \\"weight\\": 99\\n }\\n ],\\n \\"requestId\\": \\"7E00EF90-CEF9-57C9-9AE9-5AA937D37C03\\",\\n \\"total\\": 5\\n}","type":"json"}]', ], - 'DeletePrometheusInstance' => [ - 'summary' => '删除prom实例。', - 'path' => '/prometheus-instances/{prometheusInstanceId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'ListIntegrationPolicyCollectors' => [ + 'summary' => '获取接入中心策略的采集器信息', + 'path' => '/integration-policies/{policyId}/collectors', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'prometheusInstanceId', + 'name' => 'policyId', 'in' => 'path', - 'schema' => [ - 'description' => '实例id', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rw-abc123', - ], + 'schema' => ['title' => '接入中心策略ID。', 'description' => '接入中心策略ID。', 'type' => 'string', 'required' => true, 'example' => 'env-d95435164593aece55f9999ce45c'], + ], + [ + 'name' => 'addonReleaseName', + 'in' => 'query', + 'schema' => ['title' => 'Addon Release名称。', 'description' => 'Addon Release名称。', 'type' => 'string', 'required' => false, 'example' => 'release-1234567'], + ], + [ + 'name' => 'collectorType', + 'in' => 'query', + 'schema' => ['description' => '采集器类型', 'type' => 'string', 'required' => true, 'example' => 'Exporter'], + ], + [ + 'name' => 'language', + 'in' => 'query', + 'schema' => ['description' => '语言。', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -16151,63 +14220,117 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', + 'collectors' => [ + 'description' => '采集器列表。', + 'type' => 'array', + 'items' => [ + 'description' => '采集器信息。', + 'type' => 'object', + 'properties' => [ + 'collectorName' => ['description' => '采集器名称', 'type' => 'string', 'example' => 'collector-kkxx'], + 'collectorType' => ['description' => '采集器类型', 'type' => 'string', 'example' => 'Exporter'], + 'conditions' => [ + 'description' => '阶段状态。', + 'type' => 'array', + 'items' => [ + 'description' => '详细信息。', + 'type' => 'object', + 'properties' => [ + 'firstTransitionTime' => ['description' => '第一次转换时间。', 'type' => 'string', 'example' => '2024-08-27T13:59:23+08:00'], + 'lastTransitionTime' => ['description' => '最后一次转换时间。', 'type' => 'string', 'example' => '2024-08-27T13:59:23+08:00'], + 'message' => ['description' => '详细信息。', 'type' => 'string', 'example' => 'success'], + 'reason' => ['description' => '失败原因', 'type' => 'string', 'example' => 'Probe'], + 'status' => ['description' => '阶段状态。', 'type' => 'string', 'example' => 'True'], + 'type' => ['description' => '阶段类型', 'type' => 'string', 'example' => 'Ready'], + ], + ], + ], + 'managed' => ['description' => '是否为托管组件。', 'type' => 'boolean', 'example' => 'false'], + 'state' => ['description' => '采集器状态。', 'type' => 'string', 'example' => 'xx'], + 'version' => ['description' => '组件版本。', 'type' => 'string', 'example' => '2.6.2'], + 'workloads' => [ + 'description' => '工作负载列表', + 'type' => 'array', + 'items' => [ + 'description' => '工作负载详情', + 'type' => 'object', + 'properties' => [ + 'hostIp' => ['description' => '主机IP', 'type' => 'string', 'example' => '10.10.10.10'], + 'ip' => ['description' => '工作负载的IP地址。', 'type' => 'string', 'example' => '11.193.82.198'], + 'managed' => ['description' => '是否为托管组件。', 'type' => 'boolean', 'example' => 'false'], + 'managedInfo' => [ + 'description' => '策略管理信息。', + 'type' => 'object', + 'properties' => [ + 'securityGroupId' => ['description' => '安全组ID。', 'type' => 'string', 'example' => 'sg-xxxxx'], + 'vswitchId' => ['description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-xxxxxx'], + ], + ], + 'message' => ['description' => '详细信息。', 'type' => 'string', 'example' => 'ok'], + 'name' => ['description' => '工作负载名称', 'type' => 'string', 'example' => 'exporter-xxx'], + 'namespace' => ['description' => '工作负载命名空间', 'type' => 'string', 'example' => 'prod-db'], + 'ownerReferenceKind' => ['description' => '引用上级的Kind', 'type' => 'string', 'example' => 'Deployment'], + 'ownerReferenceName' => ['description' => '引用上级的名称', 'type' => 'string', 'example' => 'exporter'], + 'startTime' => ['description' => '开始时间。', 'type' => 'string', 'example' => '2024-08-27T13:59:23+08:00'], + 'status' => ['description' => '状态。', 'type' => 'string', 'example' => '{}'], + 'version' => ['description' => '工作负载版本。', 'type' => 'string', 'example' => 'v2.4.4'], + ], + ], + ], + 'releaseName' => ['description' => 'AddonRelease名称。', 'type' => 'string', 'example' => 'ecs-loong-collector-i-f8z1176fg57rlwmc1rfi'], + 'addonMeta' => ['description' => 'Addon详情。', '$ref' => '#/components/schemas/AddonMeta'], + ], + ], ], + 'requestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取接入中心策略的采集器', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', - 'title' => '删除Prometheus实例', - 'description' => '删除Prometheus实例。', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"collectors\\": [\\n {\\n \\"collectorName\\": \\"collector-kkxx\\",\\n \\"collectorType\\": \\"Exporter\\",\\n \\"conditions\\": [\\n {\\n \\"firstTransitionTime\\": \\"2024-08-27T13:59:23+08:00\\",\\n \\"lastTransitionTime\\": \\"2024-08-27T13:59:23+08:00\\",\\n \\"message\\": \\"success\\",\\n \\"reason\\": \\"Probe\\",\\n \\"status\\": \\"True\\",\\n \\"type\\": \\"Ready\\"\\n }\\n ],\\n \\"managed\\": false,\\n \\"state\\": \\"xx\\",\\n \\"version\\": \\"2.6.2\\",\\n \\"workloads\\": [\\n {\\n \\"hostIp\\": \\"10.10.10.10\\",\\n \\"ip\\": \\"11.193.82.198\\",\\n \\"managed\\": false,\\n \\"managedInfo\\": {\\n \\"securityGroupId\\": \\"sg-xxxxx\\",\\n \\"vswitchId\\": \\"vsw-xxxxxx\\"\\n },\\n \\"message\\": \\"ok\\",\\n \\"name\\": \\"exporter-xxx\\",\\n \\"namespace\\": \\"prod-db\\",\\n \\"ownerReferenceKind\\": \\"Deployment\\",\\n \\"ownerReferenceName\\": \\"exporter\\",\\n \\"startTime\\": \\"2024-08-27T13:59:23+08:00\\",\\n \\"status\\": \\"{}\\",\\n \\"version\\": \\"v2.4.4\\"\\n }\\n ],\\n \\"releaseName\\": \\"ecs-loong-collector-i-f8z1176fg57rlwmc1rfi\\",\\n \\"addonMeta\\": {\\n \\"name\\": \\"cloud-acs-ecs\\",\\n \\"version\\": \\"0.0.1\\",\\n \\"language\\": \\"zh\\",\\n \\"description\\": \\"The out-of-the-box and comprehensive ECS observe dashboards and alarm rules. Based on AliYun CloudMonitor agentless metrics, exporter agent metrics, host audit logs, host events and other data.\\",\\n \\"scene\\": \\"feature\\",\\n \\"alias\\": \\"ECS 监控\\",\\n \\"icon\\": \\"assets/logos/ecs.svg\\",\\n \\"keywords\\": [\\n \\"Monitor\\"\\n ],\\n \\"once\\": true,\\n \\"environments\\": [\\n {\\n \\"name\\": \\"CS/ECS/Cloud/Client\\",\\n \\"enable\\": true,\\n \\"label\\": \\"容器环境\\",\\n \\"description\\": \\"支持容器集群的工作覆盖监控\\",\\n \\"policies\\": {\\n \\"defaultInstall\\": true,\\n \\"targetAddonName\\": \\"cloud-acs-ecs\\",\\n \\"alertDefaultStatus\\": \\"RUNNING\\",\\n \\"protocols\\": [\\n {\\n \\"name\\": \\"Prometheus\\",\\n \\"label\\": \\"Prometheus 协议\\",\\n \\"description\\": \\"使用 Prometheus 协议写入指标数据\\",\\n \\"icon\\": \\"assets/logos/ecs.svg\\\\n\\"\\n }\\n ],\\n \\"metricCheckRule\\": {\\n \\"promQL\\": [\\n \\"up{job=\\\\\\"acs-ecs\\\\\\"}==1\\"\\n ]\\n },\\n \\"needRestartAfterIntegration\\": true,\\n \\"enableServiceAccount\\": true,\\n \\"bindEntity\\": {\\n \\"entityGroupMode\\": true,\\n \\"singleEntityMode\\": true,\\n \\"entityType\\": \\"acs.ecs.instance\\",\\n \\"vpcIdFieldKey\\": \\"vpcId\\"\\n },\\n \\"bindDefaultPolicy\\": true\\n },\\n \\"dependencies\\": {\\n \\"features\\": {\\n \\"key\\": true\\n },\\n \\"services\\": [\\n \\"cmee\\"\\n ],\\n \\"clusterTypes\\": [\\n \\"ManagedKubernetes/Default\\"\\n ]\\n },\\n \\"policyType\\": \\"ECS\\",\\n \\"commonSchemaRefs\\": [\\n {\\n \\"group\\": \\"acs-ecs\\",\\n \\"version\\": \\"0.1.0\\"\\n }\\n ]\\n }\\n ],\\n \\"categories\\": [\\n \\"infrastructure\\"\\n ],\\n \\"dashboards\\": [\\n {\\n \\"name\\": \\"ECS 监控概览大盘\\",\\n \\"url\\": \\"assets/dashboards/ecs.png\\\\n\\",\\n \\"description\\": \\"描述信息\\"\\n }\\n ],\\n \\"weight\\": 1000,\\n \\"latestReleaseCreateTime\\": \\"2025-10-25 09:12:12\\"\\n }\\n }\\n ],\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8\\"\\n}","type":"json"}]', ], - 'DeletePrometheusView' => [ - 'summary' => '删除prometheus视图实例。', - 'path' => '/prometheus-views/{prometheusViewId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'ListIntegrationPolicyCustomScrapeJobRules' => [ + 'path' => '/integration-policies/{policyId}/custom-scrape-job-rules', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'prometheusViewId', + 'name' => 'policyId', 'in' => 'path', - 'schema' => [ - 'description' => 'Prometheus 视图ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rw-xxxxxx', - ], + 'schema' => ['title' => '接入中心策略ID。', 'description' => '接入中心策略ID。', 'type' => 'string', 'required' => true, 'example' => 'policy-d95435164593aece55f9999ce45c'], + ], + [ + 'name' => 'addonReleaseName', + 'in' => 'query', + 'schema' => ['title' => 'Addon Release名称。', 'description' => 'Addon Release名称。', 'type' => 'string', 'required' => false, 'example' => 'release12345678'], + ], + [ + 'name' => 'encryptYaml', + 'in' => 'query', + 'schema' => ['title' => '是否加密Yaml。', 'description' => '是否加密Yaml。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'namespace', + 'in' => 'query', + 'schema' => ['title' => '命名空间。', 'description' => '命名空间。', 'type' => 'string', 'required' => false, 'example' => 'arms-prom'], ], ], 'responses' => [ @@ -16217,86 +14340,121 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', + 'clusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'et15prod-et15storage'], + 'customScrapeJobRules' => [ + 'description' => '自定义采集任务规则', + 'type' => 'array', + 'items' => [ + 'description' => '自定义服务发现规则', + 'type' => 'object', + 'properties' => [ + 'addonName' => ['description' => 'Addon 名称。', 'type' => 'string', 'example' => 'cloud-ecs'], + 'addonReleaseName' => ['description' => 'AddonRelease 名称', 'type' => 'string', 'example' => 'release-12345678'], + 'addonVersion' => ['description' => 'Addon 版本', 'type' => 'string', 'example' => '0.0.1'], + 'configYaml' => ['description' => '配置yaml', 'type' => 'string', 'example' => 'scrape_cofnigs:'."\n" + .'- jobxxxxxx'], + 'enableStatus' => ['description' => '启用状态', 'type' => 'string', 'example' => 'mini'], + 'encryptYaml' => ['description' => '加密yaml', 'type' => 'boolean', 'example' => 'true'], + 'matchedPodCount' => ['description' => '匹配到的pod数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'message' => ['description' => '详细信息。', 'type' => 'string', 'example' => 'ok'], + 'name' => ['description' => '服务名。', 'type' => 'string', 'example' => 'dlab1'], + 'namespace' => ['description' => '命名空间', 'type' => 'string', 'example' => 'prod-data'], + 'scrapeConfigs' => [ + 'description' => '自定义配置', + 'type' => 'array', + 'items' => [ + 'description' => '自定义配置', + 'type' => 'object', + 'properties' => [ + 'jobName' => ['description' => '采集名称', 'type' => 'string', 'example' => 'mysql-exporter'], + 'message' => ['description' => '详细信息。', 'type' => 'string', 'example' => 'successful'], + 'metricsPath' => ['description' => '采集path', 'type' => 'string', 'example' => '/metrics'], + 'scheme' => ['description' => '调用方式。', 'type' => 'string', 'example' => 'http'], + 'scrapeInterval' => ['description' => '采集间隔', 'type' => 'string', 'example' => '30s'], + 'scrapeTimeout' => ['description' => '采集超时时间', 'type' => 'string', 'example' => '60s'], + 'serviceDiscoveryConfigs' => [ + 'description' => '服务发现配置', + 'type' => 'array', + 'items' => ['description' => '服务发现配置', 'type' => 'string', 'example' => '{}'], + ], + ], + ], + ], + ], + ], ], + 'policyId' => ['description' => '策略 ID。', 'type' => 'string', 'example' => 'policy-15abcc24c06f4797832b5954198e1ed1'], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', - 'title' => '删除prometheus视图实例。', - 'description' => '删除prometheus视图实例。', - ], - 'GetPrometheusInstance' => [ - 'summary' => '查询指定Prometheus实例详情信息。', - 'path' => '/prometheus-instances/{prometheusInstanceId}', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取接入中心策略的自定义服务发现规则', + 'summary' => '获取接入中心策略的自定义服务发现规则。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntegrationPolicyCustomScrapeJobRules'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'cms:ListIntegrationPolicyCustomScrapeJobRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'IntegrationPolicy', 'arn' => 'acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#integrationPolicyId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"clusterId\\": \\"et15prod-et15storage\\",\\n \\"customScrapeJobRules\\": [\\n {\\n \\"addonName\\": \\"cloud-ecs\\",\\n \\"addonReleaseName\\": \\"release-12345678\\",\\n \\"addonVersion\\": \\"0.0.1\\",\\n \\"configYaml\\": \\"scrape_cofnigs:\\\\n- jobxxxxxx\\",\\n \\"enableStatus\\": \\"mini\\",\\n \\"encryptYaml\\": true,\\n \\"matchedPodCount\\": 1,\\n \\"message\\": \\"ok\\",\\n \\"name\\": \\"dlab1\\",\\n \\"namespace\\": \\"prod-data\\",\\n \\"scrapeConfigs\\": [\\n {\\n \\"jobName\\": \\"mysql-exporter\\",\\n \\"message\\": \\"successful\\",\\n \\"metricsPath\\": \\"/metrics\\",\\n \\"scheme\\": \\"http\\",\\n \\"scrapeInterval\\": \\"30s\\",\\n \\"scrapeTimeout\\": \\"60s\\",\\n \\"serviceDiscoveryConfigs\\": [\\n \\"{}\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"policyId\\": \\"policy-15abcc24c06f4797832b5954198e1ed1\\",\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', + ], + 'ListIntegrationPolicyDashboards' => [ + 'path' => '/integration-policies/{policyId}/dashboards', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcmsCP2WWY', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'prometheusInstanceId', + 'name' => 'policyId', 'in' => 'path', - 'schema' => [ - 'description' => '实例id。', - 'type' => 'string', - 'required' => true, - 'example' => 'rw-abc123', - ], + 'schema' => ['description' => '策略 ID。', 'type' => 'string', 'required' => true, 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e'], ], [ - 'name' => 'resourceGroupId', + 'name' => 'addonName', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aek2bhocin5e2na', - ], + 'schema' => ['description' => 'Addon 名称。', 'type' => 'string', 'required' => false, 'example' => 'cs-default'], ], [ - 'name' => 'aliyunLang', + 'name' => 'scene', + 'in' => 'query', + 'schema' => ['description' => '组件场景。', 'type' => 'string', 'required' => false, 'example' => 'databse'], + ], + [ + 'name' => 'language', 'in' => 'query', 'schema' => [ - 'title' => '语言环境, 默认为中文 zh | en', - 'description' => '语言环境, 默认为中文 zh | en。', + 'title' => '', + 'description' => '查询语言。', 'type' => 'string', 'required' => false, 'example' => 'zh', 'default' => 'zh', + 'enum' => ['zh', 'en'], ], ], ], @@ -16307,355 +14465,102 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'prometheusInstance' => [ - 'description' => 'Prometheus 实例详情。', - 'type' => 'object', - 'properties' => [ - 'accessType' => [ - 'title' => '权限类型：'."\n" - .'readWrite、readOnly、httpReadOnly', - 'description' => '权限类型：'."\n" - .'readWrite、readOnly、httpReadOnly', - 'type' => 'string', - 'example' => 'readOnly', - ], - 'archiveDuration' => [ - 'title' => '存储到期后，自动归档保存的天数，0表示不归档保存，3650表示永久保存。', - 'description' => '存储到期后，自动归档保存的天数，0表示不归档保存，3650表示永久保存。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '90', - ], - 'authFreeReadPolicy' => [ - 'title' => '读免密地址白名单策略。', - 'description' => '免密读策略（支持IP段和VpcId）。', - 'type' => 'string', - 'example' => '{'."\n" - .' "SourceIp": ['."\n" - .' "192.168.1.0/24",'."\n" - .' "172.168.2.22"'."\n" - .' ],'."\n" - .' "SourceVpc": ['."\n" - .' "vpc-xx1",'."\n" - .' "vpc-xx2"'."\n" - .' ]'."\n" - .'}', - ], - 'authFreeWritePolicy' => [ - 'title' => '写免密地址白名单策略。', - 'description' => '免密写策略（支持IP段和VpcId）。', - 'type' => 'string', - 'example' => '{'."\n" - .' "SourceIp": ['."\n" - .' "192.168.1.0/24",'."\n" - .' "172.168.2.22"'."\n" - .' ],'."\n" - .' "SourceVpc": ['."\n" - .' "vpc-xx1",'."\n" - .' "vpc-xx2"'."\n" - .' ]'."\n" - .'}', - ], - 'authToken' => [ - 'title' => 'authToken串', - 'description' => 'authToken串。', - 'type' => 'string', - 'example' => 'eJwixxxxx', - ], - 'createTime' => [ - 'title' => '实例创建时间，使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ', - 'description' => '实例创建时间，使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ。', - 'type' => 'string', - 'example' => '2025-08-10T02:07:53Z', - ], - 'enableAuthFreeRead' => [ - 'title' => '是否开启读免密。', - 'description' => '是否开启读免密。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'enableAuthFreeWrite' => [ - 'title' => '是否开启写免密。', - 'description' => '是否开启写免密。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'enableAuthToken' => [ - 'description' => '是否开启鉴权Token。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'extraInfo' => [ - 'title' => '扩展信息（仅控制台请求才返回）', - 'description' => '扩展信息。', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '其他扩展信息。', - 'example' => 'value', - ], - ], - 'httpApiInterUrl' => [ - 'description' => 'HTTP 公网地址。', - 'type' => 'string', - 'example' => ' http://workspace-default-cms-xxxxxxx', - ], - 'httpApiIntraUrl' => [ - 'description' => 'HTTP 内网地址。', - 'type' => 'string', - 'example' => ' http://workspace-default-cms-xxxxxxx', - ], - 'instanceType' => [ - 'title' => 'remote-write（Prometheus for Remote Write）', - 'description' => 'Prometheus实例类型。', - 'type' => 'string', - 'example' => 'remote-write', - ], - 'paymentType' => [ - 'title' => '计费方式：'."\n" - .'POSTPAY：按指标上报量后付费。'."\n" - .'POSTPAY_GB：按指标写入量后付费。', - 'description' => '计费方式：'."\n" - .'POSTPAY：按指标上报量后付费。'."\n" - .'POSTPAY_GB：按指标写入量后付费。', - 'type' => 'string', - 'example' => 'POSTPAY', - ], - 'product' => [ - 'title' => 'prom实例归属的产品（arms或cms）', - 'description' => 'prom实例归属的产品（arms或cms）', - 'type' => 'string', - 'example' => 'cms', - ], - 'prometheusInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'rw-524ada714221af267c73122af2e1', - ], - 'prometheusInstanceName' => [ - 'description' => '实例名称。', - 'type' => 'string', - 'example' => 'test-prom-name', - ], - 'pushGatewayInterUrl' => [ - 'description' => 'PushGateway公网地址。', - 'type' => 'string', - 'example' => ' http://workspace-default-cms-xxxxxxx', - ], - 'pushGatewayIntraUrl' => [ - 'description' => 'PushGateway内网地址。', - 'type' => 'string', - 'example' => ' http://workspace-default-cms-xxxxxxx'."\n", - ], - 'regionId' => [ - 'description' => '地域 ID。', - 'type' => 'string', - 'example' => 'cn-heyuan', - ], - 'remoteReadInterUrl' => [ - 'description' => '公网读地址。', - 'type' => 'string', - 'example' => ' http://workspace-default-cms-xxxxxxx', - ], - 'remoteReadIntraUrl' => [ - 'description' => '内网读地址。', - 'type' => 'string', - 'example' => 'https://workspace-default-cms-1xxxxxxxxxx', - ], - 'remoteWriteInterUrl' => [ - 'description' => '公网写地址。', - 'type' => 'string', - 'example' => 'https://workspace-default-cms-xxxxxxxxxx', - ], - 'remoteWriteIntraUrl' => [ - 'description' => '内网写地址。', - 'type' => 'string', - 'example' => 'https://workspace-default-cms-xxxxxxxxxx', - ], - 'resourceGroupId' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'example' => 'rg-acfm3gn5i6bigbi', - ], - 'resourceType' => [ - 'title' => '固定值：PrometheusInstance', - 'description' => '固定值：PrometheusInstance。', - 'type' => 'string', - 'example' => 'Prometheus', - ], - 'status' => [ - 'title' => '后端数据存储状态', - 'description' => '实例状态。', - 'type' => 'string', - 'example' => 'Running', - ], - 'storageDuration' => [ - 'title' => '存储时长（天）。', - 'description' => '存储时长（天）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '90', - ], - 'supportAuthTypes' => [ - 'title' => '支持的认证鉴权类型。', - 'description' => '支持的认证鉴权类型。', - 'type' => 'array', - 'items' => [ - 'description' => '鉴权类型。', - 'type' => 'string', - 'example' => 'BasicAuth', - 'enum' => [ - 'BasicAuth', - 'AuthFree', - 'AuthToken', - ], - ], - ], - 'tags' => [ - 'description' => '标签列表。', - 'type' => 'array', - 'items' => [ - 'description' => '标签。', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => '标签Key。', - 'type' => 'string', - 'example' => 'openStorage', - ], - 'value' => [ - 'description' => '匹配值。', - 'type' => 'string', - 'example' => '130303196111114281', - ], - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5'], + 'total' => ['description' => '组件数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'dashboards' => [ + 'description' => '仪表盘的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '仪表盘的列表。', + 'type' => 'object', + 'properties' => [ + 'uid' => ['description' => '当前阿里云主账号的ID，只读', 'type' => 'string', 'example' => '1258199346721590'], + 'engine' => ['title' => '大盘引擎：'."\n" + .'grafana：共享grafana。'."\n" + .'cms：cms自研大盘引擎。', 'description' => '大盘引擎：'."\n" + .'grafana：共享grafana。'."\n" + .'cms：cms自研大盘引擎。', 'type' => 'string', 'example' => 'grafana'], + 'title' => ['description' => 'UI模块的标题（非name）', 'type' => 'string', 'example' => 'test'], + 'name' => ['title' => '大盘名称', 'description' => '大盘名称', 'type' => 'string', 'example' => 'k8s-pod'], + 'url' => ['description' => 'pagerDuty的集成webhook。支持V1和V2版', 'type' => 'string', 'example' => 'https://agi.alicdn.com/user/0/0_0_5255362686.png?x-oss-process=image/quality,q_75/format,jpg&file=1734574878007.jpg'], + 'region' => ['description' => '地域', 'type' => 'string', 'example' => 'cn-hongkong'], + 'folderUid' => ['description' => '大盘目录UID。', 'type' => 'string', 'example' => 'Env-AAA'], + 'tags' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => ['description' => '标签。', 'type' => 'string', 'example' => 'tag1'], ], ], - 'userId' => [ - 'description' => '用户ID。', - 'type' => 'string', - 'example' => '170731234567', - ], - 'version' => [ - 'title' => '版本', - 'description' => '版本。', - 'type' => 'string', - 'example' => 'V1', - ], - 'workspace' => [ - 'title' => 'prom实例归属的工作空间', - 'description' => 'Prometheus实例归属的工作空间。', - 'type' => 'string', - 'example' => 'ws1', - ], - 'folderUrl' => [ - 'title' => '可视化大盘Url', - 'description' => '可视化大盘目录URL。', - 'type' => 'string', - 'example' => 'https://gnew.console.aliyun.com/dashboards/f/c49a80d2a551d4a20a8c4b996b0be4e52/xxxxxxx', - ], - 'grafanaInstanceId' => [ - 'title' => '绑定的托管grafana实例Id', - 'description' => '绑定的托管grafana实例ID。', - 'type' => 'string', - 'example' => 'SHARED', - ], - 'grafanaInstanceName' => [ - 'title' => '绑定的托管grafana实例名称', - 'description' => '绑定的托管grafana实例名称。', - 'type' => 'string', - 'example' => '共享版', - ], - 'paymentTypeUpdateTime' => [ - 'title' => '实例计费方式修改时间', - 'description' => '实例计费方式修改时间。', - 'type' => 'string', - 'example' => '2025-08-10T02:07:53Z', - ], ], ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求唯一标识。', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询大盘列表', + 'summary' => '查询大盘列表。', + 'description' => '本文将提供一个示例，查询报警模板列表。返回结果显示，报警模板列表中共有2个报警模板，分别是`ECS_Template1`和`ECS_Template2`。', + 'changeSet' => [ + ['createdAt' => '2025-10-20T14:07:48.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-10-16T08:11:30.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2025-10-15T12:10:46.000Z', 'description' => '响应参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusInstance\\": {\\n \\"accessType\\": \\"readOnly\\",\\n \\"archiveDuration\\": 90,\\n \\"authFreeReadPolicy\\": \\"{\\\\n \\\\\\"SourceIp\\\\\\": [\\\\n \\\\\\"192.168.1.0/24\\\\\\",\\\\n \\\\\\"172.168.2.22\\\\\\"\\\\n ],\\\\n \\\\\\"SourceVpc\\\\\\": [\\\\n \\\\\\"vpc-xx1\\\\\\",\\\\n \\\\\\"vpc-xx2\\\\\\"\\\\n ]\\\\n}\\",\\n \\"authFreeWritePolicy\\": \\"{\\\\n \\\\\\"SourceIp\\\\\\": [\\\\n \\\\\\"192.168.1.0/24\\\\\\",\\\\n \\\\\\"172.168.2.22\\\\\\"\\\\n ],\\\\n \\\\\\"SourceVpc\\\\\\": [\\\\n \\\\\\"vpc-xx1\\\\\\",\\\\n \\\\\\"vpc-xx2\\\\\\"\\\\n ]\\\\n}\\",\\n \\"authToken\\": \\"eJwixxxxx\\",\\n \\"createTime\\": \\"2025-08-10T02:07:53Z\\",\\n \\"enableAuthFreeRead\\": true,\\n \\"enableAuthFreeWrite\\": true,\\n \\"enableAuthToken\\": true,\\n \\"extraInfo\\": {\\n \\"key\\": \\"value\\"\\n },\\n \\"httpApiInterUrl\\": \\" http://workspace-default-cms-xxxxxxx\\",\\n \\"httpApiIntraUrl\\": \\" http://workspace-default-cms-xxxxxxx\\",\\n \\"instanceType\\": \\"remote-write\\",\\n \\"paymentType\\": \\"POSTPAY\\",\\n \\"product\\": \\"cms\\",\\n \\"prometheusInstanceId\\": \\"rw-524ada714221af267c73122af2e1\\",\\n \\"prometheusInstanceName\\": \\"test-prom-name\\",\\n \\"pushGatewayInterUrl\\": \\" http://workspace-default-cms-xxxxxxx\\",\\n \\"pushGatewayIntraUrl\\": \\" http://workspace-default-cms-xxxxxxx\\\\n\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"remoteReadInterUrl\\": \\" http://workspace-default-cms-xxxxxxx\\",\\n \\"remoteReadIntraUrl\\": \\"https://workspace-default-cms-1xxxxxxxxxx\\",\\n \\"remoteWriteInterUrl\\": \\"https://workspace-default-cms-xxxxxxxxxx\\",\\n \\"remoteWriteIntraUrl\\": \\"https://workspace-default-cms-xxxxxxxxxx\\",\\n \\"resourceGroupId\\": \\"rg-acfm3gn5i6bigbi\\",\\n \\"resourceType\\": \\"Prometheus\\",\\n \\"status\\": \\"Running\\",\\n \\"storageDuration\\": 90,\\n \\"supportAuthTypes\\": [\\n \\"BasicAuth\\"\\n ],\\n \\"tags\\": [\\n {\\n \\"key\\": \\"openStorage\\",\\n \\"value\\": \\"130303196111114281\\"\\n }\\n ],\\n \\"userId\\": \\"170731234567\\",\\n \\"version\\": \\"V1\\",\\n \\"workspace\\": \\"ws1\\",\\n \\"folderUrl\\": \\"https://gnew.console.aliyun.com/dashboards/f/c49a80d2a551d4a20a8c4b996b0be4e52/xxxxxxx\\",\\n \\"grafanaInstanceId\\": \\"SHARED\\",\\n \\"grafanaInstanceName\\": \\"共享版\\",\\n \\"paymentTypeUpdateTime\\": \\"2025-08-10T02:07:53Z\\"\\n },\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', - 'title' => '获取Prometheus实例详细信息', - 'description' => '获取Prometheus实例详情。', - ], - 'GetPrometheusView' => [ - 'summary' => '查询指定Prometheus视图实例详情。', - 'path' => '/prometheus-views/{prometheusViewId}', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntegrationPolicyDashboards'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'cms:ListIntegrationPolicyDashboards', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'integrationPolicy', 'arn' => 'acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#integrationPolicyId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CD8BA7D6-995D-578D-9941-78B0FECD14B5\\",\\n \\"total\\": 1,\\n \\"dashboards\\": [\\n {\\n \\"uid\\": \\"1258199346721590\\",\\n \\"engine\\": \\"grafana\\",\\n \\"title\\": \\"test\\",\\n \\"name\\": \\"k8s-pod\\",\\n \\"url\\": \\"https://agi.alicdn.com/user/0/0_0_5255362686.png?x-oss-process=image/quality,q_75/format,jpg&file=1734574878007.jpg\\",\\n \\"region\\": \\"cn-hongkong\\",\\n \\"folderUid\\": \\"Env-AAA\\",\\n \\"tags\\": [\\n \\"tag1\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListIntegrationPolicyPodMonitors' => [ + 'path' => '/integration-policies/{policyId}/pod-monitors', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcmsCP2WWY', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'prometheusViewId', + 'name' => 'policyId', 'in' => 'path', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rw-xxxxxx', - ], + 'schema' => ['title' => '接入中心策略ID。', 'description' => '接入中心策略ID。', 'type' => 'string', 'required' => true, 'example' => 'policy-1d4634924c8ba599822c601fcee3'], ], [ - 'name' => 'resourceGroupId', + 'name' => 'addonReleaseName', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aek2bhocin5e2na', - ], + 'schema' => ['title' => 'Addon Release名称。', 'description' => 'Addon Release名称。', 'type' => 'string', 'required' => false, 'example' => 'release-123456789'], ], [ - 'name' => 'aliyunLang', + 'name' => 'namespace', 'in' => 'query', - 'schema' => [ - 'title' => '语言环境, 默认为中文 zh | en', - 'description' => '语言环境, 默认为中文 zh | en。', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - 'default' => 'zh', - ], + 'schema' => ['title' => '命名空间。', 'description' => '命名空间。', 'type' => 'string', 'required' => false, 'example' => 'default'], + ], + [ + 'name' => 'encryptYaml', + 'in' => 'query', + 'schema' => ['title' => '是否加密Yaml。', 'description' => '是否加密Yaml。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ @@ -16665,293 +14570,107 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'prometheusView' => [ - 'description' => '视图实例。', - 'type' => 'object', - 'properties' => [ - 'authFreeReadPolicy' => [ - 'title' => '读免密地址白名单策略。', - 'description' => '免密读策略（支持IP段和VpcId）。', - 'type' => 'string', - 'example' => '{'."\n" - .' "SourceIp": ['."\n" - .' "192.168.1.0/24",'."\n" - .' "172.168.2.22"'."\n" - .' ],'."\n" - .' "SourceVpc": ['."\n" - .' "vpc-xx1",'."\n" - .' "vpc-xx2"'."\n" - .' ]'."\n" - .'}', - ], - 'authToken' => [ - 'title' => 'authToken串', - 'description' => 'authToken串。', - 'type' => 'string', - 'example' => 'eJxxxxxx', - ], - 'createTime' => [ - 'title' => '实例创建时间，使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ', - 'description' => '实例创建时间，使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ。', - 'type' => 'string', - 'example' => '2025-08-10T02:07:53Z', - ], - 'enableAuthFreeRead' => [ - 'title' => '是否开启读免密。', - 'description' => '是否开启读免密。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'enableAuthToken' => [ - 'title' => '是否开启authToken。', - 'description' => '是否开启authToken。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'httpApiInterUrl' => [ - 'description' => '公网HTTP地址。', - 'type' => 'string', - 'example' => 'http://xxxxxxxx', - ], - 'httpApiIntraUrl' => [ - 'description' => '内网HTTP地址。', - 'type' => 'string', - 'example' => 'http://xxxxxxxx', - ], - 'instanceType' => [ - 'title' => '实例类型：'."\n" - .'prom-view：新版本聚合视图'."\n" - .'global-view：老版本聚合视图', - 'description' => '实例类型，固定值prom-view。', - 'type' => 'string', - 'example' => 'prom-view', - ], - 'paymentType' => [ - 'title' => '付费类型。目前固定值FREE（免费）。', - 'description' => '付费类型。目前固定值FREE（免费）。', - 'type' => 'string', - 'example' => 'FREE', - ], - 'product' => [ - 'title' => 'prom实例归属的产品（arms或cms）', - 'description' => 'prom实例归属的产品。', - 'type' => 'string', - 'example' => 'cms', - ], - 'prometheusInstances' => [ - 'description' => 'Prometheus 实例列表。', - 'type' => 'array', - 'items' => [ - 'description' => 'Prometheus 实例列表。', - 'type' => 'object', - 'properties' => [ - 'prometheusInstanceId' => [ - 'description' => '实例id。', - 'type' => 'string', - 'example' => 'rw-63549e054ff596a4149927961dff', - ], - 'regionId' => [ - 'description' => '地域 ID', - 'type' => 'string', - 'example' => 'cn-north-2-gov-1', - ], - 'userId' => [ - 'description' => '用户ID。', - 'type' => 'string', - 'example' => '122xxxxx', - ], - ], - ], - ], - 'prometheusViewId' => [ - 'description' => 'Prometheus视图ID。', - 'type' => 'string', - 'example' => 'view-xxx', - ], - 'prometheusViewName' => [ - 'description' => 'Prometheus 视图名称。', - 'type' => 'string', - 'example' => 'view1', - ], - 'regionId' => [ - 'description' => '地域 ID', - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'remoteReadInterUrl' => [ - 'description' => 'remote read公网URL。', - 'type' => 'string', - 'example' => 'http://workspace-default-cms-xxx-cn-hangzhou.cn-hangzhou.log.aliyuncs.com/prometheus/workspace-default-cms-xxx-cn-hangzhou/xxx/api/v1/read', - ], - 'remoteReadIntraUrl' => [ - 'description' => 'remote read内网URL。', - 'type' => 'string', - 'example' => 'http://workspace-default-cms-xxx-cn-hangzhou.cn-hangzhou-intranet.log.aliyuncs.com/prometheus/workspace-default-cms-xxx-cn-hangzhou/xxx/api/v1/read', - ], - 'resourceGroupId' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'example' => 'rg-acfm3gn5i6bigbi', - ], - 'resourceType' => [ - 'title' => '固定值：PrometheusView', - 'description' => '固定值：PrometheusView', - 'type' => 'string', - 'example' => 'RegistryModule', - ], - 'status' => [ - 'title' => '后端数据存储状态', - 'description' => '后端数据存储状态', - 'type' => 'string', - 'example' => 'Pending2Running', - ], - 'supportAuthTypes' => [ - 'description' => '支持的认证类型。', - 'type' => 'array', - 'items' => [ - 'description' => '支持的认证类型。', - 'type' => 'string', - 'example' => 'BasicAuth', - ], - ], - 'tags' => [ - 'description' => '实例的标签键。', - 'type' => 'array', - 'items' => [ - 'description' => '标签。', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => 'pagerDuty的集成key。', - 'type' => 'string', - 'example' => 'global_score_series', - ], - 'value' => [ - 'description' => '标签Value。', - 'type' => 'string', - 'example' => '371293199010092839', + 'clusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'et15prod-et15storage'], + 'podMonitors' => [ + 'description' => 'PodMontior列表', + 'type' => 'array', + 'items' => [ + 'description' => 'PodMontior列表', + 'type' => 'object', + 'properties' => [ + 'addonName' => ['description' => 'Addon 名称。', 'type' => 'string', 'example' => 'cloud-ecs'], + 'addonReleaseName' => ['description' => 'AddonRelease名称。', 'type' => 'string', 'example' => 'release-2345678'], + 'addonVersion' => ['description' => 'Addon版本。', 'type' => 'string', 'example' => '0.0.1'], + 'configYaml' => ['description' => '配置yaml。', 'type' => 'string', 'example' => 'apiVersion: xxxxx'], + 'enableStatus' => ['description' => '启用状态。', 'type' => 'string', 'example' => 'run'], + 'encryptYaml' => ['description' => '加密yaml。', 'type' => 'boolean', 'example' => 'YXBpVmVyc2lvbjogeHh4eHgK'], + 'endpoints' => [ + 'description' => '实例的接入点。', + 'type' => 'array', + 'items' => [ + 'description' => 'Endpoint详情', + 'type' => 'object', + 'properties' => [ + 'interval' => ['description' => '采集间隔', 'type' => 'string', 'example' => '30s'], + 'matchedTargetCount' => ['description' => '匹配的target数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'path' => ['description' => '指标采集路径', 'type' => 'string', 'example' => '/metrics'], + 'port' => ['description' => '端口号', 'type' => 'string', 'example' => '9100'], + 'targetPort' => ['description' => '目标端口', 'type' => 'string', 'example' => 'https'], ], ], ], - ], - 'userId' => [ - 'description' => '用户ID。', - 'type' => 'string', - 'example' => '11222', - ], - 'version' => [ - 'title' => '版本', - 'description' => '版本。', - 'type' => 'string', - 'example' => 'V1', - ], - 'workspace' => [ - 'title' => '环境归属的工作空间', - 'description' => '环境归属的工作空间', - 'type' => 'string', - 'example' => 'cms-monitor-test-aysls-pub-cn-fuzhou-monitor', - ], - 'folderUrl' => [ - 'title' => '可观测大盘Url', - 'description' => '可观测大盘URL。', - 'type' => 'string', - 'example' => 'https://xxxx', - ], - 'grafanaInstanceId' => [ - 'title' => '绑定的托管grafana实例Id', - 'description' => '绑定的托管grafana实例ID。', - 'type' => 'string', - 'example' => 'g-xxx ', - ], - 'grafanaInstanceName' => [ - 'title' => '绑定的托管grafana实例名称', - 'description' => '绑定的托管grafana实例名称。', - 'type' => 'string', - 'example' => 'gxxx', + 'matchedPodCount' => ['description' => '匹配pod的数量', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'name' => ['description' => '采集名称。', 'type' => 'string', 'example' => 'znzmo_entity_test'], + 'namespace' => ['description' => '命名空间', 'type' => 'string', 'example' => 'sla-ns-d5aeb2b4f91b47'], ], ], ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8', - ], + 'policyId' => ['description' => '策略 ID。', 'type' => 'string', 'example' => 'policy-c9efed2b99c348d49e589c5f780fc074'], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusView\\": {\\n \\"authFreeReadPolicy\\": \\"{\\\\n \\\\\\"SourceIp\\\\\\": [\\\\n \\\\\\"192.168.1.0/24\\\\\\",\\\\n \\\\\\"172.168.2.22\\\\\\"\\\\n ],\\\\n \\\\\\"SourceVpc\\\\\\": [\\\\n \\\\\\"vpc-xx1\\\\\\",\\\\n \\\\\\"vpc-xx2\\\\\\"\\\\n ]\\\\n}\\",\\n \\"authToken\\": \\"eJxxxxxx\\",\\n \\"createTime\\": \\"2025-08-10T02:07:53Z\\",\\n \\"enableAuthFreeRead\\": true,\\n \\"enableAuthToken\\": true,\\n \\"httpApiInterUrl\\": \\"http://xxxxxxxx\\",\\n \\"httpApiIntraUrl\\": \\"http://xxxxxxxx\\",\\n \\"instanceType\\": \\"prom-view\\",\\n \\"paymentType\\": \\"FREE\\",\\n \\"product\\": \\"cms\\",\\n \\"prometheusInstances\\": [\\n {\\n \\"prometheusInstanceId\\": \\"rw-63549e054ff596a4149927961dff\\",\\n \\"regionId\\": \\"cn-north-2-gov-1\\",\\n \\"userId\\": \\"122xxxxx\\"\\n }\\n ],\\n \\"prometheusViewId\\": \\"view-xxx\\",\\n \\"prometheusViewName\\": \\"view1\\",\\n \\"regionId\\": \\"cn-shanghai\\",\\n \\"remoteReadInterUrl\\": \\"http://workspace-default-cms-xxx-cn-hangzhou.cn-hangzhou.log.aliyuncs.com/prometheus/workspace-default-cms-xxx-cn-hangzhou/xxx/api/v1/read\\",\\n \\"remoteReadIntraUrl\\": \\"http://workspace-default-cms-xxx-cn-hangzhou.cn-hangzhou-intranet.log.aliyuncs.com/prometheus/workspace-default-cms-xxx-cn-hangzhou/xxx/api/v1/read\\",\\n \\"resourceGroupId\\": \\"rg-acfm3gn5i6bigbi\\",\\n \\"resourceType\\": \\"RegistryModule\\",\\n \\"status\\": \\"Pending2Running\\",\\n \\"supportAuthTypes\\": [\\n \\"BasicAuth\\"\\n ],\\n \\"tags\\": [\\n {\\n \\"key\\": \\"global_score_series\\",\\n \\"value\\": \\"371293199010092839\\"\\n }\\n ],\\n \\"userId\\": \\"11222\\",\\n \\"version\\": \\"V1\\",\\n \\"workspace\\": \\"cms-monitor-test-aysls-pub-cn-fuzhou-monitor\\",\\n \\"folderUrl\\": \\"https://xxxx\\",\\n \\"grafanaInstanceId\\": \\"g-xxx \\",\\n \\"grafanaInstanceName\\": \\"gxxx\\"\\n },\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8\\"\\n}","type":"json"}]', - 'title' => '查询指定Prometheus视图实例详情。', - 'description' => '查询指定Prometheus视图实例。', - ], - 'ListPrometheusDashboards' => [ - 'summary' => '获取Prometheus实例大盘列表。', - 'path' => '/prometheus-instances/{prometheusInstanceId}/dashboards', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询接入中心策略的PodMonitor资源', + 'summary' => '获取接入中心策略的PodMonitor资源。', + 'description' => '本文将提供一个示例，查询报警模板列表。返回结果显示，报警模板列表中共有2个报警模板，分别是`ECS_Template1`和`ECS_Template2`。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntegrationPolicyPodMonitors'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'cms:ListIntegrationPolicyPodMonitors', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'IntegrationPolicy', 'arn' => 'acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#integrationPolicyId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"clusterId\\": \\"et15prod-et15storage\\",\\n \\"podMonitors\\": [\\n {\\n \\"addonName\\": \\"cloud-ecs\\",\\n \\"addonReleaseName\\": \\"release-2345678\\",\\n \\"addonVersion\\": \\"0.0.1\\",\\n \\"configYaml\\": \\"apiVersion: xxxxx\\",\\n \\"enableStatus\\": \\"run\\",\\n \\"encryptYaml\\": true,\\n \\"endpoints\\": [\\n {\\n \\"interval\\": \\"30s\\",\\n \\"matchedTargetCount\\": 1,\\n \\"path\\": \\"/metrics\\",\\n \\"port\\": \\"9100\\",\\n \\"targetPort\\": \\"https\\"\\n }\\n ],\\n \\"matchedPodCount\\": 3,\\n \\"name\\": \\"znzmo_entity_test\\",\\n \\"namespace\\": \\"sla-ns-d5aeb2b4f91b47\\"\\n }\\n ],\\n \\"policyId\\": \\"policy-c9efed2b99c348d49e589c5f780fc074\\",\\n \\"requestId\\": \\"CD8BA7D6-995D-578D-9941-78B0FECD14B5\\"\\n}","type":"json"}]', + ], + 'ListIntegrationPolicyServiceMonitors' => [ + 'path' => '/integration-policies/{policyId}/service-monitors', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'prometheusInstanceId', + 'name' => 'policyId', 'in' => 'path', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '实例id', - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => 'rw-abc123', - ], + 'schema' => ['title' => '接入中心策略ID。', 'description' => '接入中心策略ID。', 'type' => 'string', 'required' => true, 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e'], ], [ - 'name' => 'resourceGroupId', + 'name' => 'addonReleaseName', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfm3gn5i6bigbi', - ], + 'schema' => ['title' => 'Addon Release名称。', 'description' => 'Addon Release名称。', 'type' => 'string', 'required' => false, 'example' => 'release-12345678'], ], [ - 'name' => 'aliyunLang', + 'name' => 'namespace', 'in' => 'query', - 'schema' => [ - 'title' => '语言环境, 默认为中文 zh | en', - 'description' => '语言环境, 默认为中文 zh | en', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - 'default' => 'zh', - ], + 'schema' => ['title' => '命名空间。', 'description' => '命名空间。', 'type' => 'string', 'required' => false, 'example' => 'arms-prom'], + ], + [ + 'name' => 'encryptYaml', + 'in' => 'query', + 'schema' => ['title' => '是否加密Yaml。', 'description' => '是否加密Yaml。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ @@ -16961,413 +14680,420 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'prometheusDashboards' => [ - 'description' => 'Prometheus实例大盘列表。', + 'clusterId' => ['description' => '集群ID.', 'type' => 'string', 'example' => 'ea119prod-ea119blinkcptssd1'], + 'policyId' => ['description' => '策略 ID。', 'type' => 'string', 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e'], + 'serviceMonitors' => [ + 'description' => 'ServiceMonitor列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'id' => [ - 'title' => '', - 'description' => '大盘ID。', - 'type' => 'string', - 'example' => '1', - ], - 'uid' => [ - 'title' => '', - 'description' => '大盘UID。', - 'type' => 'string', - 'example' => '1987395500251724', - ], - 'name' => [ - 'title' => '', - 'description' => '大盘名称。', - 'type' => 'string', - 'example' => 'pod', - ], - 'title' => [ - 'title' => '', - 'description' => '大盘标题。', - 'type' => 'string', - 'example' => 'ceshi', - ], - 'url' => [ - 'title' => '', - 'description' => '大盘URL地址。', - 'type' => 'string', - 'example' => 'https://gnew.console.aliyun.com/d/xxx-17460385-807-7-6/cs-cost-application', - ], - 'tags' => [ - 'description' => '标签。', + 'addonName' => ['description' => 'Addon 名称。', 'type' => 'string', 'example' => 'cloud-acs-ecs'], + 'addonReleaseName' => ['description' => 'AddonRelease名称', 'type' => 'string', 'example' => 'release-1234567'], + 'addonVersion' => ['description' => 'Addon版本', 'type' => 'string', 'example' => '0.0.1'], + 'configYaml' => ['description' => '配置yaml', 'type' => 'string', 'example' => 'apiVersion: xxxxx'], + 'enableStatus' => ['description' => '启用状态', 'type' => 'string', 'example' => 'run'], + 'encryptYaml' => ['description' => '加密yaml', 'type' => 'boolean', 'example' => 'YXBpVmVyc2lvbjogeHh4eHgK'], + 'endpoints' => [ + 'description' => 'Endpoint列表。', 'type' => 'array', 'items' => [ - 'description' => '标签值。', - 'type' => 'string', - 'example' => '[{\\"tagName\\":\\"key1\\",\\"tagDefinePrompt\\":\\"value1\\"}]', + 'description' => 'Endpoint列表', + 'type' => 'object', + 'properties' => [ + 'interval' => ['description' => '采集时间', 'type' => 'string', 'example' => '30s'], + 'matchedTargetCount' => ['description' => '匹配的target数量', 'type' => 'integer', 'format' => 'int64', 'example' => '65'], + 'path' => ['description' => '采集路径', 'type' => 'string', 'example' => '/metrics'], + 'port' => ['description' => '采集端口', 'type' => 'string', 'example' => '9100'], + 'targetPort' => ['description' => '目标端口', 'type' => 'string', 'example' => 'http'], + ], ], ], + 'matchedServiceCount' => ['description' => '匹配service的数量', 'type' => 'integer', 'format' => 'int64', 'example' => '50'], + 'name' => ['description' => 'ServiceMonitor名称。', 'type' => 'string', 'example' => '62a526c5-f6ca-4cfb-b5a4-b76974cffe51'], + 'namespace' => ['description' => '项目空间名称。', 'type' => 'string', 'example' => 'arms-prom'], ], + 'description' => '', ], ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], - 'totalCount' => [ - 'title' => '总实例数', - 'description' => '总实例数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '66', - ], + 'requestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取接入中心策略的ServiceMonitor信息', + 'summary' => '获取接入中心策略的ServiceMonitor信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusDashboards\\": [\\n {\\n \\"id\\": \\"1\\",\\n \\"uid\\": \\"1987395500251724\\",\\n \\"name\\": \\"pod\\",\\n \\"title\\": \\"ceshi\\",\\n \\"url\\": \\"https://gnew.console.aliyun.com/d/xxx-17460385-807-7-6/cs-cost-application\\",\\n \\"tags\\": [\\n \\"[{\\\\\\\\\\\\\\"tagName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"key1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tagDefinePrompt\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"value1\\\\\\\\\\\\\\"}]\\"\\n ]\\n }\\n ],\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"totalCount\\": 66\\n}","type":"json"}]', - 'title' => '获取Prometheus实例大盘列表', - 'description' => '获取Prometheus实例大盘列表。', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"clusterId\\": \\"ea119prod-ea119blinkcptssd1\\",\\n \\"policyId\\": \\"policy-ac38a7cb02d14ff48bc9f97d0a75063e\\",\\n \\"serviceMonitors\\": [\\n {\\n \\"addonName\\": \\"cloud-acs-ecs\\",\\n \\"addonReleaseName\\": \\"release-1234567\\",\\n \\"addonVersion\\": \\"0.0.1\\",\\n \\"configYaml\\": \\"apiVersion: xxxxx\\",\\n \\"enableStatus\\": \\"run\\",\\n \\"encryptYaml\\": true,\\n \\"endpoints\\": [\\n {\\n \\"interval\\": \\"30s\\",\\n \\"matchedTargetCount\\": 65,\\n \\"path\\": \\"/metrics\\",\\n \\"port\\": \\"9100\\",\\n \\"targetPort\\": \\"http\\"\\n }\\n ],\\n \\"matchedServiceCount\\": 50,\\n \\"name\\": \\"62a526c5-f6ca-4cfb-b5a4-b76974cffe51\\",\\n \\"namespace\\": \\"arms-prom\\"\\n }\\n ],\\n \\"requestId\\": \\"CD8BA7D6-995D-578D-9941-78B0FECD14B5\\"\\n}","type":"json"}]', ], - 'UpdatePrometheusView' => [ - 'summary' => '更新Prometheus视图实例信息。', - 'path' => '/prometheus-views/{prometheusViewId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'ListIntegrationPolicyStorageRequirements' => [ + 'summary' => '获取接入中心策略的存储要求信息', + 'path' => '/integration-policies/{policyId}/storage-requirements', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'prometheusViewId', + 'name' => 'policyId', 'in' => 'path', - 'schema' => [ - 'description' => 'Prometheus 视图实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rw-xxxxxxxx', - ], + 'schema' => ['title' => '接入中心策略ID', 'description' => '接入中心策略ID', 'type' => 'string', 'required' => true, 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'addonName', + 'in' => 'query', + 'schema' => ['title' => 'Addon名称，如mysql。', 'description' => 'Addon Release名称', 'type' => 'string', 'required' => false, 'example' => 'release-1234357'], + ], + [ + 'name' => 'storageType', + 'in' => 'query', + 'schema' => ['title' => '存储类型', 'description' => '存储类型，LogStore/Prometheus/TraceStore/EventStore/EntityStore。', 'type' => 'string', 'required' => false, 'example' => 'LogStore'], + ], + [ + 'name' => 'addonReleaseName', + 'in' => 'query', + 'schema' => ['title' => 'AddonRelease的名称。', 'description' => 'AddonRelease的名称', 'type' => 'string', 'required' => false, 'example' => 'kafka-17201012937917'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '请求体。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'authFreeReadPolicy' => [ - 'description' => '免密读策略（支持IP段和VpcId）。', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "SourceIp": ['."\n" - .' "192.168.1.0/24",'."\n" - .' "172.168.2.22"'."\n" - .' ],'."\n" - .' "SourceVpc": ['."\n" - .' "vpc-xx1",'."\n" - .' "vpc-xx2"'."\n" - .' ]'."\n" - .'}', - ], - 'enableAuthFreeRead' => [ - 'title' => '是否支持免密读', - 'description' => '是否支持免密读。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'enableAuthToken' => [ - 'title' => '是否支持authToken', - 'description' => '是否支持authToken。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'prometheusInstances' => [ - 'description' => 'Prometheus 实例列表。', + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0'], + 'storageRequirements' => [ + 'description' => '存储需求列表', 'type' => 'array', 'items' => [ - 'description' => 'Prometheus 实例列表。', 'type' => 'object', 'properties' => [ - 'prometheusInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'c7ba84651c71e442c8d0653085d862164', + 'apiVersion' => ['description' => '版本号', 'type' => 'string', 'example' => 'v1'], + 'kind' => ['description' => '资源kind', 'type' => 'string', 'example' => 'Pod'], + 'metadata' => [ + 'description' => '元数据', + 'type' => 'object', + 'properties' => [ + 'annotations' => [ + 'description' => '注释', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '注释', 'example' => 'prometheus.io/path'], + ], + 'labels' => [ + 'description' => '资源标签', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '资源标签', 'example' => 'key=value'], + ], + 'name' => ['description' => '资源名称', 'type' => 'string', 'example' => 'pod-1234567'], + 'namespace' => ['description' => '命名空间', 'type' => 'string', 'example' => 'arms-prom'], + ], ], - 'regionId' => [ - 'description' => '地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-north-2-gov-1', + 'spec' => [ + 'description' => '资源的spec', + 'type' => 'object', + 'properties' => [ + 'entityId' => ['description' => '实例ID，如需精确到实例级别，则可以指定。依赖于 EntityStore 中的数据。', 'type' => 'string', 'example' => 'es-xxxxx'], + 'instance' => ['description' => 'Prom实例ID。', 'type' => 'string', 'example' => 'i-bp122p85gthbniw8rsu9'], + 'instanceName' => ['description' => 'Prom实例名称', 'type' => 'string', 'example' => 'category_predict'], + 'project' => ['description' => '可选参数，根据当前环境类型情况判断 Project', 'type' => 'string', 'example' => 'datagrid_cdm'], + 'region' => ['description' => '地域', 'type' => 'string', 'example' => 'cn-shenzhen'], + 'shareScope' => ['description' => '存储共享的范围 Environment | Region | Workspace | Custom', 'type' => 'string', 'example' => 'Region'], + 'storageType' => ['description' => '实例存储类型', 'type' => 'string', 'example' => 'Prometheus'], + 'systemTags' => [ + 'description' => '需要打到目标存储上的标签（以系统标签的方式注入）', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => 'system-key=value', 'description' => '需要打到目标存储上的标签（以系统标签的方式注入）'], + ], + 'tags' => [ + 'description' => '需要打到目标存储上的标签（以普通标签的方式注入）', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => 'key=value', 'description' => '需要打到目标存储上的标签（以普通标签的方式注入）'], + ], + 'userId' => ['description' => '用户ID', 'type' => 'string', 'example' => '12345678'], + 'workspace' => ['description' => '工作空间。', 'type' => 'string', 'example' => 'test-api'], + ], ], - 'userId' => [ - 'description' => '用户ID。', - 'type' => 'string', - 'required' => false, - 'example' => '16727123456789', + 'status' => [ + 'description' => '存储需求状态。', + 'type' => 'object', + 'properties' => [ + 'instanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'rmq-cn-uqm3ket1t0u'], + 'interUrl' => ['description' => '内部url', 'type' => 'string', 'example' => 'http://192.168.xxxxxx'], + 'intraUrl' => ['description' => '外部url', 'type' => 'string', 'example' => 'http://100.100.xxxxxx'], + 'name' => ['description' => '存储需求名称', 'type' => 'string', 'example' => 'sr-xxxx'], + 'project' => ['description' => '存储需求项目', 'type' => 'string', 'example' => 'jiuwu_algo'], + 'promMetricStore' => ['description' => 'Prom的指标中心', 'type' => 'string', 'example' => 'xxxx'], + 'region' => ['description' => '地域', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'storageType' => ['description' => '实例存储类型', 'type' => 'string', 'example' => 'Prometheus'], + 'workspace' => ['description' => '工作空间。', 'type' => 'string', 'example' => 'default'], + ], + ], + 'addonReleaseNames' => [ + 'description' => 'AddonRelease的集合。', + 'type' => 'array', + 'items' => ['description' => 'AddonRelease的名称。', 'type' => 'string', 'example' => 'kafka-17201238912'], ], ], - 'required' => false, + 'description' => '', ], - 'required' => false, - ], - 'prometheusViewName' => [ - 'description' => 'Prometheus 视图名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test-prom-view-name', - ], - 'status' => [ - 'description' => '运行状态。', - 'type' => 'string', - 'required' => false, - 'example' => 'Running', - ], - 'workspace' => [ - 'title' => '归属的工作空间。', - 'description' => '归属的工作空间。', - 'type' => 'string', - 'required' => false, - 'example' => 'default-cms-108490012345-cn-heyuan', ], ], - 'required' => false, ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取接入中心策略的存储要求信息', + 'description' => '在策略的生效期间内，应用分组内发生的所有报警都不再发送通知。'."\n" + .' '."\n" + .'本文将提供一个示例，为应用分组`7301****`创建暂停报警通知策略`PauseNotify`，该应用分组将在`1622949300000`至`1623208500000`（北京时间`2021-06-06 11:15:00`至`2021-06-09 11:15:00`）期间暂停报警。 ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntegrationPolicyStorageRequirements'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'cms:ListIntegrationPolicyStorageRequirements', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'IntegrationPolicy', 'arn' => 'acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#integrationPolicyId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\",\\n \\"storageRequirements\\": [\\n {\\n \\"apiVersion\\": \\"v1\\",\\n \\"kind\\": \\"Pod\\",\\n \\"metadata\\": {\\n \\"annotations\\": {\\n \\"key\\": \\"prometheus.io/path\\"\\n },\\n \\"labels\\": {\\n \\"key\\": \\"key=value\\"\\n },\\n \\"name\\": \\"pod-1234567\\",\\n \\"namespace\\": \\"arms-prom\\"\\n },\\n \\"spec\\": {\\n \\"entityId\\": \\"es-xxxxx\\",\\n \\"instance\\": \\"i-bp122p85gthbniw8rsu9\\",\\n \\"instanceName\\": \\"category_predict\\",\\n \\"project\\": \\"datagrid_cdm\\",\\n \\"region\\": \\"cn-shenzhen\\",\\n \\"shareScope\\": \\"Region\\",\\n \\"storageType\\": \\"Prometheus\\",\\n \\"systemTags\\": {\\n \\"key\\": \\"system-key=value\\"\\n },\\n \\"tags\\": {\\n \\"key\\": \\"key=value\\"\\n },\\n \\"userId\\": \\"12345678\\",\\n \\"workspace\\": \\"test-api\\"\\n },\\n \\"status\\": {\\n \\"instanceId\\": \\"rmq-cn-uqm3ket1t0u\\",\\n \\"interUrl\\": \\"http://192.168.xxxxxx\\",\\n \\"intraUrl\\": \\"http://100.100.xxxxxx\\",\\n \\"name\\": \\"sr-xxxx\\",\\n \\"project\\": \\"jiuwu_algo\\",\\n \\"promMetricStore\\": \\"xxxx\\",\\n \\"region\\": \\"cn-hangzhou\\",\\n \\"storageType\\": \\"Prometheus\\",\\n \\"workspace\\": \\"default\\"\\n },\\n \\"addonReleaseNames\\": [\\n \\"kafka-17201238912\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListMemoryStores' => [ + 'path' => '/workspace/{workspace}/memorystore', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'maxLength' => 64, 'minLength' => 2], + ], + [ + 'name' => 'memoryStoreName', + 'in' => 'query', + 'schema' => ['description' => '记忆库名称', 'type' => 'string', 'required' => false, 'example' => 'qianyi_test_1'], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => '最大返回结果数，最大值200', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => '分页 Token', 'type' => 'string', 'required' => false, 'example' => 'xxxxxxxxx'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '响应数据', 'type' => 'object', 'properties' => [ - 'prometheusViewId' => [ - 'title' => '操作结果', - 'description' => 'Prometheus 视图实例ID。', - 'type' => 'string', - 'example' => 'rw-xxxxxx', - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '64D964F5-76C7-19A2-9399-457744AB3619', + 'maxResults' => ['description' => '最大返回数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'nextToken' => ['description' => '分页 Token', 'type' => 'string', 'example' => 'xxxxxxxxxx'], + 'requestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '16C0A6D6-C3E7-511D-A60B-A87FD85F5BA7'], + 'total' => ['type' => 'integer', 'format' => 'int32'], + 'memoryStores' => [ + 'description' => '记忆库列表', + 'type' => 'array', + 'items' => [ + 'description' => '记忆库数据', + 'type' => 'object', + 'properties' => [ + 'createTime' => ['description' => '创建时间', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1764556182850'], + 'description' => ['description' => '描述', 'type' => 'string', 'example' => 'Created by taishan-module-recovery'], + 'memoryStoreName' => ['description' => '记忆库名称', 'type' => 'string', 'example' => 'qianyi_test_1'], + 'updateTime' => ['description' => '更新时间', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1764556182850'], + 'workspace' => ['description' => '工作空间', 'type' => 'string', 'example' => 'default-cms-1646467597142798-cn-shenzhen'], + 'regionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + ], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询记忆库列表', + 'summary' => '查询记忆库列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusViewId\\": \\"rw-xxxxxx\\",\\n \\"requestId\\": \\"64D964F5-76C7-19A2-9399-457744AB3619\\"\\n}","type":"json"}]', - 'title' => '更新Prom视图实例信息', - 'description' => '更新Prom视图实例信息。', - ], - 'UpdatePrometheusInstance' => [ - 'summary' => '更新Prometheus实例信息。', - 'path' => '/prometheus-instances/{prometheusInstanceId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:ListMemoryStores', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'MemoryStore', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#WorkspaceName}/memorystore/*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"maxResults\\": 1,\\n \\"nextToken\\": \\"xxxxxxxxxx\\",\\n \\"requestId\\": \\"16C0A6D6-C3E7-511D-A60B-A87FD85F5BA7\\",\\n \\"total\\": 0,\\n \\"memoryStores\\": [\\n {\\n \\"createTime\\": \\"1764556182850\\",\\n \\"description\\": \\"Created by taishan-module-recovery\\",\\n \\"memoryStoreName\\": \\"qianyi_test_1\\",\\n \\"updateTime\\": \\"1764556182850\\",\\n \\"workspace\\": \\"default-cms-1646467597142798-cn-shenzhen\\",\\n \\"regionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListPipelines' => [ + 'path' => '/workspace/{workspace}/pipeline', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'prometheusInstanceId', + 'name' => 'workspace', 'in' => 'path', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => 'prometheus实例ID', - 'description' => 'prometheus实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rw-xxxxxxx', - ], + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => false, 'example' => 'workspace-test'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'pipelineName', + 'in' => 'query', + 'schema' => ['description' => '流水线名称', 'type' => 'string', 'required' => false, 'example' => 'pipeline-name-1'], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => '分页 Token', 'type' => 'string', 'required' => false, 'example' => 'fff3442dac1de7950f44d5afc0c735ebd12e27f603b21d17ec30cb1d5c735b1ba7c4fb3a1c124bce'], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => '最大返回结果数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '请求体。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'archiveDuration' => [ - 'title' => '存储到期后，自动归档保存的天数，0表示不归档保存。归档天数取值范围：'."\n" - .'V1：1~365天。仅按指标写入量支持。'."\n" - .'V2：1~3650天（3650表示永久保存）。', - 'description' => '存储到期后，自动归档保存的天数，0表示不归档保存。归档天数取值范围：'."\n" - .'V1：1~365天。仅按指标写入量支持。'."\n" - .'V2：1~3650天（3650表示永久保存）。', - 'type' => 'integer', - 'required' => false, - 'example' => '365', - 'enum' => [], - ], - 'authFreeReadPolicy' => [ - 'title' => '是否开启免密读的ip地址列表，支持CIDR配置。多个ip之间换行符分隔。', - 'description' => '免密读策略（支持IP段和VpcId）。', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "SourceIp": ['."\n" - .' "192.168.1.0/24",'."\n" - .' "172.168.2.22"'."\n" - .' ],'."\n" - .' "SourceVpc": ['."\n" - .' "vpc-xx1",'."\n" - .' "vpc-xx2"'."\n" - .' ]'."\n" - .'}', - ], - 'authFreeWritePolicy' => [ - 'title' => '是否开启免密写的ip地址列表，支持CIDR配置。多个ip之间换行符分隔。', - 'description' => '免密读策略（支持IP段和VpcId）。', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "SourceIp": ['."\n" - .' "192.168.1.0/24",'."\n" - .' "172.168.2.22"'."\n" - .' ],'."\n" - .' "SourceVpc": ['."\n" - .' "vpc-xx1",'."\n" - .' "vpc-xx2"'."\n" - .' ]'."\n" - .'}', - ], - 'enableAuthFreeRead' => [ - 'title' => '是否开启免密读', - 'description' => '是否开启免密读。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'enableAuthFreeWrite' => [ - 'title' => '是否开启免密写', - 'description' => '是否开启免密写。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'enableAuthToken' => [ - 'title' => '是否开启访问Token鉴权', - 'description' => '是否开启访问Token鉴权。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'prometheusInstanceName' => [ - 'description' => '实例名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test-prom-name', - ], - 'status' => [ - 'title' => '实例存储db状态（仅支持RUNNING）。为空时，不改变存储db状态。', - 'description' => '实例存储db状态（仅支持RUNNING）。为空时，不改变存储db状态。', - 'type' => 'string', - 'required' => false, - 'example' => 'RUNNING', - ], - 'storageDuration' => [ - 'title' => '存储时长（天）：'."\n" - .'按写入量：90、180'."\n" - .'按指标上报量：15、30、60、90、180', - 'description' => '存储时长（天）：'."\n" - .'按写入量：90、180。'."\n" - .'按指标上报量：15、30、60、90、180。', - 'type' => 'integer', - 'required' => false, - 'example' => '90', - 'enum' => [ - '15', - '30', - '60', - '90', - '180', - '365', - ], - ], - 'paymentType' => [ - 'title' => '计费方式（实例的生命周期内，只能修改一次）：'."\n" - .'POSTPAY：按指标上报量后付费。'."\n" - .'POSTPAY_GB：按指标写入量后付费。', - 'description' => '计费方式（实例的生命周期内，只能修改一次）：'."\n" - .'POSTPAY：按指标上报量后付费。'."\n" - .'POSTPAY_GB：按指标写入量后付费。', - 'type' => 'string', - 'required' => false, - 'example' => 'POSTPAY_GB', - 'enum' => [ - 'POSTPAY_GB', - 'POSTPAY', + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-************'], + 'nextToken' => ['description' => '分页Token', 'type' => 'string', 'example' => '3f0d6785770d5fb308f0605d718d422a227c38f96117633678f029842acd19039329e8281583b3da7bc598dfc4c1973e'], + 'maxResults' => ['description' => '最大返回结果数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'pipelines' => [ + 'description' => '流水线', + 'type' => 'array', + 'items' => [ + 'description' => '流水线', + 'type' => 'object', + 'properties' => [ + 'pipelineName' => ['description' => '流水线名称', 'type' => 'string', 'example' => 'pipeline-name-1'], + 'description' => ['description' => '描述', 'type' => 'string', 'example' => 'test pipeline'], + 'createTime' => ['description' => '创建时间', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2026-02-28T07:14:17Z'], + 'updateTime' => ['description' => '更新时间', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2026-03-24T06:58:22Z'], + 'regionId' => ['description' => '地域ID', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'workspace' => ['description' => '工作空间ID', 'type' => 'string', 'example' => 'workspace-test'], + ], ], ], - 'workspace' => [ - 'title' => '归属的工作空间。', - 'description' => '归属的工作空间。', - 'type' => 'string', - 'required' => false, - 'example' => 'default-cms-1500199863951574-cn-shanghai', - ], ], - 'required' => false, ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询流水线列表', + 'summary' => '查询流水线列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:ListPipelines', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Pipeline', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#Workspace}/pipeline/*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-************\\",\\n \\"nextToken\\": \\"3f0d6785770d5fb308f0605d718d422a227c38f96117633678f029842acd19039329e8281583b3da7bc598dfc4c1973e\\",\\n \\"maxResults\\": 100,\\n \\"pipelines\\": [\\n {\\n \\"pipelineName\\": \\"pipeline-name-1\\",\\n \\"description\\": \\"test pipeline\\",\\n \\"createTime\\": \\"2026-02-28T07:14:17Z\\",\\n \\"updateTime\\": \\"2026-03-24T06:58:22Z\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"workspace\\": \\"workspace-test\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListPrometheusDashboards' => [ + 'path' => '/prometheus-instances/{prometheusInstanceId}/dashboards', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'prometheusInstanceId', + 'in' => 'path', + 'allowEmptyValue' => false, + 'schema' => ['title' => '实例id', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'rw-abc123'], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-acfm3gn5i6bigbi'], + ], + [ + 'name' => 'aliyunLang', + 'in' => 'query', + 'schema' => ['title' => '语言环境, 默认为中文 zh | en', 'description' => '语言环境, 默认为中文 zh | en', 'type' => 'string', 'required' => false, 'example' => 'zh', 'default' => 'zh'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ @@ -17375,134 +15101,131 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'prometheusInstanceId' => [ - 'description' => '实例id。', - 'type' => 'string', - 'example' => 'rw-abc123', - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '1E92F783-E057-58F1-BD5C-92DED088E7A5', + 'prometheusDashboards' => [ + 'description' => 'Prometheus实例大盘列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => ['title' => '', 'description' => '大盘ID。', 'type' => 'string', 'example' => '1'], + 'uid' => ['title' => '', 'description' => '大盘UID。', 'type' => 'string', 'example' => '1987395500251724'], + 'name' => ['title' => '', 'description' => '大盘名称。', 'type' => 'string', 'example' => 'pod'], + 'title' => ['title' => '', 'description' => '大盘标题。', 'type' => 'string', 'example' => 'ceshi'], + 'url' => ['title' => '', 'description' => '大盘URL地址。', 'type' => 'string', 'example' => 'https://gnew.console.aliyun.com/d/xxx-17460385-807-7-6/cs-cost-application'], + 'tags' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => ['description' => '标签值。', 'type' => 'string', 'example' => '[{\\"tagName\\":\\"key1\\",\\"tagDefinePrompt\\":\\"value1\\"}]'], + ], + ], + 'description' => '', + ], ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'totalCount' => ['title' => '总实例数', 'description' => '总实例数', 'type' => 'integer', 'format' => 'int32', 'example' => '66'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusInstanceId\\": \\"rw-abc123\\",\\n \\"requestId\\": \\"1E92F783-E057-58F1-BD5C-92DED088E7A5\\"\\n}","type":"json"}]', - 'title' => '更新Prometheus实例信息', - 'description' => '更新Prometheus实例信息。', - ], - 'ListPrometheusViews' => [ - 'summary' => '获取Prometheus视图实例信息列表。', - 'path' => '/prometheus-views', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取Prometheus实例大盘列表', + 'summary' => '获取Prometheus实例大盘列表。', + 'description' => '获取Prometheus实例大盘列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrometheusDashboards'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:ListPrometheusDashboards', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'PrometheusInstance', 'arn' => 'acs:cms:{#regionId}:{#accountId}:prometheusinstance/{#prometheusInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusDashboards\\": [\\n {\\n \\"id\\": \\"1\\",\\n \\"uid\\": \\"1987395500251724\\",\\n \\"name\\": \\"pod\\",\\n \\"title\\": \\"ceshi\\",\\n \\"url\\": \\"https://gnew.console.aliyun.com/d/xxx-17460385-807-7-6/cs-cost-application\\",\\n \\"tags\\": [\\n \\"[{\\\\\\\\\\\\\\"tagName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"key1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tagDefinePrompt\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"value1\\\\\\\\\\\\\\"}]\\"\\n ]\\n }\\n ],\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"totalCount\\": 66\\n}","type":"json"}]', + ], + 'ListPrometheusInstances' => [ + 'summary' => '获取Prometheus实例信息列表。', + 'path' => '/prometheus-instances', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'prometheusViewIds', + 'name' => 'prometheusInstanceIds', 'in' => 'query', - 'schema' => [ - 'description' => 'Prometheus视图实例Id列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'view-xxx', - ], + 'allowEmptyValue' => true, + 'schema' => ['title' => '实例id列表（以英文逗号分隔）', 'description' => '实例id列表（以英文逗号分隔）', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'rw-00001,rw-00002,rw-00003'], ], [ - 'name' => 'prometheusViewName', + 'name' => 'prometheusInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => 'Prometheus 视图名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'view1', - ], + 'allowEmptyValue' => true, + 'schema' => ['title' => '实例名称（支持部分匹配）', 'description' => '实例名称（支持部分匹配）', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test'], ], [ 'name' => 'workspace', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'workspace-test', - ], + 'allowEmptyValue' => true, + 'schema' => ['title' => '实例归属的工作空间', 'description' => '实例归属的工作空间', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'workspace-test'], ], [ 'name' => 'version', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ 'title' => '实例版本：V1或V2', 'description' => '实例版本：V1或V2', 'type' => 'string', 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => ['V1' => 'V1版本', 'V2' => 'V2版本'], 'example' => 'V2', - 'enum' => [ - 'V1', - 'V2', - ], + 'enum' => ['V1', 'V2'], ], ], [ 'name' => 'resourceType', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'title' => '资源类型：PrometheusView', - 'description' => '资源类型。', + 'title' => '实例的资源类型：PrometheusInstance', + 'description' => '实例的资源类型。', 'type' => 'string', 'required' => false, - 'example' => 'PROMETHEUSVIEW', + 'docRequired' => false, + 'example' => 'Prometheus', + 'enum' => [], ], ], [ 'name' => 'filterRegionIds', 'in' => 'query', - 'schema' => [ - 'title' => '指定筛选的regionId（目前仅支持单regioinId，暂不支持多值）。', - 'description' => '通过RegionID进行过滤。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-zhangjiakou,cn-beijing', - ], + 'allowEmptyValue' => true, + 'schema' => ['title' => '指定筛选的regionId（目前仅支持单regioinId，暂不支持多值）。', 'description' => '指定筛选的regionId列表（英文逗号分隔）。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-shenzhen'], ], [ 'name' => 'resourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfm3gn5i6bigbi', - ], + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2bhocin5e2na'], ], [ 'name' => 'tag', @@ -17512,21 +15235,11 @@ 'description' => '标签列表。', 'type' => 'array', 'items' => [ - 'description' => '标签列表。', + 'description' => '标签。', 'type' => 'object', 'properties' => [ - 'key' => [ - 'description' => '标签键', - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], - 'value' => [ - 'description' => '匹配值。', - 'type' => 'string', - 'required' => false, - 'example' => 'value1', - ], + 'key' => ['description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'testKey'], + 'value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'testValue'], ], 'required' => false, ], @@ -17537,31 +15250,13 @@ 'name' => 'maxResults', 'in' => 'query', 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '返回的最多记录数。', - 'description' => '返回的最多记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '100', - ], + 'schema' => ['title' => '返回的最多记录数。', 'description' => '返回的最多记录数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '10'], ], [ 'name' => 'nextToken', 'in' => 'query', 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '查询令牌。', - 'description' => '查询令牌。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '44ANBjKZmQeKnaB1fXRq06w7sFYK3MUcCALMD9qQbmEiE', - 'maxLength' => 128, - ], + 'schema' => ['title' => '查询令牌。', 'description' => '查询令牌。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'xxxxxxxxxx', 'maxLength' => 128], ], ], 'responses' => [ @@ -17571,257 +15266,130 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'maxResults' => [ - 'title' => '返回的最多记录数。', - 'description' => '返回的最多记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '100', - 'minimum' => '0', - 'example' => '10', - ], - 'nextToken' => [ - 'title' => '下一次查询的令牌。', - 'description' => '下一次查询的令牌。', - 'type' => 'string', - 'example' => '2-ba4d-4b9f-aa24-dcb067a30f1c', - 'maxLength' => 128, - ], - 'prometheusViews' => [ - 'description' => 'Prometheus视图实例列表。', + 'maxResults' => ['title' => '返回的最多记录数。', 'description' => '返回的最多记录数。', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '0', 'example' => '10'], + 'nextToken' => ['title' => '下一次查询的令牌。', 'description' => '下一次查询的令牌。', 'type' => 'string', 'example' => 'xxxxxxxxxx', 'maxLength' => 128], + 'prometheusInstances' => [ + 'description' => 'Prometheus 实例列表。', 'type' => 'array', 'items' => [ - 'description' => 'Prometheus视图实例。', + 'description' => 'Prometheus 实例。', 'type' => 'object', 'properties' => [ - 'createTime' => [ - 'title' => '实例创建时间，使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ', - 'description' => '实例创建时间，使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ', - 'type' => 'string', - 'example' => '2025-07-12T02:18:36Z', - ], - 'instanceType' => [ - 'title' => '实例类型：'."\n" - .'prom-view：新版本聚合视图'."\n" - .'global-view：老版本聚合视图', - 'description' => '实例类型：'."\n" - .'prom-view：新版本聚合视图'."\n" - .'global-view：老版本聚合视图', - 'type' => 'string', - 'example' => 'prom-view', - ], - 'paymentType' => [ - 'title' => '付费类型。目前固定值FREE（免费）。', - 'description' => '付费类型。目前固定值FREE（免费）。', - 'type' => 'string', - 'example' => 'FREE', - ], - 'product' => [ - 'title' => 'prom实例归属的产品（arms或cms）', - 'description' => 'prom实例归属的产品（arms或cms）。', - 'type' => 'string', - 'example' => 'cms', - ], - 'prometheusInstanceCount' => [ - 'title' => '视图包含的prometheus实例的数量。', - 'description' => '视图包含的prometheus实例的数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'prometheusViewId' => [ - 'description' => 'Prometheus 视图 ID。', - 'type' => 'string', - 'example' => 'view-xxx', - ], - 'prometheusViewName' => [ - 'description' => 'Prometheus 视图名称。', - 'type' => 'string', - 'example' => 'view1', - ], - 'regionId' => [ - 'description' => '区域 ID。', - 'type' => 'string', - 'example' => 'cn-zhangjiakou', - ], - 'resourceType' => [ - 'title' => '固定值：PrometheusView', - 'description' => '固定值：PrometheusView。', - 'type' => 'string', - 'example' => 'PrometheusView', - ], - 'status' => [ - 'title' => '后端数据存储状态', - 'description' => '后端数据存储状态。', - 'type' => 'string', - 'example' => 'Running', - ], - 'userId' => [ - 'description' => '用户ID。', - 'type' => 'string', - 'example' => '123xxx', - ], - 'version' => [ - 'title' => '版本', - 'description' => '版本。', - 'type' => 'string', - 'example' => 'V2', - ], - 'workspace' => [ - 'title' => 'prom实例归属工作空间', - 'description' => 'prom实例归属工作空间。', - 'type' => 'string', - 'example' => 'default-cms-1490404746278495-cn-hangzhou', + 'accessType' => ['title' => '权限类型：'."\n" + .'readWrite、readOnly、httpReadOnly', 'description' => '权限类型：'."\n" + .'readWrite、readOnly、httpReadOnly', 'type' => 'string', 'example' => 'readWrite'], + 'createTime' => ['title' => '实例创建时间，使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ', 'description' => '实例创建时间，使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ', 'type' => 'string', 'example' => '2025-08-10T02:07:53Z'], + 'instanceType' => ['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' => '实例类型。', 'type' => 'string', 'example' => 'remote-write'], + 'paymentType' => ['title' => 'POSTPAY：按指标量后付费。'."\n" + .'POSTPAY_GB：按写入量后付费。'."\n" + .'PREPAY：预付费。'."\n" + .'FREE：免费。', 'description' => 'POSTPAY：按指标量后付费。'."\n" + .'POSTPAY_GB：按写入量后付费。'."\n" + .'PREPAY：预付费。'."\n" + .'FREE：免费。', 'type' => 'string', 'example' => 'POSTPAY_GB'], + 'product' => ['title' => 'prom实例归属的产品（arms或cms）', 'description' => 'prom实例归属的产品', 'type' => 'string', 'example' => 'arms'], + 'prometheusInstanceId' => ['description' => '实例id。', 'type' => 'string', 'example' => 'rw-63549e054ff596a4149927961dff'], + 'prometheusInstanceName' => ['description' => '实例名称。', 'type' => 'string', 'example' => 'test-prom-name'], + 'regionId' => ['description' => '区域 ID', 'type' => 'string', 'example' => 'cn-nanjing'], + 'resourceType' => ['title' => '固定值：PrometheusInstance', 'description' => '资源类型。', 'type' => 'string', 'example' => 'Prometheus'], + 'status' => ['title' => '后端数据存储状态', 'description' => '后端数据存储状态', 'type' => 'string', 'example' => 'Pending2Running'], + 'supportAuthTypes' => [ + 'description' => '支持的鉴权类型。', + 'type' => 'array', + 'items' => ['description' => '鉴权类型。', 'type' => 'string', 'example' => 'BasicAuth'], ], + 'userId' => ['description' => '用户ID。', 'type' => 'string', 'example' => '17073812345'], + 'version' => ['title' => '版本', 'description' => '版本', 'type' => 'string', 'example' => '*'], + 'workspace' => ['title' => 'prom实例归属工作空间', 'description' => 'prom实例归属工作空间', 'type' => 'string', 'example' => 'default-cms-115214006-cn-hangzhou'], + 'resourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-aek2bhocin5e2na'], ], ], ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', - ], - 'totalCount' => [ - 'title' => '总实例数', - 'description' => '总实例数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '66', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'totalCount' => ['title' => '总实例数', 'description' => '总实例数', 'type' => 'integer', 'format' => 'int32', 'example' => '66'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"maxResults\\": 10,\\n \\"nextToken\\": \\"2-ba4d-4b9f-aa24-dcb067a30f1c\\",\\n \\"prometheusViews\\": [\\n {\\n \\"createTime\\": \\"2025-07-12T02:18:36Z\\",\\n \\"instanceType\\": \\"prom-view\\",\\n \\"paymentType\\": \\"FREE\\",\\n \\"product\\": \\"cms\\",\\n \\"prometheusInstanceCount\\": 2,\\n \\"prometheusViewId\\": \\"view-xxx\\",\\n \\"prometheusViewName\\": \\"view1\\",\\n \\"regionId\\": \\"cn-zhangjiakou\\",\\n \\"resourceType\\": \\"PrometheusView\\",\\n \\"status\\": \\"Running\\",\\n \\"userId\\": \\"123xxx\\",\\n \\"version\\": \\"V2\\",\\n \\"workspace\\": \\"default-cms-1490404746278495-cn-hangzhou\\"\\n }\\n ],\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\",\\n \\"totalCount\\": 66\\n}","type":"json"}]', - 'title' => '获取Prometheus视图实例列表', - 'description' => '获取Prometheus视图实例信息列表。', - ], - 'ListPrometheusInstances' => [ - 'summary' => '获取Prometheus实例信息列表。', - 'path' => '/prometheus-instances', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"maxResults\\": 10,\\n \\"nextToken\\": \\"xxxxxxxxxx\\",\\n \\"prometheusInstances\\": [\\n {\\n \\"accessType\\": \\"readWrite\\",\\n \\"createTime\\": \\"2025-08-10T02:07:53Z\\",\\n \\"instanceType\\": \\"remote-write\\",\\n \\"paymentType\\": \\"POSTPAY_GB\\",\\n \\"product\\": \\"arms\\",\\n \\"prometheusInstanceId\\": \\"rw-63549e054ff596a4149927961dff\\",\\n \\"prometheusInstanceName\\": \\"test-prom-name\\",\\n \\"regionId\\": \\"cn-nanjing\\",\\n \\"resourceType\\": \\"Prometheus\\",\\n \\"status\\": \\"Pending2Running\\",\\n \\"supportAuthTypes\\": [\\n \\"BasicAuth\\"\\n ],\\n \\"userId\\": \\"17073812345\\",\\n \\"version\\": \\"*\\",\\n \\"workspace\\": \\"default-cms-115214006-cn-hangzhou\\",\\n \\"resourceGroupId\\": \\"rg-aek2bhocin5e2na\\"\\n }\\n ],\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"totalCount\\": 66\\n}","type":"json"}]', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], - 'schemes' => [ - 'https', + 'title' => '查询 Prometheus 实例列表', + 'description' => '获取Prometheus实例列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrometheusInstances'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + ], + 'ListPrometheusViews' => [ + 'summary' => '获取Prometheus视图实例信息列表。', + 'path' => '/prometheus-views', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'prometheusInstanceIds', + 'name' => 'prometheusViewIds', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '实例id列表（以英文逗号分隔）', - 'description' => '实例id列表（以英文逗号分隔）', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'rw-00001,rw-00002,rw-00003', - ], + 'schema' => ['description' => 'Prometheus视图实例Id列表。', 'type' => 'string', 'required' => false, 'example' => 'view-xxx'], ], [ - 'name' => 'prometheusInstanceName', + 'name' => 'prometheusViewName', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '实例名称（支持部分匹配）', - 'description' => '实例名称（支持部分匹配）', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'Prometheus 视图名称。', 'type' => 'string', 'required' => false, 'example' => 'view1'], ], [ 'name' => 'workspace', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '实例归属的工作空间', - 'description' => '实例归属的工作空间', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'workspace-test', - ], + 'schema' => ['description' => '工作空间名称。', 'type' => 'string', 'required' => false, 'example' => 'workspace-test'], ], [ 'name' => 'version', 'in' => 'query', - 'allowEmptyValue' => true, 'schema' => [ 'title' => '实例版本：V1或V2', 'description' => '实例版本：V1或V2', 'type' => 'string', 'required' => false, - 'docRequired' => false, + 'enumValueTitles' => ['V1' => 'V1版本', 'V2' => 'V2版本'], 'example' => 'V2', - 'enum' => [ - 'V1', - 'V2', - ], + 'enum' => ['V1', 'V2'], ], ], [ 'name' => 'resourceType', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '实例的资源类型：PrometheusInstance', - 'description' => '实例的资源类型。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Prometheus', - 'enum' => [], - ], + 'schema' => ['title' => '资源类型：PrometheusView', 'description' => '资源类型。', 'type' => 'string', 'required' => false, 'example' => 'PROMETHEUSVIEW'], ], [ 'name' => 'filterRegionIds', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '指定筛选的regionId（目前仅支持单regioinId，暂不支持多值）。', - 'description' => '指定筛选的regionId列表（英文逗号分隔）。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cn-shenzhen', - ], + 'schema' => ['title' => '指定筛选的regionId（目前仅支持单regioinId，暂不支持多值）。', 'description' => '通过RegionID进行过滤。', 'type' => 'string', 'required' => false, 'example' => 'cn-zhangjiakou,cn-beijing'], ], [ 'name' => 'resourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aek2bhocin5e2na', - ], + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-acfm3gn5i6bigbi'], ], [ 'name' => 'tag', @@ -17831,21 +15399,11 @@ 'description' => '标签列表。', 'type' => 'array', 'items' => [ - 'description' => '标签。', + 'description' => '标签列表。', 'type' => 'object', 'properties' => [ - 'key' => [ - 'description' => '标签键。', - 'type' => 'string', - 'required' => false, - 'example' => 'testKey', - ], - 'value' => [ - 'description' => '标签值。', - 'type' => 'string', - 'required' => false, - 'example' => 'testValue', - ], + 'key' => ['description' => '标签键', 'type' => 'string', 'required' => false, 'example' => 'key1'], + 'value' => ['description' => '匹配值。', 'type' => 'string', 'required' => false, 'example' => 'value1'], ], 'required' => false, ], @@ -17856,31 +15414,13 @@ 'name' => 'maxResults', 'in' => 'query', 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '返回的最多记录数。', - 'description' => '返回的最多记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '10', - ], + 'schema' => ['title' => '返回的最多记录数。', 'description' => '返回的最多记录数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '100'], ], [ 'name' => 'nextToken', 'in' => 'query', 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '查询令牌。', - 'description' => '查询令牌。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'xxxxxxxxxx', - 'maxLength' => 128, - ], + 'schema' => ['title' => '查询令牌。', 'description' => '查询令牌。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '44ANBjKZmQeKnaB1fXRq06w7sFYK3MUcCALMD9qQbmEiE', 'maxLength' => 128], ], ], 'responses' => [ @@ -17890,535 +15430,206 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'maxResults' => [ - 'title' => '返回的最多记录数。', - 'description' => '返回的最多记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '100', - 'minimum' => '0', - 'example' => '10', - ], - 'nextToken' => [ - 'title' => '下一次查询的令牌。', - 'description' => '下一次查询的令牌。', - 'type' => 'string', - 'example' => 'xxxxxxxxxx', - 'maxLength' => 128, - ], - 'prometheusInstances' => [ - 'description' => 'Prometheus 实例列表。', + 'maxResults' => ['title' => '返回的最多记录数。', 'description' => '返回的最多记录数。', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '0', 'example' => '10'], + 'nextToken' => ['title' => '下一次查询的令牌。', 'description' => '下一次查询的令牌。', 'type' => 'string', 'example' => '2-ba4d-4b9f-aa24-dcb067a30f1c', 'maxLength' => 128], + 'prometheusViews' => [ + 'description' => 'Prometheus视图实例列表。', 'type' => 'array', 'items' => [ - 'description' => 'Prometheus 实例。', + 'description' => 'Prometheus视图实例。', 'type' => 'object', 'properties' => [ - 'accessType' => [ - 'title' => '权限类型：'."\n" - .'readWrite、readOnly、httpReadOnly', - 'description' => '权限类型：'."\n" - .'readWrite、readOnly、httpReadOnly', - 'type' => 'string', - 'example' => 'readWrite', - ], - 'createTime' => [ - 'title' => '实例创建时间，使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ', - 'description' => '实例创建时间，使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ', - 'type' => 'string', - 'example' => '2025-08-10T02:07:53Z', - ], - 'instanceType' => [ - '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' => '实例类型。', - 'type' => 'string', - 'example' => 'remote-write', - ], - 'paymentType' => [ - 'title' => 'POSTPAY：按指标量后付费。'."\n" - .'POSTPAY_GB：按写入量后付费。'."\n" - .'PREPAY：预付费。'."\n" - .'FREE：免费。', - 'description' => 'POSTPAY：按指标量后付费。'."\n" - .'POSTPAY_GB：按写入量后付费。'."\n" - .'PREPAY：预付费。'."\n" - .'FREE：免费。', - 'type' => 'string', - 'example' => 'POSTPAY_GB', - ], - 'product' => [ - 'title' => 'prom实例归属的产品（arms或cms）', - 'description' => 'prom实例归属的产品', - 'type' => 'string', - 'example' => 'arms', - ], - 'prometheusInstanceId' => [ - 'description' => '实例id。', - 'type' => 'string', - 'example' => 'rw-63549e054ff596a4149927961dff', - ], - 'prometheusInstanceName' => [ - 'description' => '实例名称。', - 'type' => 'string', - 'example' => 'test-prom-name', - ], - 'regionId' => [ - 'description' => '区域 ID', - 'type' => 'string', - 'example' => 'cn-nanjing', - ], - 'resourceType' => [ - 'title' => '固定值：PrometheusInstance', - 'description' => '资源类型。', - 'type' => 'string', - 'example' => 'Prometheus', - ], - 'status' => [ - 'title' => '后端数据存储状态', - 'description' => '后端数据存储状态', - 'type' => 'string', - 'example' => 'Pending2Running', - ], - 'supportAuthTypes' => [ - 'description' => '支持的鉴权类型。', - 'type' => 'array', - 'items' => [ - 'description' => '鉴权类型。', - 'type' => 'string', - 'example' => 'BasicAuth', - ], - ], - 'userId' => [ - 'description' => '用户ID。', - 'type' => 'string', - 'example' => '17073812345', - ], - 'version' => [ - 'title' => '版本', - 'description' => '版本', - 'type' => 'string', - 'example' => '*', - ], - 'workspace' => [ - 'title' => 'prom实例归属工作空间', - 'description' => 'prom实例归属工作空间', - 'type' => 'string', - 'example' => 'default-cms-115214006-cn-hangzhou', - ], + 'createTime' => ['title' => '实例创建时间，使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ', 'description' => '实例创建时间，使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ', 'type' => 'string', 'example' => '2025-07-12T02:18:36Z'], + 'instanceType' => ['title' => '实例类型：'."\n" + .'prom-view：新版本聚合视图'."\n" + .'global-view：老版本聚合视图', 'description' => '实例类型：'."\n" + .'prom-view：新版本聚合视图'."\n" + .'global-view：老版本聚合视图', 'type' => 'string', 'example' => 'prom-view'], + 'paymentType' => ['title' => '付费类型。目前固定值FREE（免费）。', 'description' => '付费类型。目前固定值FREE（免费）。', 'type' => 'string', 'example' => 'FREE'], + 'product' => ['title' => 'prom实例归属的产品（arms或cms）', 'description' => 'prom实例归属的产品（arms或cms）。', 'type' => 'string', 'example' => 'cms'], + 'prometheusInstanceCount' => ['title' => '视图包含的prometheus实例的数量。', 'description' => '视图包含的prometheus实例的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'prometheusViewId' => ['description' => 'Prometheus 视图 ID。', 'type' => 'string', 'example' => 'view-xxx'], + 'prometheusViewName' => ['description' => 'Prometheus 视图名称。', 'type' => 'string', 'example' => 'view1'], + 'regionId' => ['description' => '区域 ID。', 'type' => 'string', 'example' => 'cn-zhangjiakou'], + 'resourceType' => ['title' => '固定值：PrometheusView', 'description' => '固定值：PrometheusView。', 'type' => 'string', 'example' => 'PrometheusView'], + 'status' => ['title' => '后端数据存储状态', 'description' => '后端数据存储状态。', 'type' => 'string', 'example' => 'Running'], + 'userId' => ['description' => '用户ID。', 'type' => 'string', 'example' => '123xxx'], + 'version' => ['title' => '版本', 'description' => '版本。', 'type' => 'string', 'example' => 'V2'], + 'workspace' => ['title' => 'prom实例归属工作空间', 'description' => 'prom实例归属工作空间。', 'type' => 'string', 'example' => 'default-cms-1490404746278495-cn-hangzhou'], + 'resourceGroupId' => ['title' => '资源组 ID', 'description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-acfm3gn5i6bigbi'], ], ], ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'totalCount' => [ - 'title' => '总实例数', - 'description' => '总实例数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '66', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0'], + 'totalCount' => ['title' => '总实例数', 'description' => '总实例数', 'type' => 'integer', 'format' => 'int32', 'example' => '66'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"maxResults\\": 10,\\n \\"nextToken\\": \\"xxxxxxxxxx\\",\\n \\"prometheusInstances\\": [\\n {\\n \\"accessType\\": \\"readWrite\\",\\n \\"createTime\\": \\"2025-08-10T02:07:53Z\\",\\n \\"instanceType\\": \\"remote-write\\",\\n \\"paymentType\\": \\"POSTPAY_GB\\",\\n \\"product\\": \\"arms\\",\\n \\"prometheusInstanceId\\": \\"rw-63549e054ff596a4149927961dff\\",\\n \\"prometheusInstanceName\\": \\"test-prom-name\\",\\n \\"regionId\\": \\"cn-nanjing\\",\\n \\"resourceType\\": \\"Prometheus\\",\\n \\"status\\": \\"Pending2Running\\",\\n \\"supportAuthTypes\\": [\\n \\"BasicAuth\\"\\n ],\\n \\"userId\\": \\"17073812345\\",\\n \\"version\\": \\"*\\",\\n \\"workspace\\": \\"default-cms-115214006-cn-hangzhou\\"\\n }\\n ],\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"totalCount\\": 66\\n}","type":"json"}]', - 'title' => '查询 Prometheus 实例列表', - 'description' => '获取Prometheus实例列表。', - ], - 'CreatePrometheusInstance' => [ - 'summary' => '创建Prometheus监控实例', - 'path' => '/prometheus-instances', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"maxResults\\": 10,\\n \\"nextToken\\": \\"2-ba4d-4b9f-aa24-dcb067a30f1c\\",\\n \\"prometheusViews\\": [\\n {\\n \\"createTime\\": \\"2025-07-12T02:18:36Z\\",\\n \\"instanceType\\": \\"prom-view\\",\\n \\"paymentType\\": \\"FREE\\",\\n \\"product\\": \\"cms\\",\\n \\"prometheusInstanceCount\\": 2,\\n \\"prometheusViewId\\": \\"view-xxx\\",\\n \\"prometheusViewName\\": \\"view1\\",\\n \\"regionId\\": \\"cn-zhangjiakou\\",\\n \\"resourceType\\": \\"PrometheusView\\",\\n \\"status\\": \\"Running\\",\\n \\"userId\\": \\"123xxx\\",\\n \\"version\\": \\"V2\\",\\n \\"workspace\\": \\"default-cms-1490404746278495-cn-hangzhou\\",\\n \\"resourceGroupId\\": \\"rg-acfm3gn5i6bigbi\\"\\n }\\n ],\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\",\\n \\"totalCount\\": 66\\n}","type":"json"}]', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], - 'schemes' => [ - 'https', + 'title' => '获取Prometheus视图实例列表', + 'description' => '获取Prometheus视图实例信息列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrometheusViews'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + ], + 'ListPrometheusVirtualInstances' => [ + 'path' => '/virtual-instances', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'namespace', + 'in' => 'query', + 'schema' => ['title' => '可选云产品', 'description' => '可选云产品。', 'type' => 'string', 'required' => false, 'example' => 'ack-csi-fuse'], + ], + [ + 'name' => 'tenantId', + 'in' => 'query', + 'schema' => ['type' => 'string'], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['type' => 'string'], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '请求结构。', 'type' => 'object', 'properties' => [ - 'archiveDuration' => [ - 'title' => '存储到期后，自动归档保存的天数，0表示不归档保存。归档天数取值范围：'."\n" - .'V1：1~365天。仅按指标写入量支持。'."\n" - .'V2：1~3650天（3650表示永久保存）。', - 'description' => '存储到期后，自动归档保存的天数。0表示不归档保存。归档天数取值范围：'."\n" - .'* V1：60~365天。'."\n" - .'* V2：60~3650天（3650表示永久保存）。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60', - 'enum' => [], - ], - 'authFreeReadPolicy' => [ - 'description' => '免密读策略（支持IP段和VpcId）。', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "SourceIp": ['."\n" - .' "192.168.1.0/24",'."\n" - .' "172.168.2.22"'."\n" - .' ],'."\n" - .' "SourceVpc": ['."\n" - .' "vpc-xx1",'."\n" - .' "vpc-xx2"'."\n" - .' ]'."\n" - .'}', - ], - 'authFreeWritePolicy' => [ - 'description' => '免密写策略', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "SourceIp": ['."\n" - .' "192.168.1.0/24",'."\n" - .' "172.168.2.22"'."\n" - .' ],'."\n" - .' "SourceVpc": ['."\n" - .' "vpc-xx1",'."\n" - .' "vpc-xx2"'."\n" - .' ]'."\n" - .'}', - ], - 'enableAuthFreeRead' => [ - 'description' => '是否开启免密读（仅V2版本支持）。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'enableAuthFreeWrite' => [ - 'description' => '是否开启免密写（仅V2版本支持）。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'enableAuthToken' => [ - 'description' => '是否开启授权Token（仅V1版本支持）。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'prometheusInstanceName' => [ - 'description' => '实例名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'name1', - ], - 'status' => [ - 'description' => '实例状态。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Running' => 'Running', - 'Stoped' => 'Stoped', - ], - 'example' => 'Running', - 'default' => 'Running', - 'enum' => [ - 'Running', - ], - ], - 'storageDuration' => [ - 'title' => '存储时长（天）：'."\n" - .'按写入量：90、180'."\n" - .'按指标上报量：15、30、60、90、180', - 'description' => '存储时长（天）：'."\n" - .'* 按写入量：90、180。'."\n" - .'* 按指标上报量：15、30、60、90、180。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '90', - 'enum' => [ - '15', - '30', - '60', - '90', - '180', - ], - ], - 'tags' => [ - 'description' => '标签值。', + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'instances' => [ + 'description' => '实例信息。', 'type' => 'array', 'items' => [ - 'description' => '标签值。', + 'description' => '实例信息。', 'type' => 'object', 'properties' => [ - 'key' => [ - 'description' => '标签Key。', - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], - 'value' => [ - 'description' => '标签Value。', - 'type' => 'string', - 'required' => false, - 'example' => '110109200001214284', - ], + 'instanceId' => ['description' => '适用数据源类型：PROMETHEUS_DS'."\n" + ."\n" + .'prometheus实例ID', 'type' => 'string', 'example' => 'rw-b8cfbbe94194ac37fe83f3d2d16a'], + 'httpApiUrl' => ['description' => 'HTTP API地址。', 'type' => 'string', 'example' => 'http://xxxxxxxx'], + 'userId' => ['description' => '用户ID。', 'type' => 'string', 'example' => '17073812345'], + 'regionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-shanghai-cloudspe'], + 'namespace' => ['description' => '适用查询类型：CMS_BASIC_QUERY。'."\n" + ."\n" + .'指标的命名空间', 'type' => 'string', 'example' => 'arms-prom'], + 'createdAt' => ['description' => '创建时间', 'type' => 'string', 'example' => '1750315319946'], ], - 'required' => false, - ], - 'required' => false, - ], - 'workspace' => [ - 'title' => '默认值：default-cms-{userId}-{regionId}', - 'description' => '归属工作空间，默认值：default-cms-{userId}-{regionId}。', - 'type' => 'string', - 'required' => false, - 'example' => 'wokspace1', - ], - 'paymentType' => [ - 'title' => '计费方式：'."\n" - .'POSTPAY：按指标上报量后付费。'."\n" - .'POSTPAY_GB：按指标写入量后付费。'."\n" - .'空：则使用用户的默认计费方式配置。若用户未配置默认值，则系统默认是按指标上报量计费。', - 'description' => '计费方式：'."\n" - .'* POSTPAY：按指标上报量后付费。'."\n" - .'* POSTPAY_GB：按指标写入量后付费。'."\n" - .'注，空值则使用用户的默认计费方式配置。若用户未配置默认值，则系统默认是按指标上报量计费。', - 'type' => 'string', - 'required' => false, - 'example' => 'POSTPAY', - 'enum' => [ - 'POSTPAY', - 'POSTPAY_GB', ], ], + 'totalCount' => ['type' => 'string'], + 'maxResults' => ['type' => 'string'], + 'nextToken' => ['type' => 'string'], ], - 'required' => false, + 'description' => '', ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'prometheusInstanceId' => [ - 'title' => '集群id', - 'description' => '实例id。', - 'type' => 'string', - 'example' => 'rw-abc123', - ], - 'requestId' => [ - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '264C3E89-BE6E-5F82-A484-CE9C2196C7DC', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取Prometheus虚拟实例列表', + 'summary' => '获取Prometheus虚拟实例。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrometheusVirtualInstances'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'cms:ListPrometheusVirtualInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusInstanceId\\": \\"rw-abc123\\",\\n \\"requestId\\": \\"264C3E89-BE6E-5F82-A484-CE9C2196C7DC\\"\\n}","type":"json"}]', - 'title' => '创建Prometheus实例', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"instances\\": [\\n {\\n \\"instanceId\\": \\"rw-b8cfbbe94194ac37fe83f3d2d16a\\",\\n \\"httpApiUrl\\": \\"http://xxxxxxxx\\",\\n \\"userId\\": \\"17073812345\\",\\n \\"regionId\\": \\"cn-shanghai-cloudspe\\",\\n \\"namespace\\": \\"arms-prom\\",\\n \\"createdAt\\": \\"1750315319946\\"\\n }\\n ],\\n \\"totalCount\\": \\"\\",\\n \\"maxResults\\": \\"\\",\\n \\"nextToken\\": \\"\\"\\n}","type":"json"}]', ], - 'CreatePrometheusView' => [ - 'summary' => '创建prometheus视图', - 'path' => '/prometheus-views', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListServiceRecords' => [ + 'summary' => '列表查询服务关联条目', + 'path' => '/workspace/{workspace}/service-records', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => 'workspace-test'], + ], + [ + 'name' => 'recordType', + 'in' => 'query', 'schema' => [ - 'description' => '请求Body', - 'type' => 'object', - 'properties' => [ - 'authFreeReadPolicy' => [ - 'description' => '暂未启用', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "SourceIp": ['."\n" - .' "192.168.1.0/24",'."\n" - .' "172.168.2.22"'."\n" - .' ],'."\n" - .' "SourceVpc": ['."\n" - .' "vpc-xx1",'."\n" - .' "vpc-xx2"'."\n" - .' ]'."\n" - .'}', - ], - 'enableAuthFreeRead' => [ - 'title' => '是否支持免密读', - 'description' => '是否支持免密读', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'enableAuthToken' => [ - 'title' => '是否支持authToken', - 'description' => '是否支持authToken。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'prometheusInstances' => [ - 'description' => 'Prometheus 实例列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'prometheusInstanceId' => [ - 'description' => '实例id。', - 'type' => 'string', - 'required' => false, - 'example' => 'arms-1d581fac20a462dcde743d9628', - ], - 'regionId' => [ - 'description' => '地域 ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-wulanchabu', - ], - 'userId' => [ - 'description' => '用户ID。', - 'type' => 'string', - 'required' => false, - 'example' => '167271234567890', - ], - ], - 'required' => false, - ], - 'required' => true, - ], - 'prometheusViewName' => [ - 'description' => 'Prometheus 视图名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-prom-view-name', - ], - 'resourceGroupId' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfm3gn5i6bigbi', - ], - 'status' => [ - 'description' => '暂未启用。', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - 'default' => 'Running', - 'enum' => [ - 'Running', - ], - ], - 'tags' => [ - 'description' => '执行的操作。', - 'type' => 'array', - 'items' => [ - 'description' => '标签Key。', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => '标签Key。', - 'type' => 'string', - 'required' => false, - 'example' => 'test-key', - ], - 'value' => [ - 'description' => '标签Value。', - 'type' => 'string', - 'required' => false, - 'example' => 'test-value', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'version' => [ - 'title' => 'V1：老版本(global-view)'."\n" - .'V2：新版本(prom-view)', - 'description' => '- V1：老版本'."\n" - .'- V2：新版本', - 'type' => 'string', - 'required' => true, - 'example' => 'V2', - 'enum' => [ - 'V1', - 'V2', - ], - ], - 'workspace' => [ - 'title' => '默认值：default-cms-{userId}-{regionId}', - 'description' => '默认值：default-cms-{userId}-{regionId}', - 'type' => 'string', - 'required' => false, - 'example' => 'cms-monitor-test-aysls-pub-cn-zhangjiakou-spe-monitor', - ], - ], - 'required' => false, + 'title' => '关联条目类型，目前支持:'."\n" + .'logCorrelation，标识应用日志关联', + 'description' => '关联条目类型，目前支持:'."\n" + .'logCorrelation，标识应用日志关联', + 'type' => 'string', + 'required' => true, + 'example' => 'logCorrelation', + 'enum' => ['logCorrelation'], ], ], + [ + 'name' => 'search', + 'in' => 'query', + 'schema' => ['description' => '服务关联条目过滤信息', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "serviceName": "my-service",'."\n" + .' "storeName": "my-logstore"'."\n" + .'}'], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => '最大返回结果数，最大值200', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => '分页Token', 'type' => 'string', 'required' => false, 'example' => 'xxxxx'], + ], ], 'responses' => [ 200 => [ @@ -18427,123 +15638,122 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'prometheusViewId' => [ - 'description' => 'Prometheus 视图 ID。', - 'type' => 'string', - 'example' => 'cd5237f7dbd574cf9bbd648ff9efb16cd', - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0CEC5375-XXXX-XXXX-XXXX-9A629907C1F0'], + 'nextToken' => ['description' => '分页Token', 'type' => 'string', 'example' => '2-ba4d-4b9f-aa24-dcb067a30f1c'], + 'totalCount' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'maxResults' => ['description' => '最大返回结果数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'records' => [ + 'description' => '工单操作记录列表。', + 'type' => 'array', + 'items' => [ + 'description' => '记录信息。', + 'type' => 'object', + 'properties' => [ + 'serviceId' => ['title' => '服务唯一标识', 'description' => '服务唯一标识', 'type' => 'string', 'example' => 'gaddp9ap8q@f8ca37734da3eda787dbb'], + 'recordType' => ['title' => '关联条目类型，目前支持:'."\n" + .'logCorrelation，标识应用日志关联', 'description' => '关联条目类型，目前支持:'."\n" + .'logCorrelation，标识应用日志关联', 'type' => 'string', 'example' => 'logCorrelation'], + 'recordContent' => ['title' => '条目内容，一般为JSON格式，不同的recordType的格式不同；'."\n" + .'当recordType=logCorreation时，recordContent的示例请求内容为：{"project":"proj-xtrace-16c988dcfe21fcb73c5e6f234927d998-cn-hangzhou","storeName":"app-biz-log","regionId":"cn-hangzhou","bindType":"logstore","traceIdRelateField":""}', 'description' => '条目内容，JSON字符串格式，不同的recordType的格式不同', 'type' => 'string', 'example' => '{'."\n" + .' "project": "proj-xtrace-16c988dcfe21fcb73c5e6f234927d998-cn-hangzhou",'."\n" + .' "storeName": "app-biz-log",'."\n" + .' "regionId": "cn-hangzhou",'."\n" + .' "bindType": "logstore",'."\n" + .' "traceIdRelateField": ""'."\n" + .'}'], + 'workspace' => ['title' => '工作空间', 'description' => '工作空间', 'type' => 'string', 'example' => 'workspace-test'], + ], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取服务关联条目列表', + 'description' => '分页获取服务关联条目列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusViewId\\": \\"cd5237f7dbd574cf9bbd648ff9efb16cd\\",\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', - 'title' => '创建prometheus视图', - 'description' => '用于创建一个站点监控任务', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-XXXX-XXXX-XXXX-9A629907C1F0\\",\\n \\"nextToken\\": \\"2-ba4d-4b9f-aa24-dcb067a30f1c\\",\\n \\"totalCount\\": 100,\\n \\"maxResults\\": 100,\\n \\"records\\": [\\n {\\n \\"serviceId\\": \\"gaddp9ap8q@f8ca37734da3eda787dbb\\",\\n \\"recordType\\": \\"logCorrelation\\",\\n \\"recordContent\\": \\"{\\\\n \\\\\\"project\\\\\\": \\\\\\"proj-xtrace-16c988dcfe21fcb73c5e6f234927d998-cn-hangzhou\\\\\\",\\\\n \\\\\\"storeName\\\\\\": \\\\\\"app-biz-log\\\\\\",\\\\n \\\\\\"regionId\\\\\\": \\\\\\"cn-hangzhou\\\\\\",\\\\n \\\\\\"bindType\\\\\\": \\\\\\"logstore\\\\\\",\\\\n \\\\\\"traceIdRelateField\\\\\\": \\\\\\"\\\\\\"\\\\n}\\",\\n \\"workspace\\": \\"workspace-test\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'ListAlertActions' => [ - 'summary' => '查询告警行动集成', - 'path' => '/alertActions', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListServices' => [ + 'summary' => '批量查询应用可观测服务', + 'path' => '/workspace/{workspace}/services', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'high', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'alertActionIds', + 'name' => 'nextToken', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '行动集成唯一标识。', - 'type' => 'array', - 'items' => [ - 'description' => '行动集成唯一标识。', - 'type' => 'string', - 'required' => false, - 'example' => 'testId', - ], - 'required' => false, - ], + 'schema' => ['title' => '翻页的 token，从 NextToken 开始按字典序返回文件信息列表。第一次调用此接口时，设置为空。', 'description' => '下一次查询的token，为空表示最后一页', 'type' => 'string', 'required' => false, 'example' => '7-b81a-4bc9-bbfa-a50cc6988667'], ], [ - 'name' => 'type', + 'name' => 'maxResults', 'in' => 'query', - 'schema' => [ - 'description' => '行动集成类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'FC', - 'enum' => [ - 'FC', - 'MNS', - 'OPEN_API', - 'SLS', - 'ESS', - 'PAGER_DUTY', - 'WEBHOOK', - 'EB', - 'FC3', - ], - ], + 'allowEmptyValue' => false, + 'schema' => ['title' => '查询一页数量，最大500。', 'description' => 'MaxResults本次请求所返回的最大记录条数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'minimum' => '0', 'exclusiveMinimum' => false, 'example' => '10'], ], [ - 'name' => 'alertActionName', + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['title' => '工作空间', 'description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'workspace-test'], + ], + [ + 'name' => 'serviceType', 'in' => 'query', 'schema' => [ - 'description' => '行动集成名称。', + 'title' => '类型：TRACE（应用监控）/ RUM（用户体验监控）/ XTRACE（OT版）', + 'description' => '服务类型', 'type' => 'string', 'required' => false, - 'example' => 'testName', + 'example' => 'TRACE', + 'enum' => ['TRACE', 'XTRACE', 'RUM'], ], ], [ - 'name' => 'pageNumber', + 'name' => 'serviceName', 'in' => 'query', - 'schema' => [ - 'description' => '页面。默认为1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '应用服务名称', 'description' => '应用服务名称', 'type' => 'string', 'required' => false, 'example' => 'app-demo'], ], [ - 'name' => 'pageSize', + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => ['title' => '资源组id', 'description' => '资源组id', 'type' => 'string', 'required' => false, 'example' => 'rg-aekxxzuad5zzzz'], + ], + [ + 'name' => 'tags', 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'json', 'schema' => [ - 'description' => '每页大小。默认100。', - 'type' => 'integer', - 'format' => 'int32', + 'title' => '标签数组', + 'description' => '标签数组', + 'type' => 'array', + 'items' => [ + 'title' => '标签', + 'description' => '标签', + 'type' => 'object', + 'properties' => [ + 'key' => ['title' => '标签key', 'description' => '标签key', 'type' => 'string', 'required' => false, 'example' => 'evn'], + 'value' => ['title' => '标签value', 'description' => '标签value', 'type' => 'string', 'required' => false, 'example' => 'prod'], + ], + 'required' => false, + ], 'required' => false, - 'example' => '100', ], ], ], @@ -18552,320 +15762,146 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], - 'total' => [ - 'description' => '总条数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '9', - ], - 'pageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'pageSize' => [ - 'description' => '分页大小。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'alertActions' => [ - 'description' => '行动集成配置列表。', + 'requestId' => ['title' => '请求 ID。', 'description' => '请求 ID', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0'], + 'nextToken' => ['title' => '分页标识。返回值 nextToken 非空代表还有剩余数据。把 nextToken 作为参数继续查询会获得下一页。', 'description' => '分页Token', 'type' => 'string', 'example' => '2-ba4d-4b9f-aa24-dcb067a30f1c'], + 'totalCount' => ['title' => '总应用服务数量', 'description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '66'], + 'maxResults' => ['title' => '查询一页数量。', 'description' => '最大返回结果数，最大值200', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'services' => [ + 'title' => '应用服务列表', + 'description' => '服务信息列表', 'type' => 'array', 'items' => [ - 'description' => '行动集成配置列表。', + 'title' => '应用服务', + 'description' => '服务信息', 'type' => 'object', 'properties' => [ - 'fcParam' => [ - 'description' => '函数计算参数。', - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'service' => [ - 'description' => '函数计算的服务名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'function' => [ - 'description' => '函数计算服务的函数名称。', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - 'ebParam' => [ - 'description' => '事件总线。', - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'description' => '区域 ID。', - 'type' => 'string', - 'example' => 'cn-heyuan', - ], - 'subject' => [ - 'description' => '主题。', - 'type' => 'string', - 'example' => 'test', - ], - 'ebSource' => [ - 'description' => '事件提供方。', - 'type' => 'string', - 'example' => 'test', - ], - 'eventBusName' => [ - 'description' => '事件总线名称。', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - 'alertActionId' => [ - 'description' => '行动集成唯一标识。', - 'type' => 'string', - 'example' => 'test', - ], - 'slsParam' => [ - 'description' => '日志服务参数。', - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'project' => [ - 'description' => '日志服务Project名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'logstore' => [ - 'description' => '日志服务Logstore名称。', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - 'fc3Param' => [ - 'description' => '函数计算3.0参数。', - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-qingdao', - ], - 'function' => [ - 'description' => '函数计算服务的函数名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'qualifier' => [ - 'description' => '函数的版本或别名。', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - 'mnsParam' => [ - 'description' => '轻量消息队列（原 MNS）参数。', - 'type' => 'object', - 'properties' => [ - 'mnsType' => [ - 'description' => '轻量消息队列（原 MNS）资源类型。', - 'type' => 'string', - 'example' => 'queue', - ], - 'regionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'name' => [ - 'description' => '资源名称。'."\n" - ."\n" - .'- 如果资源类型为 queue，则资源名称为队列名称。'."\n" - .'- 如果资源类型为 topic，则资源名称为主题名称。', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - 'pagerDutyParam' => [ - 'description' => 'pageDuty参数', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => 'pagerDuty的集成key。', - 'type' => 'string', - 'example' => 'fsfer4543t5t65g4t4', - ], - 'url' => [ - 'description' => 'pagerDuty的集成webhook。支持V1和V2版', - 'type' => 'string', - 'example' => 'https://events.pagerduty.com/v2/enqueue', - ], - ], - ], - 'type' => [ - 'description' => '行动集成类型。', - 'type' => 'string', - 'example' => 'FC', - ], - 'webhookParam' => [ - 'description' => 'webhook参数', - 'type' => 'object', - 'properties' => [ - 'headers' => [ - 'description' => '请求头。', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{\'X-Total-Count\': 0}', - 'description' => '请求头。', - ], - ], - 'method' => [ - 'description' => 'webhook请求方法。', - 'type' => 'string', - 'example' => 'GET', - ], - 'contentType' => [ - 'description' => '数据格式，请求方法为POST时生效。', - 'type' => 'string', - 'example' => 'JSON', - ], - 'url' => [ - 'description' => '报警回调的URL地址。', - 'type' => 'string', - 'example' => 'http://www.test.com', - ], - ], - ], - 'essParam' => [ - 'description' => '弹性伸缩参数。', - 'type' => 'object', - 'properties' => [ - 'essGroupId' => [ - 'description' => '弹性伸缩组id', - 'type' => 'string', - 'example' => 'testId', - ], - 'regionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'essRuleId' => [ - 'description' => '弹性伸缩规则id。', - 'type' => 'string', - 'example' => 'testId', - ], - ], - ], - 'alertActionName' => [ - 'description' => '行动集成名称。', - 'type' => 'string', - 'example' => 'testName', - ], + 'serviceId' => ['title' => '应用服务id', 'description' => '服务ID', 'type' => 'string', 'example' => 'jm2pl0yoqf@d4905cb11a4f218dfb0a8'], + 'serviceName' => ['title' => '应用资源名称', 'description' => '服务名称', 'type' => 'string', 'example' => 'demo-app'], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-07-01T02:23:59Z'], + 'serviceType' => ['title' => '类型：TRACE（应用监控）/ RUM（用户体验监控）/ XTRACE（OT版）', 'description' => '服务类型', 'type' => 'string', 'example' => 'TRACE'], + 'serviceStatus' => ['title' => '应用体验监控的服务状态，running/stopped/created/suspend', 'description' => '服务状态，仅当serviceType=RUM时有效。', 'type' => 'string', 'example' => 'Running'], + 'displayName' => ['title' => '别名', 'description' => '显示名称，仅当serviceType=RUM时有效。', 'type' => 'string', 'example' => 'test'], + 'pid' => ['title' => '对应ARMS应用pid', 'description' => '兼容历史的ARMS应用ID', 'type' => 'string', 'example' => 'kgcsf@192197e828d51aa'], + 'description' => ['title' => '应用描述信息。', 'description' => '服务描述，仅当serviceType=RUM时有效。', 'type' => 'string', 'example' => 'workspace api monitor test'], + 'attributes' => ['title' => '特征信息，key:value格式', 'description' => '扩展信息。', 'type' => 'string', 'example' => '{"language":"java"}'], + 'workspace' => ['title' => '工作空间', 'description' => '工作空间。', 'type' => 'string', 'example' => 'default-cms-1192928460540589-cn-hangzhou'], + 'resourceGroupId' => ['title' => '资源组id', 'description' => '资源组id', 'type' => 'string', 'example' => 'rg-aekxxzuad5zzzz'], ], ], ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"total\\": 9,\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 100,\\n \\"alertActions\\": [\\n {\\n \\"fcParam\\": {\\n \\"regionId\\": \\"cn-beijing\\",\\n \\"service\\": \\"test\\",\\n \\"function\\": \\"test\\"\\n },\\n \\"ebParam\\": {\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"subject\\": \\"test\\",\\n \\"ebSource\\": \\"test\\",\\n \\"eventBusName\\": \\"test\\"\\n },\\n \\"alertActionId\\": \\"test\\",\\n \\"slsParam\\": {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"project\\": \\"test\\",\\n \\"logstore\\": \\"test\\"\\n },\\n \\"fc3Param\\": {\\n \\"regionId\\": \\"cn-qingdao\\",\\n \\"function\\": \\"test\\",\\n \\"qualifier\\": \\"test\\"\\n },\\n \\"mnsParam\\": {\\n \\"mnsType\\": \\"queue\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"name\\": \\"test\\"\\n },\\n \\"pagerDutyParam\\": {\\n \\"key\\": \\"fsfer4543t5t65g4t4\\",\\n \\"url\\": \\"https://events.pagerduty.com/v2/enqueue\\"\\n },\\n \\"type\\": \\"FC\\",\\n \\"webhookParam\\": {\\n \\"headers\\": {\\n \\"key\\": \\"{\'X-Total-Count\': 0}\\"\\n },\\n \\"method\\": \\"GET\\",\\n \\"contentType\\": \\"JSON\\",\\n \\"url\\": \\"http://www.test.com\\"\\n },\\n \\"essParam\\": {\\n \\"essGroupId\\": \\"testId\\",\\n \\"regionId\\": \\"cn-beijing\\",\\n \\"essRuleId\\": \\"testId\\"\\n },\\n \\"alertActionName\\": \\"testName\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询告警行动集成', - ], - 'UpdateSubscription' => [ - 'summary' => '更新订阅', - 'path' => '/subscriptions/{subscriptionId}', - 'methods' => [ - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\",\\n \\"nextToken\\": \\"2-ba4d-4b9f-aa24-dcb067a30f1c\\",\\n \\"totalCount\\": 66,\\n \\"maxResults\\": 10,\\n \\"services\\": [\\n {\\n \\"serviceId\\": \\"jm2pl0yoqf@d4905cb11a4f218dfb0a8\\",\\n \\"serviceName\\": \\"demo-app\\",\\n \\"createTime\\": \\"2025-07-01T02:23:59Z\\",\\n \\"serviceType\\": \\"TRACE\\",\\n \\"serviceStatus\\": \\"Running\\",\\n \\"displayName\\": \\"test\\",\\n \\"pid\\": \\"kgcsf@192197e828d51aa\\",\\n \\"description\\": \\"workspace api monitor test\\",\\n \\"attributes\\": \\"{\\\\\\"language\\\\\\":\\\\\\"java\\\\\\"}\\",\\n \\"workspace\\": \\"default-cms-1192928460540589-cn-hangzhou\\",\\n \\"resourceGroupId\\": \\"rg-aekxxzuad5zzzz\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量查询应用可观测服务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '40', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServices'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:ListServices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Service', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#Workspace}/service/*'], + ], + ], + ], ], + ], + 'ListTagResources' => [ + 'summary' => '查标签接口。', + 'path' => '/tags', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'workspace', + 'name' => 'resourceType', + 'in' => 'query', + 'schema' => ['title' => '资源类型', 'description' => '资源类型', 'type' => 'string', 'required' => true, 'example' => 'Service'], + ], + [ + 'name' => 'resourceId', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '工作空间名称', - 'type' => 'string', + 'title' => '资源ID,最多 50个子项', + 'description' => '资源ID列表', + 'type' => 'array', + 'items' => ['description' => '资源ID', 'type' => 'string', 'required' => false, 'example' => 'test'], 'required' => false, - 'example' => 'workspace-test', ], ], [ - 'name' => 'body', - 'in' => 'body', - 'allowEmptyValue' => false, + 'name' => 'tag', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '请求Body。', + 'title' => '对应新增标签列表，最多包含20个子项', + 'description' => '标签。查询的过滤条件。'."\n" + ."\n" + .'最多可以指定 20 个标签。', + 'type' => 'array', + 'items' => ['description' => '标签。查询的过滤条件。'."\n" + ."\n" + .'最多可以指定 20 个标签。', 'required' => false, '$ref' => '#/components/schemas/Tag'], 'required' => false, - '$ref' => '#/components/schemas/SubscriptionForModify', ], ], [ - 'name' => 'subscriptionId', - 'in' => 'path', - 'schema' => [ - 'description' => '订阅ID。', - 'type' => 'string', - 'required' => true, - 'example' => '123123123123', - ], + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['title' => '下一个查询开始Token', 'description' => '下一个查询开始Token', 'type' => 'string', 'required' => false, 'example' => 'xxxxxxxxxx'], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => '最大返回结果数，最大值200', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应内容结构', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求的唯一标识 ID', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-******', - ], - 'subscriptionId' => [ - 'description' => '订阅ID。', - 'type' => 'string', - 'example' => '123123123123', + 'requestId' => ['title' => '请求id', 'description' => '请求ID', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-***'], + 'maxResults' => ['title' => '列表最大数量', 'description' => '最大返回结果数，最大值200', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'nextToken' => ['title' => '下一个查询开始Token', 'description' => '下一个查询开始Token', 'type' => 'string', 'example' => 'xxxxxxxxxx'], + 'tagResources' => [ + 'title' => '资源列表', + 'description' => '标签列表', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表', + 'type' => 'object', + 'properties' => [ + 'tagKey' => ['title' => '标签键', 'description' => '标签键', 'type' => 'string', 'example' => 'env'], + 'tagValue' => ['title' => '标签值', 'description' => '标签值', 'type' => 'string', 'example' => 'test'], + 'resourceId' => ['title' => '资源ID', 'description' => '资源ID', 'type' => 'string', 'example' => 'test'], + 'resourceType' => ['title' => '资源类型', 'description' => '资源类型', 'type' => 'string', 'example' => 'Service'], + ], + ], ], ], ], @@ -18873,781 +15909,556 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidParameter.ResourceType', 'errorMessage' => 'The ResourceType parameter is invalid.', 'description' => ''], + ['errorCode' => 'MissingParameter.ResourceIdsOrTags', 'errorMessage' => 'You must specify ResourceId.N or Tags.', 'description' => ''], + ['errorCode' => 'MissingParameter.ResourceType', 'errorMessage' => 'You must specify ResourceType.', 'description' => ''], + ['errorCode' => 'MissingParameter.TagKey', 'errorMessage' => 'You must specify Tag.N.Key.', 'description' => ''], + ['errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The maximum number of ResourceIds is exceeded.', 'description' => ''], + ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The maximum number of Tags is exceeded.', 'description' => ''], + ['errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The Tag.N.Key contains duplicate keys.', 'description' => ''], + ['errorCode' => 'InvalidParameter.NextToken', 'errorMessage' => 'The NextToken parameter is invalid.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], - ], - [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'The operator is not permission for this operate', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalUnknownError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询标签列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-******\\",\\n \\"subscriptionId\\": \\"123123123123\\"\\n}","type":"json"}]', - 'title' => '更新订阅', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-***\\",\\n \\"maxResults\\": 20,\\n \\"nextToken\\": \\"xxxxxxxxxx\\",\\n \\"tagResources\\": [\\n {\\n \\"tagKey\\": \\"env\\",\\n \\"tagValue\\": \\"test\\",\\n \\"resourceId\\": \\"test\\",\\n \\"resourceType\\": \\"Service\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'CreateAlertWebhook' => [ - 'summary' => '创建Webhook', - 'path' => '/webhook', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListWorkspaces' => [ + 'path' => '/workspace', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREcms5OJOSH'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'workspaceName', + 'in' => 'query', + 'schema' => ['description' => '工作空间名称，模糊查找', 'type' => 'string', 'required' => false, 'example' => 'workspace-test-001'], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => '分页 Token', 'type' => 'string', 'required' => false, 'example' => 'xxxxxxxxxx'], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => '分页大小'."\n" + .'默认值:'."\n" + .' 50'."\n" + .'最大值:'."\n" + .' 50', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '0', 'example' => '10', 'default' => '100'], + ], + [ + 'name' => 'workspaceNameList', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '请求参数。', - 'type' => 'object', - 'properties' => [ - 'contentType' => [ - 'description' => '数据内容类型，支持：'."\n" - .'- JSON(默认)'."\n" - .'- FORM', - 'type' => 'string', - 'required' => false, - 'example' => 'JSON', - 'default' => 'JSON', - 'enum' => [ - 'JSON', - 'FORM', - ], - ], - 'headers' => [ - 'description' => 'headers', - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'test', - 'description' => 'header', - ], - ], - 'lang' => [ - 'description' => '语言。支持：'."\n" - .'- zh_CN'."\n" - .'- en_US', - 'type' => 'string', - 'required' => false, - 'example' => 'zh_CN', - 'enum' => [ - 'zh_CN', - 'en_US', - ], - ], - 'method' => [ - 'description' => '请求方法。'."\n" - .'- GET'."\n" - .'- POST', - 'type' => 'string', - 'required' => false, - 'example' => 'GET', - 'default' => 'POST', - 'enum' => [ - 'GET', - 'POST', - ], - ], - 'name' => [ - 'description' => 'webhook名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - 'url' => [ - 'description' => '报警回调的URL地址。', - 'type' => 'string', - 'required' => true, - 'example' => 'https://aliyun.com/test', - ], - 'webhookId' => [ - 'description' => 'webhook唯一标识。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], + 'description' => '工作空间名称，精确查找', + 'type' => 'array', + 'items' => ['description' => '工作空间名称，精确查找', 'type' => 'string', 'required' => false, 'example' => 'workspace-test-001'], 'required' => false, + 'example' => 'workspace-test-001', ], ], + [ + 'name' => 'region', + 'in' => 'query', + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-heyuan'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应结果。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'alertWebhookId' => [ - 'description' => 'webhook唯一标识。', - 'type' => 'string', - 'example' => 'test', + 'maxResults' => ['description' => '分页大小'."\n" + .'默认值:'."\n" + .' 50'."\n" + .'最大值:'."\n" + .' 50', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'nextToken' => ['description' => '分页 Token', 'type' => 'string', 'example' => 'xxxxxxxxxx'], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求 ID'."\n" + ."\n", 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'total' => ['title' => '当总结果个数大于MaxResults时，用于翻页的token。', 'description' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'workspaces' => [ + 'title' => '数组，返回示例目录。', + 'description' => '工作空间列表', + 'type' => 'array', + 'items' => [ + 'title' => 'WorkspaceItemType', + 'description' => 'WorkspaceItemType', + 'type' => 'object', + 'properties' => [ + 'createTime' => ['description' => '创建时间', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2025-03-11T08:21:58Z'], + 'displayName' => ['description' => '工作空间展示名称', 'type' => 'string', 'example' => 'workspace-test'], + 'description' => ['title' => '工作空间描述', 'description' => '工作空间描述', 'type' => 'string', 'example' => 'workspace test', 'pattern' => '', 'default' => ''], + 'lastModifyTime' => ['description' => '更新时间', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2025-03-11T08:21:58Z'], + 'regionId' => ['title' => '地域ID', 'description' => '地域 ID', 'type' => 'string', 'example' => 'cn-heyuan', 'pattern' => '', 'default' => ''], + 'slsProject' => ['title' => '日志服务项目名称', 'description' => '日志服务项目名称', 'type' => 'string', 'example' => 'sls-project-test-001', 'pattern' => '', 'default' => ''], + 'workspaceName' => ['title' => '工作空间名称', 'description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'workspace-test-001', 'pattern' => '', 'default' => ''], + ], + ], ], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => 'Resource already exist .', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => '%s is missing or invalid.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取工作空间列表', + 'summary' => '获取工作空间列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWorkspaces'], ], - 500 => [ - [ - 'errorCode' => 'InternalUnknownError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:ListWorkspaces', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Workspace', 'arn' => 'acs:cms::{#accountId}:workspace/*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"alertWebhookId\\": \\"test\\"\\n}","type":"json"}]', - 'title' => '创建报警webhook', - 'description' => '创建一个webhook通知对象。', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"maxResults\\": 10,\\n \\"nextToken\\": \\"xxxxxxxxxx\\",\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"total\\": 1,\\n \\"workspaces\\": [\\n {\\n \\"createTime\\": \\"2025-03-11T08:21:58Z\\",\\n \\"displayName\\": \\"workspace-test\\",\\n \\"description\\": \\"workspace test\\",\\n \\"lastModifyTime\\": \\"2025-03-11T08:21:58Z\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"slsProject\\": \\"sls-project-test-001\\",\\n \\"workspaceName\\": \\"workspace-test-001\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'DeleteAlertWebhooks' => [ - 'summary' => '删除Webhook', - 'path' => '/webhooks', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'ManageAlertRules' => [ + 'summary' => '管理告警规则', + 'path' => '/manageAlertRules', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'webhookIds', - 'in' => 'query', + 'name' => 'body', + 'in' => 'formData', 'style' => 'json', - 'schema' => [ - 'description' => 'webhook唯一标识。', - 'type' => 'array', - 'items' => [ - 'description' => 'webhook唯一标识。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'required' => true, - ], + 'schema' => ['description' => '管理告警规则请求体聚合（CREATE/UPDATE/PATCH/BATCH_DELETE 共用，按 action 选填字段）', 'required' => false, '$ref' => '#/components/schemas/ManageAlertRulesUnifiedActionInput'], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '响应内容结构', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E5B1D3D4-BB28-5996-8AD2-***********', - ], - ], - ], + 'schema' => ['description' => '管理告警规则-服务器响应结果', '$ref' => '#/components/schemas/ServerResponseManageAlertRulesResult'], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => '%s is missing or invalid.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'The parameter is missing or invalid. %s', 'description' => '参数缺失或者参数无效。'], + ], + 403 => [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => '没有权限，请使用RAM进行授权'], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => '未找到指定资源。'], ], 500 => [ - [ - 'errorCode' => 'InternalUnknownError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => '服务运行错误。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '管理告警规则', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E5B1D3D4-BB28-5996-8AD2-***********\\"\\n}","type":"json"}]', - 'title' => '删除报警webhook', + 'ramActions' => [], ], - 'ListAlertWebhooks' => [ - 'summary' => '查询Webhook', - 'path' => '/webhooks', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'OpenCmsService' => [ + 'summary' => '开通云监控服务，包括企业云监控、Prometheus服务、SLS日志服务。', + 'path' => '/cmsservice', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'pageSize', - 'in' => 'query', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - 'default' => '100', + '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' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'enabled' => ['description' => '服务或商品是否开通。', 'type' => 'boolean', 'example' => 'true'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '开通CMS服务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'pageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '页码。默认值：1。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - 'default' => '1', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:OpenCmsService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'CmsService', 'arn' => 'acs:cms:*:{#accountId}:cmsservice/*'], + ], + ], + 'additionalActions' => [ + ['action' => 'log:EnableService', 'validationType' => 'always'], + ['action' => 'arms:OpenArmsService', 'validationType' => 'always'], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"enabled\\": true\\n}","type":"json"}]', + ], + 'PutWorkspace' => [ + 'path' => '/workspace/{workspaceName}', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'webhookIds', - 'in' => 'query', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'webhook唯一标识。', - 'type' => 'array', - 'items' => [ - 'description' => 'webhook唯一标识。', - 'type' => 'string', - 'required' => false, - 'example' => 'wh-def456uvw012', + 'title' => 'body参数', + 'description' => 'body参数', + 'type' => 'object', + 'properties' => [ + 'displayName' => ['title' => '', 'description' => '工作空间展示名称', 'type' => 'string', 'required' => false, 'example' => 'workspace-test', 'maxLength' => 256], + 'description' => ['title' => '工作空间描述', 'description' => '工作空间描述', 'type' => 'string', 'required' => false, 'example' => 'workspace test', 'maxLength' => 256, 'pattern' => '', 'default' => ''], + 'slsProject' => ['title' => '日志服务项目名称', 'description' => '日志服务项目名称', 'type' => 'string', 'required' => true, 'example' => 'sls-project-test-001', 'maxLength' => 128, 'minLength' => 1, 'default' => ''], ], 'required' => false, ], ], [ - 'name' => 'name', - 'in' => 'query', - 'schema' => [ - 'description' => 'webhook名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'workspace-test-001', 'maxLength' => 56, 'minLength' => 1], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应内容结构', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'pageNumber' => [ - 'description' => '页码，默认1。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'pageSize' => [ - 'description' => '分页大小。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '8A33DBEA-*****-*****-*****-*****', - ], - 'total' => [ - 'description' => '总条数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8', - ], - 'webhooks' => [ - 'description' => 'webhooks', - 'type' => 'array', - 'items' => [ - 'description' => 'webhook', - 'type' => 'object', - 'properties' => [ - 'contentType' => [ - 'description' => '数据内容类型。支持'."\n" - .'- JSON'."\n" - .'- FORM', - 'type' => 'string', - 'example' => 'JSON', - ], - 'headers' => [ - 'description' => 'headers', - 'type' => 'object', - 'example' => 'key', - ], - 'lang' => [ - 'description' => '语言。支持：'."\n" - .'- zh_CN'."\n" - .'- en_US', - 'type' => 'string', - 'example' => 'zh_CN', - ], - 'method' => [ - 'description' => '请求方法。支持'."\n" - .'- GET'."\n" - .'- POST', - 'type' => 'string', - 'example' => 'GET', - ], - 'name' => [ - 'description' => 'webhook名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'url' => [ - 'description' => '报警回调的URL地址。', - 'type' => 'string', - 'example' => 'http://aliyun.com/test', - ], - 'webhookId' => [ - 'description' => 'webhook唯一标识。', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'workspaceName' => ['description' => '工作空间名称', 'type' => 'string', 'example' => 'workspace-test-001'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => '%s is missing or invalid.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建修改工作空间', + 'summary' => '创建工作空间。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutWorkspace'], ], - 500 => [ - [ - 'errorCode' => 'InternalUnknownError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutWorkspace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Workspace', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspaceName}'], + ], ], + 'additionalActions' => [], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"requestId\\": \\"8A33DBEA-*****-*****-*****-*****\\",\\n \\"total\\": 8,\\n \\"webhooks\\": [\\n {\\n \\"contentType\\": \\"JSON\\",\\n \\"headers\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"lang\\": \\"zh_CN\\",\\n \\"method\\": \\"GET\\",\\n \\"name\\": \\"test\\",\\n \\"url\\": \\"http://aliyun.com/test\\",\\n \\"webhookId\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询报警webhook', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"workspaceName\\": \\"workspace-test-001\\"\\n}","type":"json"}]', ], - 'UpdateAlertWebhook' => [ - 'summary' => '更新Webhook', - 'path' => '/webhook/{webhookId}', - 'methods' => [ - 'patch', - ], - 'schemes' => [ - 'https', - ], + 'QueryAlertRules' => [ + 'path' => '/queryAlertRules', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'webhookId', - 'in' => 'path', - 'schema' => [ - 'description' => 'webhook唯一标识。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'name' => 'nextToken', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['title' => '标记当前开始读取的位置，置空表示从头开始', 'description' => '标记当前开始读取的位置，置空表示从头开始', 'type' => 'string', 'required' => false, 'example' => '123456'], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['title' => '本次读取的最大数据记录数量', 'description' => '本次读取的最大数据记录数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'clientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['title' => '幂等参数', 'description' => '幂等参数', 'type' => 'string', 'required' => false, 'example' => 'xxxxx-xxxx-xxxx'], ], [ 'name' => 'body', - 'in' => 'body', + 'in' => 'formData', 'style' => 'json', - 'schema' => [ - 'description' => '请求结构体。', - 'type' => 'object', - 'properties' => [ - 'contentType' => [ - 'description' => '数据内容类型。支持'."\n" - .'- JSON'."\n" - .'- FORM', - 'type' => 'string', - 'required' => false, - 'example' => 'JSON', - 'enum' => [ - 'JSON', - 'FORM', - ], - ], - 'headers' => [ - 'description' => 'headers', - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'key', - 'description' => 'header', - ], - ], - 'lang' => [ - 'description' => '语言。支持'."\n" - .'- zh_CN'."\n" - .'- en_US', - 'type' => 'string', - 'required' => false, - 'example' => 'zh_CN', - 'enum' => [ - 'zh_CN', - 'en_US', - ], - ], - 'method' => [ - 'description' => '请求方法。支持'."\n" - .'- GET'."\n" - .'- POST', - 'type' => 'string', - 'required' => false, - 'example' => 'GET', - 'enum' => [ - 'GET', - 'POST', - ], - ], - 'name' => [ - 'description' => 'webhook名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'url' => [ - 'description' => '报警回调的URL地址。', - 'type' => 'string', - 'required' => false, - 'example' => 'http://aliyun.com/test', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => '查询告警规则请求', 'required' => false, '$ref' => '#/components/schemas/QueryAlertRulesInput'], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '响应结果。', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '8A33DBEA-*****-*****-*****-*****', - ], - ], - ], + 'schema' => ['description' => '查询告警规则响应', '$ref' => '#/components/schemas/ServerResponseQueryAlertRulesResult'], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => '%s is missing or invalid.', - ], + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], + ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.', 'description' => '参数%s缺失或不合法。'], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'The parameter is missing or invalid. %s', 'description' => '参数缺失或者参数无效。'], ], - 404 => [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource %s is not found.', - ], + 403 => [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => '没有权限，请使用RAM进行授权'], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => '未找到指定资源。'], ], 500 => [ - [ - 'errorCode' => 'InternalUnknownError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => '服务运行错误。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询告警规则', + 'summary' => '查询告警规则', + 'description' => '本文将提供一个示例，查询报警模板列表。返回结果显示，报警模板列表中共有2个报警模板，分别是`ECS_Template1`和`ECS_Template2`。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8A33DBEA-*****-*****-*****-*****\\"\\n}","type":"json"}]', - 'title' => '更新报警webhook', + 'ramActions' => [], ], - 'UpdateNotifyStrategy' => [ - 'summary' => '更新通知策略', - 'path' => '/notifyStrategies/{notifyStrategyId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'SearchContext' => [ + 'summary' => '搜索上下文。', + 'path' => '/workspace/{workspace}/contextstore/{contextStoreName}/context/search', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspace', - 'in' => 'query', - 'schema' => [ - 'title' => '工作空间', - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => false, - 'example' => 'workspace-test', - ], + 'in' => 'path', + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'maxLength' => 64, 'minLength' => 2], + ], + [ + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => '上下文库名称', 'type' => 'string', 'required' => true, 'example' => 'test-context-store', 'maxLength' => 64, 'minLength' => 2], ], [ 'name' => 'body', 'in' => 'body', - 'allowEmptyValue' => false, + 'style' => 'json', 'schema' => [ - 'description' => '请求体参数。', + 'description' => '请求 Body', + 'type' => 'object', + 'properties' => [ + 'query' => ['description' => '查询内容', 'type' => 'string', 'required' => true, 'example' => 'How is the cost for consuming SLS logs in Flink calculated?'], + 'formatted' => ['description' => '是否格式化', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'filter' => [ + 'description' => '过滤条件', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'any', 'example' => '{'."\n" + .' "metadata.serviceName": "sls-sop-daily",'."\n" + .' "metadata.taskType": {'."\n" + .' "in": ["troubleshooting", "knowledge_retrieval"]'."\n" + .' }', 'description' => '过滤条件'], + ], + 'limit' => ['description' => '限定此次返回的数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], + 'threshold' => ['description' => '相似度阈值', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.3'], + 'retrievalOption' => ['description' => '检索选项', 'type' => 'string', 'required' => false, 'example' => 'reranker,llm_rank'], + ], 'required' => false, - '$ref' => '#/components/schemas/NotifyStrategyForModify', - ], - ], - [ - 'name' => 'notifyStrategyId', - 'in' => 'path', - 'schema' => [ - 'title' => '通知策略ID', - 'description' => '通知策略UUID', - 'type' => 'string', - 'required' => true, - 'example' => '12312-31-23-123-1-23123', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '响应内容结构', + 'description' => '响应数据', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求的唯一 ID，用于排查问题', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], - 'notifyStrategyId' => [ - 'title' => '通知策略ID', - 'description' => '通知策略UUID', - 'type' => 'string', - 'example' => '12312-31-23-123-1-23123', + 'requestId' => ['description' => '请求Id', 'type' => 'string', 'example' => '123-0F43-23423-AC43-34234'], + 'results' => [ + 'description' => '返回值', + 'type' => 'array', + 'items' => [ + 'description' => '返回值', + 'type' => 'object', + 'additionalProperties' => ['type' => 'any', 'description' => '返回值', 'example' => '{}'], + ], ], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], - [ - 'errorCode' => 'StrategyNameConflict', - 'errorMessage' => 'The specified strategy name exits already.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '搜索上下文', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalUnknownError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:SearchContext', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'ContextStore', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/contextstore/{#contextStoreName}'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"notifyStrategyId\\": \\"12312-31-23-123-1-23123\\"\\n}","type":"json"}]', - 'title' => '更新通知策略', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"123-0F43-23423-AC43-34234\\",\\n \\"results\\": [\\n {\\n \\"key\\": \\"{}\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'CreateTicket' => [ - 'summary' => '如果您需要将控制台页面免密分享给其他人或者嵌入到第三方系统，可以调用CreateTicket生成票据，然后拼接免密链接。', - 'path' => '/tickets', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'SearchMemories' => [ + 'summary' => '根据查询条件和筛选项来搜索记忆。', + 'path' => '/workspace/{workspace}/memorystore/{memoryStoreName}/memory/search', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'expirationTime', - 'in' => 'query', - 'schema' => [ - 'description' => '- 过期时间（秒），即内嵌页面URL链接过期时间，默认86400秒（一天），取值0~2592000秒（30天）。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '86400', - ], + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'maxLength' => 64, 'minLength' => 2], ], [ - 'name' => 'accessTokenExpirationTime', - 'in' => 'query', + 'name' => 'memoryStoreName', + 'in' => 'path', + 'schema' => ['description' => '内存库名称', 'type' => 'string', 'required' => true, 'example' => 'qianyi_test_1', 'maxLength' => 64, 'minLength' => 2], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '- 访问令牌过期时间（秒），即用户可以访问页面接口的过期时间，默认86400秒（一天），取值0~86400秒（一天）。'."\n" - .'- 访问令牌过期时间是accessTokenExpirationTime、expirationTime的最小值。'."\n" - .'- 若通过STS调用，访问令牌过期时间（即用户可以访问页面接口的时间）是accessTokenExpirationTime、expirationTime、STS过期时间的最小值。', - 'type' => 'integer', - 'format' => 'int64', + 'description' => '请求 body', + 'type' => 'object', + 'properties' => [ + 'query' => ['description' => '查询内容', 'type' => 'string', 'required' => false, 'example' => 'What I like'], + 'userId' => ['description' => '用户Id', 'type' => 'string', 'required' => false, 'example' => 'test_session_001'], + 'topK' => ['description' => '返回结果的Top-K条目', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'agentId' => ['description' => '代理标识号', 'type' => 'string', 'required' => false, 'example' => '972772996913709056'], + 'appId' => ['description' => '商户分配的项目的appkey', 'type' => 'string', 'required' => false, 'example' => 'mm_480d961a1b5e4efe84603f4cbc0f'], + 'runId' => ['description' => '运行id', 'type' => 'string', 'required' => false, 'example' => 'test_session_001'], + 'rerank' => ['description' => '重新排序', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'filters' => [ + 'title' => '过滤条件', + 'description' => '过滤条件', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['title' => '过滤条件', 'description' => '过滤条件', 'type' => 'any', 'example' => '{"__strategy_type__":"Fact"}'], + ], + 'threshold' => ['title' => '相似度阈值', 'description' => '相似度阈值', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.3'], + 'retrievalOption' => ['title' => '检索增强选项', 'description' => '检索选项', 'type' => 'string', 'required' => false, 'example' => 'reranker,llm_rank'], + 'searchType' => ['title' => '查询类型', 'description' => '查询类型', 'type' => 'string', 'required' => false, 'example' => 'experience'], + ], 'required' => false, - 'example' => '600', ], ], ], @@ -19655,52 +16466,81 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结构体', + 'description' => '响应数据', 'type' => 'object', 'properties' => [ - 'ticket' => [ - 'title' => 'Id of the request', - 'description' => '免登录票据', - 'type' => 'string', - 'example' => 'eyJ***************.eyJ******************.KUT****************', + 'results' => [ + 'description' => '返回值', + 'type' => 'array', + 'items' => [ + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'actorId' => ['description' => '操作者 Id', 'type' => 'string', 'example' => 'test_session_001'], + 'agentId' => ['description' => '应用的 agentId', 'type' => 'string', 'example' => '972772996913709056'], + 'createdAt' => ['description' => '创建时间', 'type' => 'string', 'example' => '1762773128968'], + 'hash' => ['description' => '记忆哈希值', 'type' => 'string', 'example' => 'd791bf27236c5532056a13279baad3517042bb8d5b1bdb02e7871fa632debffe'], + 'id' => ['description' => '记忆Id', 'type' => 'string', 'example' => '019ca1e5-7307-7d50-b943-5e628326a8ed'], + 'memory' => ['description' => '记忆', 'type' => 'string', 'example' => 'My name is Zhang San and I live in Hangzhou.'], + 'metadata' => [ + 'title' => '元数据', + 'description' => '元数据', + 'type' => 'object', + 'additionalProperties' => ['title' => '元数据', 'description' => '元数据', 'type' => 'any', 'example' => '{"__strategy_type__":"Fact"}'], + 'example' => '{"__strategy_type__":"Fact"}', + ], + 'role' => ['description' => '消息发起角色', 'type' => 'string', 'example' => 'user'], + 'runId' => ['description' => '运行id', 'type' => 'string', 'example' => 'test_session_001'], + 'score' => ['description' => '相似性分数', 'type' => 'number', 'format' => 'double', 'example' => '13.21'], + 'updatedAt' => ['description' => '更新时间', 'type' => 'string', 'example' => '1764902557784'], + 'userId' => ['description' => '用户Id', 'type' => 'string', 'example' => 'test_session_001'], + ], + ], + ], + 'relations' => [ + 'description' => '关系', + 'type' => 'array', + 'items' => [ + 'description' => '关系', + 'type' => 'object', + 'properties' => [ + 'destination' => ['description' => '目标', 'type' => 'string', 'example' => 'test'], + 'relationship' => ['description' => '关系', 'type' => 'string', 'example' => 'test'], + 'source' => ['description' => '源', 'type' => 'string', 'example' => 'todo_open_dingoj06pvqfeayy3lkr'], + ], + ], ], + 'requestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '搜索记忆', + 'description' => '本文将提供一个示例，为云服务器ECS `acs_ecs_dashboard`的实例`i-uf6j91r34rnwawoo****`中的监控项`cpu_total`设置阈值报警规则。该报警规则的报警联系组为`ECS_Group`、报警规则名称为`test123`、报警规则ID为`a151cd6023eacee2f0978e03863cc1697c89508****`、Critical级别的统计方法为`Average`、Critical级别的比较符为`GreaterThanOrEqualToThreshold`、Critical级别的阈值为`90`和Critical级别的报警重试次数为`3`。'."\n" + .'> 2024-08-15 增加Statistics校验，统计值只能填对应指标的Statistics。关于如何获取该参数的取值，请参见[云产品监控项](https://help.aliyun.com/zh/cms/support/appendix-1-metrics)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ticket\\": \\"eyJ***************.eyJ******************.KUT****************\\"\\n}","type":"json"}]', - 'title' => '创建免登录票据', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"results\\": [\\n {\\n \\"actorId\\": \\"test_session_001\\",\\n \\"agentId\\": \\"972772996913709056\\",\\n \\"createdAt\\": \\"1762773128968\\",\\n \\"hash\\": \\"d791bf27236c5532056a13279baad3517042bb8d5b1bdb02e7871fa632debffe\\",\\n \\"id\\": \\"019ca1e5-7307-7d50-b943-5e628326a8ed\\",\\n \\"memory\\": \\"My name is Zhang San and I live in Hangzhou.\\",\\n \\"metadata\\": {\\n \\"key\\": \\"{\\\\\\"__strategy_type__\\\\\\":\\\\\\"Fact\\\\\\"}\\"\\n },\\n \\"role\\": \\"user\\",\\n \\"runId\\": \\"test_session_001\\",\\n \\"score\\": 13.21,\\n \\"updatedAt\\": \\"1764902557784\\",\\n \\"userId\\": \\"test_session_001\\"\\n }\\n ],\\n \\"relations\\": [\\n {\\n \\"destination\\": \\"test\\",\\n \\"relationship\\": \\"test\\",\\n \\"source\\": \\"todo_open_dingoj06pvqfeayy3lkr\\"\\n }\\n ],\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', ], 'TagResources' => [ - 'summary' => '打标签接口', 'path' => '/tags', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'body', @@ -19710,23 +16550,12 @@ 'description' => '请求体', 'type' => 'object', 'properties' => [ - 'resourceType' => [ - 'title' => '资源类型', - 'description' => '资源类型', - 'type' => 'string', - 'required' => true, - 'example' => 'Service', - ], + 'resourceType' => ['title' => '资源类型', 'description' => '资源类型', 'type' => 'string', 'required' => true, 'example' => 'Service'], 'resourceId' => [ 'title' => '资源ID,最多 50个子项', 'description' => '资源ID列表', 'type' => 'array', - 'items' => [ - 'description' => '资源ID', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'items' => ['description' => '资源ID', 'type' => 'string', 'required' => false, 'example' => 'test'], 'required' => true, 'maxItems' => 50, 'minItems' => 1, @@ -19737,11 +16566,7 @@ ."\n" .'最多可以绑定 20 个标签', 'type' => 'array', - 'items' => [ - 'description' => '标签', - 'required' => false, - '$ref' => '#/components/schemas/Tag', - ], + 'items' => ['description' => '标签', 'required' => false, '$ref' => '#/components/schemas/Tag'], 'required' => false, 'maxItems' => 20, ], @@ -19757,140 +16582,67 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求id', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '3B311FD9-A60B-55E0-A896-A0C73*********', - ], + 'requestId' => ['title' => '请求id', 'description' => '请求ID', 'type' => 'string', 'example' => '3B311FD9-A60B-55E0-A896-A0C73*********'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.ResourceId', - 'errorMessage' => 'The ResourceId parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidResourceId.NotFound', - 'errorMessage' => 'The specified ResourceIds are not found in our records.', - ], - [ - 'errorCode' => 'NumberExceed.ResourceIds', - 'errorMessage' => 'The maximum number of ResourceIds is exceeded.', - ], - [ - 'errorCode' => 'InvalidParameter.RegionId', - 'errorMessage' => 'The RegionId parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.ResourceType', - 'errorMessage' => 'The ResourceType parameter is invalid.', - ], - [ - 'errorCode' => 'MissingParameter.ResourceIds', - 'errorMessage' => 'You must specify ResourceId.N.', - ], - [ - 'errorCode' => 'MissingParameter.ResourceType', - 'errorMessage' => 'You must specify ResourceType.', - ], - [ - 'errorCode' => 'MissingParameter.Tags', - 'errorMessage' => 'You must specify Tags.', - ], - [ - 'errorCode' => 'MissingParameter.TagKey', - 'errorMessage' => 'You must specify Tag.N.Key.', - ], - [ - 'errorCode' => 'MissingParameter.TagValue', - 'errorMessage' => 'You must specify Tag.N.Value.', - ], - [ - 'errorCode' => 'InvalidParameter.TagKey', - 'errorMessage' => 'The Tag.N.Key parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.TagValue', - 'errorMessage' => 'The Tag.N.Value parameter is invalid.', - ], - [ - 'errorCode' => 'NumberExceed.Tags', - 'errorMessage' => 'The maximum number of Tags is exceeded.', - ], - [ - 'errorCode' => 'QuotaExceed.TagsPerResource', - 'errorMessage' => 'The maximum number of tags for each resource is exceeded.', - ], - [ - 'errorCode' => 'Duplicate.TagKey', - 'errorMessage' => 'The Tag.N.Key contains duplicate keys.', - ], + ['errorCode' => 'InvalidParameter.ResourceId', 'errorMessage' => 'The ResourceId parameter is invalid.', 'description' => ''], + ['errorCode' => 'InvalidResourceId.NotFound', 'errorMessage' => 'The specified ResourceIds are not found in our records.', 'description' => ''], + ['errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The maximum number of ResourceIds is exceeded.', 'description' => ''], + ['errorCode' => 'InvalidParameter.RegionId', 'errorMessage' => 'The RegionId parameter is invalid.', 'description' => ''], + ['errorCode' => 'InvalidParameter.ResourceType', 'errorMessage' => 'The ResourceType parameter is invalid.', 'description' => ''], + ['errorCode' => 'MissingParameter.ResourceIds', 'errorMessage' => 'You must specify ResourceId.N.', 'description' => ''], + ['errorCode' => 'MissingParameter.ResourceType', 'errorMessage' => 'You must specify ResourceType.', 'description' => ''], + ['errorCode' => 'MissingParameter.Tags', 'errorMessage' => 'You must specify Tags.', 'description' => ''], + ['errorCode' => 'MissingParameter.TagKey', 'errorMessage' => 'You must specify Tag.N.Key.', 'description' => ''], + ['errorCode' => 'MissingParameter.TagValue', 'errorMessage' => 'You must specify Tag.N.Value.', 'description' => ''], + ['errorCode' => 'InvalidParameter.TagKey', 'errorMessage' => 'The Tag.N.Key parameter is invalid.', 'description' => ''], + ['errorCode' => 'InvalidParameter.TagValue', 'errorMessage' => 'The Tag.N.Value parameter is invalid.', 'description' => ''], + ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The maximum number of Tags is exceeded.', 'description' => ''], + ['errorCode' => 'QuotaExceed.TagsPerResource', 'errorMessage' => 'The maximum number of tags for each resource is exceeded.', 'description' => ''], + ['errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The Tag.N.Key contains duplicate keys.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'The operator is not permission for this operate', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'The operator is not permission for this operate', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InvalidOperation.ConcurrentModification', - 'errorMessage' => 'The resource is modified concurrently.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InvalidOperation.ConcurrentModification', 'errorMessage' => 'The resource is modified concurrently.', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '绑定标签', + 'summary' => '打标签接口', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3B311FD9-A60B-55E0-A896-A0C73*********\\"\\n}","type":"json"}]', - 'title' => '绑定标签', ], 'UntagResources' => [ - 'summary' => '删标签接口', 'path' => '/tags', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'resourceType', 'in' => 'query', - 'schema' => [ - 'title' => '资源类型', - 'description' => '资源类型', - 'type' => 'string', - 'required' => true, - 'example' => 'Service', - ], + 'schema' => ['title' => '资源类型', 'description' => '资源类型', 'type' => 'string', 'required' => true, 'example' => 'Service'], ], [ 'name' => 'resourceId', @@ -19900,12 +16652,7 @@ 'title' => '资源ID,最多 50个子项', 'description' => '资源ID列表', 'type' => 'array', - 'items' => [ - 'description' => '资源ID', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'items' => ['description' => '资源ID', 'type' => 'string', 'required' => false, 'example' => 'test'], 'required' => true, 'maxItems' => 50, 'minItems' => 1, @@ -19921,29 +16668,17 @@ ."\n" .'最多可以解绑 20 个标签键', 'type' => 'array', - 'items' => [ - 'description' => '标签键', - 'type' => 'string', - 'required' => false, - 'example' => 'env', - ], + 'items' => ['description' => '标签键', 'type' => 'string', 'required' => false, 'example' => 'env'], 'required' => false, ], ], [ 'name' => 'all', 'in' => 'query', - 'schema' => [ - 'title' => '是否全部删除，只针对tags为空时有效。取值范围： true false True False 默认是 false', - 'description' => '是否解绑指定资源的全部标签。取值：'."\n" - ."\n" - .'false（默认值）：否'."\n" - .'true：是', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'schema' => ['title' => '是否全部删除，只针对tags为空时有效。取值范围： true false True False 默认是 false', 'description' => '是否解绑指定资源的全部标签。取值：'."\n" + ."\n" + .'false（默认值）：否'."\n" + .'true：是', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], ], ], 'responses' => [ @@ -19953,346 +16688,412 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求id', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], + 'requestId' => ['title' => '请求id', 'description' => '请求ID', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.ResourceType', - 'errorMessage' => 'The ResourceType parameter is invalid.', - ], - [ - 'errorCode' => 'MissingParameter.ResourceIds', - 'errorMessage' => 'You must specify ResourceId.N.', - ], - [ - 'errorCode' => 'MissingParameter.ResourceType', - 'errorMessage' => 'You must specify ResourceType.', - ], - [ - 'errorCode' => 'InvalidParameter.TagKey', - 'errorMessage' => 'The Tag.N.Key parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.TagKeysOrDeleteAll', - 'errorMessage' => 'The TagKeys or DeleteAll parameter is invalid.', - ], - [ - 'errorCode' => 'NumberExceed.ResourceIds', - 'errorMessage' => 'The maximum number of ResourceIds is exceeded.', - ], - [ - 'errorCode' => 'NumberExceed.TagKeys', - 'errorMessage' => 'The maximum number of TagKeys is exceeded.', - ], - [ - 'errorCode' => 'Duplicate.TagKey', - 'errorMessage' => 'The Tag.N.Key contains duplicate keys.', - ], - [ - 'errorCode' => 'InvalidResourceId.NotFound', - 'errorMessage' => 'The specified ResourceIds are not found in our records.', - ], + ['errorCode' => 'InvalidParameter.ResourceType', 'errorMessage' => 'The ResourceType parameter is invalid.', 'description' => ''], + ['errorCode' => 'MissingParameter.ResourceIds', 'errorMessage' => 'You must specify ResourceId.N.', 'description' => ''], + ['errorCode' => 'MissingParameter.ResourceType', 'errorMessage' => 'You must specify ResourceType.', 'description' => ''], + ['errorCode' => 'InvalidParameter.TagKey', 'errorMessage' => 'The Tag.N.Key parameter is invalid.', 'description' => ''], + ['errorCode' => 'InvalidParameter.TagKeysOrDeleteAll', 'errorMessage' => 'The TagKeys or DeleteAll parameter is invalid.', 'description' => ''], + ['errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The maximum number of ResourceIds is exceeded.', 'description' => ''], + ['errorCode' => 'NumberExceed.TagKeys', 'errorMessage' => 'The maximum number of TagKeys is exceeded.', 'description' => ''], + ['errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The Tag.N.Key contains duplicate keys.', 'description' => ''], + ['errorCode' => 'InvalidResourceId.NotFound', 'errorMessage' => 'The specified ResourceIds are not found in our records.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'The operator is not permission for this operate ', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'The operator is not permission for this operate ', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '解绑标签', + 'summary' => '删标签接口', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', - 'title' => '解绑标签', ], - 'ListTagResources' => [ - 'summary' => '查标签接口。', - 'path' => '/tags', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'UpdateAddonRelease' => [ + 'path' => '/integration-policies/{policyId}/addon-releases/{releaseName}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'resourceType', - 'in' => 'query', - 'schema' => [ - 'title' => '资源类型', - 'description' => '资源类型', - 'type' => 'string', - 'required' => true, - 'example' => 'Service', - ], + 'name' => 'releaseName', + 'in' => 'path', + 'schema' => ['title' => 'Release 的名称。', 'description' => 'Release 的名称。', 'type' => 'string', 'required' => true, 'example' => 'test-gpu-integration-name'], ], [ - 'name' => 'resourceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => '资源ID,最多 50个子项', - 'description' => '资源ID列表', - 'type' => 'array', - 'items' => [ - 'description' => '资源ID', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'addonVersion' => ['title' => 'Addon 的版本信息。', 'description' => 'Addon 的版本信息。', 'type' => 'string', 'required' => false, 'example' => '0.0.2'], + 'dryRun' => [ + 'title' => '是否预检本次请求。', + 'description' => '是否预检本次请求。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => ['true' => '是', 'false' => '否'], + 'example' => 'true', + ], + 'values' => ['title' => '元数据信息。', 'description' => '元数据。', 'type' => 'string', 'required' => false, 'example' => '{"install":{"mode":"auto-install","listenPort":"9400"},"discoverMode":"instances","discover":{"instances":"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44"},"scrapeInterval":"15","enableSecuritecs-nodeyGroupInjection":"true","metricTags":""}'], + 'entityRules' => ['title' => '实体发现规则。', 'description' => '实体发现规则。', 'required' => false, '$ref' => '#/components/schemas/EntityDiscoverRule'], ], 'required' => false, ], ], [ - 'name' => 'tag', - 'in' => 'query', - 'style' => 'json', + 'name' => 'policyId', + 'in' => 'path', + 'schema' => ['title' => '策略环境 ID。', 'description' => '策略环境 ID。', 'type' => 'string', 'required' => true, 'example' => 'policy-xxxxxxxxxxxx'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '对应新增标签列表，最多包含20个子项', - 'description' => '标签。查询的过滤条件。'."\n" - ."\n" - .'最多可以指定 20 个标签。', - 'type' => 'array', - 'items' => [ - 'description' => '标签。查询的过滤条件。'."\n" - ."\n" - .'最多可以指定 20 个标签。', - 'required' => false, - '$ref' => '#/components/schemas/Tag', + 'title' => 'Schema of Response', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '9F00A7AF-2728-5424-B321-79D39C00A1EC'], ], - 'required' => false, ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新接入组件配置', + 'summary' => '升级接入组件', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAddonRelease'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'nextToken', - 'in' => 'query', - 'schema' => [ - 'title' => '下一个查询开始Token', - 'description' => '下一个查询开始Token', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxxxxxxx', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpdateAddonRelease', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'AddonRelease', 'arn' => 'acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#PolicyId}/addonrelease/{#ReleaseName}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9F00A7AF-2728-5424-B321-79D39C00A1EC\\"\\n}","type":"json"}]', + ], + 'UpdateAggTaskGroup' => [ + 'path' => '/prometheus-instances/{instanceId}/agg-task-groups/{groupId}', + 'methods' => ['put'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'maxResults', - 'in' => 'query', - 'schema' => [ - 'description' => '最大返回结果数，最大值200', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'AK' => [], ], ], - 'responses' => [ - 200 => [ + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['title' => '聚合任务组所属的 Prometheus 实例的 id，聚合任务从这个实例中读取数据', 'description' => '聚合任务组所属的 Prometheus 实例ID。聚合任务从这个实例中读取数据。', 'type' => 'string', 'required' => true, 'example' => 'rw-pq4apob9jm'], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => ['title' => '聚合任务组 id', 'description' => '聚合任务组ID。', 'type' => 'string', 'required' => true, 'example' => 'aggTaskGroup-xxxx'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '入参结构体', + 'description' => '入参结构体。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求id', - 'description' => '请求ID', + 'aggTaskGroupConfig' => ['title' => '聚合任务组配置。目前仅支持 “RecordingRuleYaml” 格式，要求符合开源 Prometheus 的 RecordingRule 的格式要求', 'description' => '聚合任务组配置。目前仅支持 “RecordingRuleYaml” 格式，要求符合开源 Prometheus 的 RecordingRule 的格式要求。', 'type' => 'string', 'required' => true, 'example' => 'groups:'."\n" + .'- name: "node.rules"'."\n" + .' interval: "60s"'."\n" + .' rules:'."\n" + .' - record: "node_namespace_pod:kube_pod_info:"'."\n" + .' expr: "max(label_replace(kube_pod_info{job=\\"kubernetes-pods-kube-state-metrics\\"\\'."\n" + .' }, \\"pod\\", \\"$1\\", \\"pod\\", \\"(.*)\\")) by (node, namespace, pod, cluster)"'], + 'aggTaskGroupConfigType' => ['title' => '聚合任务组配置类型，默认 “RecordingRuleYaml”（开源 Prometheus 的 RecordingRule 格式）', 'description' => '聚合任务组配置类型，默认 “RecordingRuleYaml”（开源 Prometheus 的 RecordingRule 格式）。', 'type' => 'string', 'required' => false, 'example' => 'RecordingRuleYaml', 'default' => 'RecordingRuleYaml'], + 'aggTaskGroupName' => ['title' => '聚合任务组名称', 'description' => '聚合任务组名称。', 'type' => 'string', 'required' => false, 'example' => 'test-group'], + 'cronExpr' => ['title' => '调度模式选择“Cron”情况下，具体的调度表达式。例如“0/1 * * * *”，表示从 0 分开始，每隔 1 分钟调度一次', 'description' => '调度模式选择“Cron”情况下，具体的调度表达式。例如“0/1 * * * *”，表示从 0 分开始，每隔 1 分钟调度一次。', 'type' => 'string', 'required' => false, 'example' => '0/1 * * * *'], + 'delay' => ['title' => '调度的固定延迟时间，单位：秒，默认 30', 'description' => '调度的固定延迟时间，单位：秒，默认 30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '120', 'minimum' => '0', 'example' => '30', 'default' => '30'], + 'description' => ['title' => '聚合任务组描述', 'description' => '聚合任务组描述。', 'type' => 'string', 'required' => false, 'example' => 'desc'], + 'fromTime' => ['title' => '调度开始时间对应的的秒级时间戳', 'description' => '调度开始时间对应的的秒级时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1724996015'], + 'maxRetries' => ['title' => '执行聚合任务的最大重试次数，默认 20', 'description' => '执行聚合任务的最大重试次数，默认 20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'default' => '20'], + 'maxRunTimeInSeconds' => ['title' => '执行聚合任务的最大重试时间，单位：秒，默认 600', 'description' => '执行聚合任务的最大重试时间，单位：秒，默认 600。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '600', 'default' => '600'], + 'precheckString' => ['title' => '预检测配置，默认不配置。输入的字符串需要能被正确 JSON 解析', 'description' => '预检测配置，默认不配置。输入的字符串需要能被正确 JSON 解析。', 'type' => 'string', 'required' => false, 'example' => '{"policy":"skip","prometheusId":"xxx","query":"scalar(sum(count_over_time(up{job=\\"_arms/kubelet/cadvisor\\"}[15s])) / 21)","threshold":0.5,"timeout":15,"type":"promql"}'], + 'scheduleMode' => [ + 'title' => '调度模式，“Cron” 或 “FixedRate”，默认 “FixedRate”', + 'description' => '调度模式，“Cron” 或 “FixedRate”，默认 “FixedRate”。', 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-***', - ], - 'maxResults' => [ - 'title' => '列表最大数量', - 'description' => '最大返回结果数，最大值200', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', + 'required' => false, + 'example' => 'FixedRate', + 'default' => 'FixedRate', + 'enum' => ['FixedRate', 'Cron'], ], - 'nextToken' => [ - 'title' => '下一个查询开始Token', - 'description' => '下一个查询开始Token', + 'scheduleTimeExpr' => ['title' => '调度时间表达式，推荐 “@s” 或者 “@m”，表示调度时间窗口对齐的粒度，默认 “@m”', 'description' => '调度时间表达式，推荐 “@s” 或者 “@m”，表示调度时间窗口对齐的粒度，默认 “@m”。', 'type' => 'string', 'required' => false, 'example' => '@m', 'default' => '@m'], + 'status' => [ + 'title' => '聚合任务组状态，“Running” 或者 “Stopped”。默认 Running', + 'description' => '聚合任务组状态，“Running” 或者 “Stopped”。默认 Running。', 'type' => 'string', - 'example' => 'xxxxxxxxxx', + 'required' => false, + 'example' => 'Running', + 'default' => 'Running', + 'enum' => ['Running', 'Stopped'], ], - 'tagResources' => [ - 'title' => '资源列表', - 'description' => '标签列表', + 'tags' => [ + 'title' => '资源组标签', + 'description' => '资源组标签。', 'type' => 'array', 'items' => [ - 'description' => '标签列表', + 'description' => '标签。', 'type' => 'object', 'properties' => [ - 'tagKey' => [ - 'title' => '标签键', - 'description' => '标签键', - 'type' => 'string', - 'example' => 'env', - ], - 'tagValue' => [ - 'title' => '标签值', - 'description' => '标签值', - 'type' => 'string', - 'example' => 'test', - ], - 'resourceId' => [ - 'title' => '资源ID', - 'description' => '资源ID', - 'type' => 'string', - 'example' => 'test', - ], - 'resourceType' => [ - 'title' => '资源类型', - 'description' => '资源类型', - 'type' => 'string', - 'example' => 'Service', - ], + 'key' => ['title' => '资源组标签的键', 'description' => '资源组标签的键。', 'type' => 'string', 'required' => false, 'example' => 'key1'], + 'value' => ['title' => '资源组标签的值', 'description' => '资源组标签的值。', 'type' => 'string', 'required' => false, 'example' => 'value1'], ], + 'required' => false, ], + 'required' => false, ], + 'targetPrometheusId' => ['title' => '聚合任务组的目标 Prometheus 实例 id', 'description' => '聚合任务组的目标 Prometheus 实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rw-pq4apob9jm'], + 'toTime' => ['title' => '调度结束时间对应的秒级时间戳，0 表示不停止调度', 'description' => '调度结束时间对应的秒级时间戳，0 表示不停止调度。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], ], + 'required' => false, ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter.ResourceType', - 'errorMessage' => 'The ResourceType parameter is invalid.', - ], - [ - 'errorCode' => 'MissingParameter.ResourceIdsOrTags', - 'errorMessage' => 'You must specify ResourceId.N or Tags.', - ], - [ - 'errorCode' => 'MissingParameter.ResourceType', - 'errorMessage' => 'You must specify ResourceType.', - ], - [ - 'errorCode' => 'MissingParameter.TagKey', - 'errorMessage' => 'You must specify Tag.N.Key.', - ], - [ - 'errorCode' => 'NumberExceed.ResourceIds', - 'errorMessage' => 'The maximum number of ResourceIds is exceeded.', - ], - [ - 'errorCode' => 'NumberExceed.Tags', - 'errorMessage' => 'The maximum number of Tags is exceeded.', - ], - [ - 'errorCode' => 'Duplicate.TagKey', - 'errorMessage' => 'The Tag.N.Key contains duplicate keys.', - ], - [ - 'errorCode' => 'InvalidParameter.NextToken', - 'errorMessage' => 'The NextToken parameter is invalid.', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '出参结构体', + 'description' => '出参结构体', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '请求 id', 'description' => '请求 id', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'aggTaskGroupConfigHash' => ['title' => '聚合任务组配置的摘要', 'description' => '聚合任务组配置的摘要', 'type' => 'string', 'example' => 'a54136014dc386a92c83a6ef1e97ff22'], + 'aggTaskGroupId' => ['title' => '聚合任务组 id', 'description' => '聚合任务组 id', 'type' => 'string', 'example' => 'aggTaskGroup-5fb2c3ade63a4709bcb059d13493b7b8'], + 'aggTaskGroupName' => ['title' => '聚合任务组名称', 'description' => '聚合任务组名称', 'type' => 'string', 'example' => 'pipeline-aggtask-group'], + 'sourcePrometheusId' => ['title' => '聚合任务组的源 Prometheus 实例 id', 'description' => '聚合任务组的源 Prometheus 实例 id', 'type' => 'string', 'example' => 'rw-083e17834e279f8c627fe91a2d72'], + 'status' => ['title' => '聚合任务组的当前状态', 'description' => '聚合任务组的当前状态', 'type' => 'string', 'example' => 'Running'], + ], ], ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'The operator is not permission for this operate', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新聚合任务组', + 'summary' => '应用聚合任务组。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAggTaskGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpdateAggTaskGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'AggTaskGroup', 'arn' => 'acs:cms:{#regionId}:{#accountId}:prometheusinstance/{#sourcePrometheusId}/aggtaskgroup/{#aggTaskGroupId}'], + ], ], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"aggTaskGroupConfigHash\\": \\"a54136014dc386a92c83a6ef1e97ff22\\",\\n \\"aggTaskGroupId\\": \\"aggTaskGroup-5fb2c3ade63a4709bcb059d13493b7b8\\",\\n \\"aggTaskGroupName\\": \\"pipeline-aggtask-group\\",\\n \\"sourcePrometheusId\\": \\"rw-083e17834e279f8c627fe91a2d72\\",\\n \\"status\\": \\"Running\\"\\n}","type":"json"}]', + ], + 'UpdateAggTaskGroupStatus' => [ + 'path' => '/prometheus-instances/{instanceId}/agg-task-groups/{groupId}/status', + 'methods' => ['put'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['title' => '聚合任务组所属的 Prometheus 实例的 id，聚合任务从这个实例中读取数据', 'description' => '聚合任务组所属的 Prometheus 实例的ID。聚合任务从这个实例中读取数据。', 'type' => 'string', 'required' => true, 'example' => 'rw-pq4apob9jm'], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => ['title' => '聚合任务组 id', 'description' => '聚合任务组ID。', 'type' => 'string', 'required' => true, 'example' => 'aggTaskGroup-xxx'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '入参结构体', + 'description' => '入参结构体。', + 'type' => 'object', + 'properties' => [ + 'status' => [ + 'title' => '聚合任务组状态，“Running” 或者 “Stopped”。默认 Running', + 'description' => '聚合任务组状态，“Running” 或者 “Stopped”。默认 Running。', + 'type' => 'string', + 'required' => true, + 'example' => 'Running', + 'enum' => ['Running', 'Stopped'], + ], + ], + 'required' => false, ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '出参结构体', + 'description' => '出参结构体。', + 'type' => 'object', + 'properties' => [ + 'aggTaskGroupConfigHash' => ['title' => '聚合任务组配置的摘要', 'description' => '聚合任务组配置的摘要。', 'type' => 'string', 'example' => 'a54136014dc386a92c83a6ef1e97ff22'], + 'aggTaskGroupId' => ['title' => '聚合任务组 id', 'description' => '聚合任务组ID。', 'type' => 'string', 'example' => 'aggTaskGroup-xxx'], + 'aggTaskGroupName' => ['title' => '聚合任务组名称', 'description' => '聚合任务组名称。', 'type' => 'string', 'example' => 'pipeline-aggtask-group'], + 'requestId' => ['title' => '请求 id', 'description' => '请求ID。', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-***'], + 'sourcePrometheusId' => ['title' => '聚合任务组的源 Prometheus 实例 id', 'description' => '聚合任务组的源 Prometheus 实例ID。', 'type' => 'string', 'example' => 'rw-xxx'], + 'status' => ['title' => '聚合任务组的当前状态', 'description' => '聚合任务组的当前状态。', 'type' => 'string', 'example' => 'Running'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-***\\",\\n \\"maxResults\\": 20,\\n \\"nextToken\\": \\"xxxxxxxxxx\\",\\n \\"tagResources\\": [\\n {\\n \\"tagKey\\": \\"env\\",\\n \\"tagValue\\": \\"test\\",\\n \\"resourceId\\": \\"test\\",\\n \\"resourceType\\": \\"Service\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询标签列表', - ], - 'ChangeResourceGroup' => [ - 'summary' => '修改资源所属资源组', - 'path' => '/resourcegroup', - 'methods' => [ - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新聚合任务组状态', + 'summary' => '更新聚合任务组状态。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAggTaskGroupStatus'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpdateAggTaskGroupStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'AggTaskGroup', 'arn' => 'acs:cms:{#regionId}:{#accountId}:prometheusinstance/{#sourcePrometheusId}/aggtaskgroup/{#aggTaskGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"aggTaskGroupConfigHash\\": \\"a54136014dc386a92c83a6ef1e97ff22\\",\\n \\"aggTaskGroupId\\": \\"aggTaskGroup-xxx\\",\\n \\"aggTaskGroupName\\": \\"pipeline-aggtask-group\\",\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-***\\",\\n \\"sourcePrometheusId\\": \\"rw-xxx\\",\\n \\"status\\": \\"Running\\"\\n}","type":"json"}]', + ], + 'UpdateAlertWebhook' => [ + 'path' => '/webhook/{webhookId}', + 'methods' => ['patch'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ + 'name' => 'webhookId', + 'in' => 'path', + 'schema' => ['description' => 'webhook唯一标识。', 'type' => 'string', 'required' => true, 'example' => 'test'], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求体', + 'description' => '请求结构体。', 'type' => 'object', 'properties' => [ - 'resourceType' => [ - 'description' => '资源类型', + 'contentType' => [ + 'description' => '数据内容类型。支持'."\n" + .'- JSON'."\n" + .'- FORM', 'type' => 'string', 'required' => false, - 'example' => 'Service', + 'example' => 'JSON', + 'enum' => ['JSON', 'FORM'], ], - 'resourceId' => [ - 'description' => '资源ID', + 'headers' => [ + 'description' => 'headers', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'example' => 'key', 'description' => 'header'], + ], + 'lang' => [ + 'description' => '语言。支持'."\n" + .'- zh_CN'."\n" + .'- en_US', 'type' => 'string', 'required' => false, - 'example' => 'test', + 'example' => 'zh_CN', + 'enum' => ['zh_CN', 'en_US'], ], - 'resourceGroupId' => [ - 'description' => '资源组ID', + 'method' => [ + 'description' => '请求方法。支持'."\n" + .'- GET'."\n" + .'- POST', 'type' => 'string', 'required' => false, - 'example' => 'rg-ae******ey', + 'example' => 'GET', + 'enum' => ['GET', 'POST'], ], + 'name' => ['description' => 'webhook名称。', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'url' => ['description' => '报警回调的URL地址。', 'type' => 'string', 'required' => false, 'example' => 'http://aliyun.com/test'], ], 'required' => false, ], @@ -20302,71 +17103,70 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '响应结果。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '8A33DBEA-*****-*****-*****-*****'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', - 'title' => '修改资源组', - ], - 'DescribeRegions' => [ - 'summary' => '查询地域信息列表', - 'path' => '/regions', - 'methods' => [ - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.', 'description' => '参数%s缺失或不合法。'], + ], + 404 => [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource %s is not found.', 'description' => '指定资源%s不存在。'], + ], + 500 => [ + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => '服务运行错误。'], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新报警webhook', + 'summary' => '更新Webhook', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8A33DBEA-*****-*****-*****-*****\\"\\n}","type":"json"}]', + ], + 'UpdateBizTrace' => [ + 'path' => '/bizTrace/{bizTraceId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'language', - 'in' => 'query', + 'name' => 'bizTraceId', + 'in' => 'path', + 'schema' => ['description' => '业务链路id', 'type' => 'string', 'required' => false, 'example' => 'e339260ed64c95d'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '语言，取值：'."\n" - ."\n" - .'- zh：中文（默认值）'."\n" - .'- en：英文'."\n" - .'- ja：日文', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'ja' => 'ja', - 'en' => 'en', - 'zh' => 'zh', + 'description' => '请求body。', + 'type' => 'object', + 'properties' => [ + 'bizTraceName' => ['description' => '业务链路名称', 'type' => 'string', 'required' => false, 'example' => 'just test'], + 'workspace' => ['description' => '工作空间。', 'type' => 'string', 'required' => false, 'example' => 'default-cms-xxxxxxx-cn-hangzhou'], + 'ruleConfig' => ['description' => '配置规则列表', 'type' => 'string', 'required' => false, 'example' => '[{"entrancePid":"xxx@d9w3jd9j3","rpcMatcher":{"matchType":"EQUALS","pattern":"/"},"characteristics":{"operation":"OR","rules":[{"target":"CUSTOM_EXTRACT","id":"oi0b3bb7","key":"biz.test","matcher":{"matchType":"CONTAINS","pattern":["1"]}}]}}]'], + 'advancedConfig' => ['description' => '高级配置', 'type' => 'string', 'required' => false, 'example' => '{"sample":{"strategy":"BY_APP"}}'], ], - 'example' => 'zh', + 'required' => false, ], ], ], @@ -20377,116 +17177,242 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], - 'regions' => [ - 'description' => '地域信息列表', - 'type' => 'array', - 'items' => [ - 'description' => '地域信息', - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'description' => '区域ID', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'localName' => [ - 'description' => '地域名称', - 'type' => 'string', - 'example' => 'China (Beijing)', - ], - ], - ], - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求 ID。', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'bizTraceId' => ['description' => '业务链路id', 'type' => 'string', 'example' => 'e339260ed64c95d'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改业务链路', + 'summary' => '修改业务链路', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"regions\\": [\\n {\\n \\"regionId\\": \\"cn-beijing\\",\\n \\"localName\\": \\"China (Beijing)\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询地域列表', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"bizTraceId\\": \\"e339260ed64c95d\\"\\n}","type":"json"}]', ], - 'GetCmsService' => [ - 'summary' => '检查Prometheus服务或商品开通状态。', - 'path' => '/cmsservice', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'UpdateContext' => [ + 'path' => '/workspace/{workspace}/contextstore/{contextStoreName}/context/{contextId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'maxLength' => 64, 'minLength' => 2], + ], + [ + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => '上下文库名称', 'type' => 'string', 'required' => true, 'example' => 'test-context-store', 'maxLength' => 64, 'minLength' => 2], + ], + [ + 'name' => 'contextId', + 'in' => 'path', + 'schema' => ['description' => '上下文Id', 'type' => 'string', 'required' => true, 'example' => '897294a7-67a4-4f60-976c-e136edc5f97e', 'minLength' => 1], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'content' => ['description' => '更新长期记忆文本', 'type' => 'string', 'required' => false, 'example' => 'Users prefer to first view the SLS error logs, index configuration, and the most recent Agent execution trace.'."\n" + ."\n"], + 'payload' => ['description' => '更新 payload', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "userId": "u-10001",'."\n" + .' "agentId": "sls-agent",'."\n" + .' "appId": "console",'."\n" + .' "categories": ['."\n" + .' "preference"'."\n" + .' ],'."\n" + .' "source": "user_confirmed",'."\n" + .' "topic": "debugging_preference",'."\n" + .' "immutable": false,'."\n" + .' "createdAt": 1776319200,'."\n" + .' "updatedAt": 1776319200'."\n" + .' }'], + 'triggerCondition' => ['description' => '触发条件', 'type' => 'string', 'required' => false, 'example' => 'Identify and troubleshoot SLs issues'], + 'experience' => ['description' => '经验', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "taskType": "troubleshooting",'."\n" + .' "complexity": "medium",'."\n" + .' "confidence": 0.95'."\n" + .'}'], + 'metadata' => ['description' => '元数据', 'type' => 'object', 'required' => false, 'example' => '{"sessionId":"test_session_001"}'], + ], + 'required' => false, + ], + ], ], - 'produces' => [ - 'application/json', + 'responses' => [ + 200 => [ + 'schema' => ['description' => '响应数据', 'type' => 'object', 'example' => '{}'], + ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改上下文', + 'summary' => '修改上下文', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + ], + 'UpdateContextStore' => [ + 'summary' => '修改上下文库配置', + 'path' => '/workspace/{workspace}/contextstore/{contextStoreName}', + 'methods' => ['put'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'product', - 'in' => 'query', - 'allowEmptyValue' => true, + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'maxLength' => 64, 'minLength' => 2], + ], + [ + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => '上下文库名称', 'type' => 'string', 'required' => true, 'example' => 'test-context-store', 'maxLength' => 64, 'minLength' => 2], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '空：云产品开通prometheus场景使用。'."\n" - .'prometheus：开通prometheuse服务（按上报量或写入量计费）'."\n" - .'sls：开通sls日志服务', - 'description' => 'prometheus：prometheuse服务（按上报量或写入量计费）开通状态。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'prometheus' => 'prometheus', + 'description' => '请求 Body', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => '描述', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'config' => [ + 'description' => '配置信息', + 'type' => 'object', + 'properties' => [ + 'metadataField' => [ + 'description' => '元数据字段', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'description' => '元数据字段', 'example' => '{'."\n" + .' "project": "attributes.project",'."\n" + .' "logstore": "attributes.logstore",'."\n" + .' "agentId": "attributes.agent_id",'."\n" + .' "scene": "attributes.scene"'."\n" + .' }'], + ], + 'source' => [ + 'description' => '引用路径', + 'type' => 'object', + 'properties' => [ + 'startTime' => ['description' => '开始时间', 'type' => 'string', 'required' => false, 'example' => '1776824891000'], + 'logstore' => ['description' => '日志服务Logstore名称', 'type' => 'string', 'required' => false, 'example' => 'sls-test-logstore'], + 'project' => ['description' => '日志服务Project名称', 'type' => 'string', 'required' => false, 'example' => 'sls-test-project'], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'contextType' => ['description' => '上下文类型', 'type' => 'string', 'required' => false, 'example' => 'memory'], + 'dataset' => [ + 'description' => '数据集信息', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => '数据集名称', 'type' => 'string', 'required' => false, 'example' => 'test_dataset'], + ], + 'required' => false, + ], ], - 'example' => 'prometheus', - 'enum' => [ - 'prometheus', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '响应数据', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改上下文库配置', + 'description' => '仅开通网络分析与监控的阿里云账号，才能创建一次性探测任务。'."\n" + ."\n" + .'本文将提供一个示例，创建一次性探测任务，该探测任务的名称为`task1`，探测地址为`http://www.aliyun.com`，探测类型为`HTTP`，探测点数量为`1`。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + ], + 'UpdateDataset' => [ + 'summary' => '更新数据集', + 'path' => '/workspace/{workspace}/dataset/{datasetName}', + 'methods' => ['put'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'service', - 'in' => 'query', - 'allowEmptyValue' => true, + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'maxLength' => 64, 'minLength' => 2], + ], + [ + 'name' => 'datasetName', + 'in' => 'path', + 'schema' => ['description' => '数据集名称', 'type' => 'string', 'required' => true, 'example' => 'test_dataset', 'maxLength' => 64, 'minLength' => 2], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '空：云产品开通prometheus场景使用。'."\n" - .'prometheus：检查上报量计费的prometheus是否开通。'."\n" - .'prometheusgb：检查写入量计费的prometheus是否开通。'."\n" - .'ackpro：检查容器监控pro是否开通。', - 'description' => 'prometheus：prometheus上报量计费商品是否开通。'."\n" - .'prometheusgb：prometheus写入量计费商品是否开通。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'prometheusgb' => 'prometheusgb', - 'promethues' => 'promethues', - ], - 'example' => 'prometheus', - 'enum' => [ - 'prometheus', - 'prometheusgb', - 'promethues', - 'ackpro', + 'description' => '请求 Body', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => '描述', 'type' => 'string', 'required' => false, 'example' => 'test dataset'], ], + 'required' => false, ], ], ], @@ -20494,112 +17420,109 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '响应数据', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], - 'enabled' => [ - 'description' => '服务或商品是否开通。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'errorCode' => [ - 'title' => 'PROM_NOT_OPEN：prometheus未开通'."\n" - .'SLS_NOT_OPEN：sls未开通'."\n" - .'CMS_SLR_NOT_EXIST：cloudmonitor SLR未创建'."\n" - .'SLS_SLR_NOT_EXIST：sls SLR未创建', - 'description' => 'PROM_NOT_OPEN：prometheus未开通。'."\n" - .'SLS_NOT_OPEN：prometheus依赖的sls未开通。'."\n" - .'CMS_SLR_NOT_EXIST：cloudmonitor SLR未创建。'."\n" - .'SLS_SLR_NOT_EXIST：SLS SLR未创建。', - 'type' => 'string', - 'example' => 'PROM_NOT_OPEN', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求Id', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], ], ], ], - 'errorCodes' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新数据集', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"enabled\\": false,\\n \\"errorCode\\": \\"PROM_NOT_OPEN\\"\\n}","type":"json"}]', - 'title' => '检查Prometheus服务或商品开通状态', - 'description' => 'product和service两个入参，不支持同时填写。', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', ], - 'CreateBizTrace' => [ - 'summary' => '创建业务链路', - 'path' => '/bizTrace', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateDeliveryTask' => [ + 'summary' => '更新数据投递任务。更新语义为 Patch：未填写的字段保持不变。', + 'path' => '/delivery-task/{taskId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ + 'name' => 'taskId', + 'in' => 'path', + 'schema' => ['description' => '任务ID', 'type' => 'string', 'required' => true, 'example' => '6afe16bece7996a3'], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求Body', + 'description' => '请求体，所有字段均为可选，仅填写需要变更的字段', 'type' => 'object', 'properties' => [ - 'workspace' => [ - 'description' => '工作空间。', + 'taskName' => ['description' => '任务名称，支持中文、英文、下划线、中划线', 'type' => 'string', 'required' => false, 'example' => 'new-task-name'], + 'dataSourceId' => ['description' => '数据源 ID（Prometheus 实例 ID）', 'type' => 'string', 'required' => false, 'example' => 'rw-5f2b4sc7es4d66'], + 'taskDescription' => ['description' => '任务描述', 'type' => 'string', 'required' => false, 'example' => 'updated desc'], + 'status' => [ + 'description' => '任务状态，用于启停任务', 'type' => 'string', 'required' => false, - 'example' => 'default-cms-xxxxxxx-cn-hangzhou', + 'enumValueTitles' => ['Enable' => 'Enable', 'Disable' => 'Disable'], + 'example' => 'Enable', + 'enum' => ['Running', 'Disable'], ], - 'bizTraceCode' => [ - 'description' => '业务链路标识，仅使用字母、数字和下划线（_），且首字母需要小写', + 'labelFiltersType' => [ + 'description' => '指标过滤模式', 'type' => 'string', 'required' => false, - 'example' => 'label_env', + 'example' => 'Deny', + 'enum' => ['Allow', 'Deny'], ], - 'bizTraceName' => [ - 'description' => '业务链路名称', - 'type' => 'string', + 'labelFilters' => [ + 'description' => '指标过滤条件，整体替换，不做增量合并', + 'type' => 'object', 'required' => false, - 'example' => 'just test', + 'additionalProperties' => ['type' => 'string', 'example' => '__name__: up', 'description' => 'filterKey → filterValue，例如 job → my_job'], ], - 'ruleConfig' => [ - 'description' => '配置规则列表', - 'type' => 'string', + 'externalLabels' => [ + 'description' => '为所有投递指标附加的额外 label，key 为 label 名，value 为 label 值', + 'type' => 'object', 'required' => false, - 'example' => '[{"entrancePid":"xxx@d9w3jd9j3","rpcMatcher":{"matchType":"EQUALS","pattern":"/"},"characteristics":{"operation":"OR","rules":[{"target":"CUSTOM_EXTRACT","id":"oi0b3bb7","key":"biz.test","matcher":{"matchType":"CONTAINS","pattern":["1"]}}]}}]'."\n", + 'additionalProperties' => ['type' => 'string', 'description' => 'externalLabelsKey → externalLabelsValue，例如 region → cn-hangzhou', 'example' => 'region: cn-hangzhou'], ], - 'advancedConfig' => [ - 'description' => '高级配置', - 'type' => 'string', + 'sinkList' => [ + 'description' => '投递目标列表', + 'type' => 'array', + 'items' => [ + 'description' => '投递目标', + 'type' => 'object', + 'properties' => [ + 'sinkType' => [ + 'description' => '投递目标类型', + 'type' => 'string', + 'required' => false, + 'example' => 'Prometheus', + 'enum' => ['Prometheus', 'AcsMaxCompute', 'AcsKafka'], + ], + 'sinkConfigs' => [ + 'description' => '投递目标详细配置，key/value 含义因 sinkType 不同而不同', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'example' => 'Url: http://xxxx/api/v1/write', 'description' => '各 sinkType 支持的配置项'], + ], + ], + 'required' => false, + ], 'required' => false, - 'example' => '{"sample":{"strategy":"BY_APP"}}', ], + 'resourceGroupId' => ['description' => '资源组ID', 'type' => 'string', 'required' => false, 'example' => 'rg-aekzoiafjtr7zyq'], ], 'required' => false, ], @@ -20612,79 +17535,82 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '请求 ID', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'bizTraceId' => [ - 'description' => '业务链路id', - 'type' => 'string', - 'example' => 'e339260ed64c95d', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9335D7CB-2725-53DD-A2B3-187821C8F1B8'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"bizTraceId\\": \\"e339260ed64c95d\\"\\n}","type":"json"}]', - 'title' => '创建业务链路', - ], - 'CreateServiceObservability' => [ - 'summary' => '创建应用可观测，完成接入前置资源准备等；', - 'path' => '/workspace/{workspace}/service-observability/{type}', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新数据投递任务', + 'description' => '删除一个指定的站点监控任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpdateDeliveryTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'DeliveryTask', 'arn' => 'acs:cms:{#regionId}:{#accountId}:deliverytask/{#TaskId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9335D7CB-2725-53DD-A2B3-187821C8F1B8\\"\\n}","type":"json"}]', + ], + 'UpdateIntegrationPolicy' => [ + 'path' => '/integration-policies/{integrationPolicyId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'workspace', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => true, - 'example' => 'default-cms-1654218965343050-cn-hangzhou', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'feePackage' => ['description' => '付费套餐类型，CS_Pro/CS_Basic/空。', 'type' => 'string', 'required' => false, 'example' => 'CS_Pro'], + 'policyName' => ['description' => '规则名称，最短3个字符，最长63个字符，必须以字母开头。', 'type' => 'string', 'required' => false, 'example' => 'metrics-inner-manage'], + 'resourceGroupId' => ['description' => '实例的资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-aekzoiafjtr7zyq'], + 'tags' => [ + 'description' => '资源标签。', + 'type' => 'array', + 'items' => [ + 'description' => '资源标签。', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => '标签`key`值。', 'type' => 'string', 'required' => false, 'example' => 'algo_bhv_expose_in_airec_exposure'], + 'value' => ['description' => '标签`value`值。', 'type' => 'string', 'required' => false, 'example' => '[{\'Id\': \'kgqie6hm\', \'Name\': \'Sheet1\'}]'], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, ], ], [ - 'name' => 'type', + 'name' => 'integrationPolicyId', 'in' => 'path', - 'schema' => [ - 'description' => '应用可观测类型', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'rum' => '用户体验监控', - 'apm' => '应用性能监控', - ], - 'example' => 'apm', - ], + 'schema' => ['description' => '接入中心策略ID', 'type' => 'string', 'required' => true, 'example' => 'polixy-xxxxxxxxx'], ], ], 'responses' => [ @@ -20694,65 +17620,79 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', - 'title' => '创建应用可观测', - 'extraInfo' => '说明：'."\n" - ."\n" - .'- 资源初始化涉及较多动作可能存在延迟，接口发起成功即可；可以通过GetServiceObservability来获取状态，如果status返回running则表示资源初始化成功；'."\n" - ."\n" - .'- 应用性能监控，链路追踪OpenTelemetry以及用户体验监控需要单独进行资源初始化；', - ], - 'DeleteBizTrace' => [ - 'summary' => '删除业务链路。', - 'path' => '/bizTrace/{bizTraceId}', - 'methods' => [ - 'delete', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新接入中心策略', + 'summary' => '更新指定策略', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateIntegrationPolicy'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpdateIntegrationPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'IntegrationPolicy', 'arn' => 'acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#integrationPolicyId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', + ], + 'UpdateMemory' => [ + 'summary' => '修改记忆', + 'path' => '/workspace/{workspace}/memorystore/{memoryStoreName}/memory/{memoryId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'bizTraceId', + 'name' => 'workspace', 'in' => 'path', + 'schema' => ['description' => '工作空间名称。', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'maxLength' => 64, 'minLength' => 2], + ], + [ + 'name' => 'memoryStoreName', + 'in' => 'path', + 'schema' => ['description' => '记忆库名称', 'type' => 'string', 'required' => true, 'example' => 'test-memory-store', 'maxLength' => 64, 'minLength' => 2], + ], + [ + 'name' => 'memoryId', + 'in' => 'path', + 'schema' => ['description' => '记忆库 Id', 'type' => 'string', 'required' => true, 'example' => '019ca1e5-7307-7d50-b943-5e628326a8ed', 'minLength' => 1], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '业务链路id', - 'type' => 'string', + 'description' => '请求 body', + 'type' => 'object', + 'properties' => [ + 'metadata' => ['description' => '元数据', 'type' => 'object', 'required' => false, 'example' => '{"sessionId":"test_session_001"}'], + 'text' => ['description' => '修改记忆文本内容', 'type' => 'string', 'required' => false, 'example' => 'Likes to play tennis on weekends'], + ], 'required' => false, - 'example' => 'e339260ed64c95d', ], ], ], @@ -20760,946 +17700,609 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '响应数据', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求 ID', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求Id', 'type' => 'string', 'example' => '3B311FD9-A60B-55E0-A896-A0C73*********'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', - 'title' => '删除业务链路', - ], - 'GetAddon' => [ - 'summary' => '获取插件详情(Addon)。', - 'path' => '/addons/{addonName}', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改记忆', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpdateMemory', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'MemoryStore', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#WorkspaceName}/memorystore/{#MemoryStoreName}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3B311FD9-A60B-55E0-A896-A0C73*********\\"\\n}","type":"json"}]', + ], + 'UpdateMemoryStore' => [ + 'summary' => '修改记忆库。', + 'path' => '/workspace/{workspace}/memorystore/{memoryStoreName}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'addonName', + 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'title' => '查询参数', - 'description' => '查询参数', - 'type' => 'string', - 'required' => true, - 'example' => 'security-actiontrail', - ], + 'schema' => ['description' => '工作空间名称。', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'maxLength' => 64, 'minLength' => 2], ], [ - 'name' => 'version', - 'in' => 'query', - 'schema' => [ - 'title' => 'Addon版本号', - 'description' => 'Addon版本号', - 'type' => 'string', - 'required' => false, - 'example' => '*', - ], + 'name' => 'memoryStoreName', + 'in' => 'path', + 'schema' => ['description' => '记忆库名称', 'type' => 'string', 'required' => true, 'example' => 'qianyi_test_3', 'maxLength' => 64, 'minLength' => 2], ], [ - 'name' => 'aliyunLang', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '语言环境,默认为中文 zh | en', - 'description' => '语言环境,默认为中文 zh | en', - 'type' => 'string', + 'description' => '请求数据', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => '描述', 'type' => 'string', 'required' => false, 'example' => 'memoryStore test'], + 'shortTermTtl' => ['description' => '短期记忆保存时间', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7'], + 'extractionStrategies' => [ + 'description' => '提取策略，支持 "Episodic", "Summary", "Fact"。', + 'type' => 'array', + 'items' => ['description' => '策略数组', 'type' => 'string', 'required' => false, 'example' => 'Fact'], + 'required' => false, + ], + 'customExtractionStrategies' => [ + 'description' => '自定义提取策略', + 'type' => 'array', + 'items' => ['description' => '策略数组', 'required' => false, '$ref' => '#/components/schemas/CustomExtractionStrategy'], + 'required' => false, + ], + ], 'required' => false, - 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应数据', 'type' => 'object', 'properties' => [ - 'data' => [ - 'description' => '请求头对应的数据列表', - 'type' => 'object', - 'properties' => [ - 'alias' => [ - 'description' => '接入组件别名。', - 'type' => 'string', - 'example' => 'resume_vector_alias', - ], - 'categories' => [ - 'description' => '接入组件分类目录列表。', - 'type' => 'array', - 'items' => [ - 'description' => '分类目录名称', - 'type' => 'string', - 'example' => 'alibaba-cloud-service', - ], - ], - 'dashboards' => [ - 'description' => '仪表盘的列表。', - 'type' => 'array', - 'items' => [ - 'description' => '仪表盘信息。', - 'type' => 'object', - 'properties' => [ - 'description' => [ - 'description' => '仪表盘描述。', - 'type' => 'string', - 'example' => 'test', - ], - 'name' => [ - 'description' => '仪表盘名称。', - 'type' => 'string', - 'example' => 'rum_api_dot_metric_set', - ], - 'url' => [ - 'description' => '效果图URL地址。', - 'type' => 'string', - 'example' => 'http://iac-service-transfer.oss-cn-hangzhou.aliyuncs.com/78c5_288850010070719968_bdcf7cca781844c8ac4add133791713f', - ], - ], - ], - ], - 'description' => [ - 'description' => 'Addon描述', - 'type' => 'string', - 'example' => 'o11y-demo-cn-heyuan', - ], - 'environments' => [ - 'description' => '环境信息。', - 'type' => 'array', - 'items' => [ - 'description' => '单个环境信息。', - 'type' => 'object', - 'properties' => [ - 'enable' => [ - 'description' => '是否启用', - 'type' => 'boolean', - 'example' => 'false', - ], - 'label' => [ - 'description' => '环境展示名称。', - 'type' => 'string', - 'example' => '容器环境', - ], - 'dependencies' => [ - 'description' => '附加依赖文件。', - 'type' => 'object', - 'properties' => [ - 'clusterTypes' => [ - 'description' => '对集群类型的依赖。', - 'type' => 'array', - 'items' => [ - 'description' => '对集群类型的依赖。', - 'type' => 'string', - 'example' => 'ManagedKubernetes/Default', - ], - ], - 'features' => [ - 'description' => '对探针的依赖。', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'boolean', - 'description' => '是否依赖目标探针组件', - 'example' => 'true', - ], - ], - 'services' => [ - 'description' => '对开通服务的依赖', - 'type' => 'array', - 'items' => [ - 'description' => '服务名称', - 'type' => 'string', - 'example' => 'Prometheus', - ], - ], - ], - ], - 'description' => [ - 'description' => '描述', - 'type' => 'string', - 'example' => 'Observability integration.', - ], - 'name' => [ - 'description' => 'Addon名称。', - 'type' => 'string', - 'example' => 'cs-default-umodel-1752755202744_k8s.metric.high_level_metric_deployment_cn-hangzhou/c0a686118449c4390b9cc0a07ea3e0e85', - ], - 'policies' => [ - 'description' => '资源组ID。', - 'type' => 'object', - 'properties' => [ - 'alertDefaultStatus' => [ - 'description' => '告警规则默认策略的启用状态。', - 'type' => 'string', - 'example' => 'true', - ], - 'defaultInstall' => [ - 'description' => '是否默认安装', - 'type' => 'boolean', - 'example' => 'true', - ], - 'enableServiceAccount' => [ - 'description' => '是否分配 Service Account 用以与 Console API 通信。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'metricCheckRule' => [ - 'description' => '指标检测规则。', - 'type' => 'object', - 'properties' => [ - 'promQL' => [ - 'description' => '安装后数据检查规则', - 'type' => 'array', - 'items' => [ - 'description' => '安装后数据检查规则', - 'type' => 'string', - 'example' => 'up=1', - ], - ], - ], - ], - 'needRestartAfterIntegration' => [ - 'description' => '是否在插件接入时完成安装后即进入 Pod 重启引导。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'protocols' => [ - 'description' => '协议。', - 'type' => 'array', - 'items' => [ - 'description' => '协议。', - 'type' => 'object', - 'properties' => [ - 'description' => [ - 'description' => '协议说明', - 'type' => 'string', - 'example' => 'Support OpenTelemetry Protocol', - ], - 'icon' => [ - 'description' => '图标地址', - 'type' => 'string', - 'example' => 'icon URL', - ], - 'label' => [ - 'description' => '协议展示名称。', - 'type' => 'string', - 'example' => 'OpenTelemetry', - ], - 'name' => [ - 'description' => '协议名称。', - 'type' => 'string', - 'example' => 'OpenTelemetry', - ], - ], - ], - ], - 'targetAddonName' => [ - 'description' => '跳转的目标 Addon 名称', - 'type' => 'string', - 'example' => 'cs-default', - ], - ], - ], - 'policyType' => [ - 'description' => '接入策略类型。', - 'type' => 'string', - 'example' => 'CS', - ], - 'commonSchemaRefs' => [ - 'description' => '关联的Common Schema列表', - 'type' => 'array', - 'items' => [ - 'description' => '关联的Common Schema信息', - 'type' => 'object', - 'properties' => [ - 'group' => [ - 'description' => 'CommonSchema 的分组名称', - 'type' => 'string', - 'example' => 'acs-ecs', - ], - 'version' => [ - 'description' => 'CommonSchema 的版本', - 'type' => 'string', - 'example' => '0.1.3', - ], - ], - ], - ], - ], - ], - ], - 'icon' => [ - 'description' => '图标地址', - 'type' => 'string', - 'example' => 'https://xxxxx', - ], - 'keywords' => [ - 'description' => '关键词', - 'type' => 'array', - 'items' => [ - 'description' => '关键词', - 'type' => 'string', - 'example' => 'metrics', - ], - ], - 'language' => [ - 'description' => '语言。', - 'type' => 'string', - 'example' => 'zh', - ], - 'latestReleaseCreateTime' => [ - 'description' => '最新一次创建时间。', - 'type' => 'string', - 'example' => '2023-09-12 12:30:30', - ], - 'name' => [ - 'description' => 'Addon名称。', - 'type' => 'string', - 'example' => 'rum_api_dashboard_explorer_link_metric_set', - ], - 'once' => [ - 'description' => '是否只能安装一次。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'scene' => [ - 'description' => '组件场景。', - 'type' => 'string', - 'example' => 'middleware', - ], - 'version' => [ - 'description' => '组件版本。', - 'type' => 'string', - 'example' => '*', - ], - 'weight' => [ - 'description' => '权重值。', - 'type' => 'string', - 'example' => '10', - ], - ], - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求 ID', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改记忆库', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"alias\\": \\"resume_vector_alias\\",\\n \\"categories\\": [\\n \\"alibaba-cloud-service\\"\\n ],\\n \\"dashboards\\": [\\n {\\n \\"description\\": \\"test\\",\\n \\"name\\": \\"rum_api_dot_metric_set\\",\\n \\"url\\": \\"http://iac-service-transfer.oss-cn-hangzhou.aliyuncs.com/78c5_288850010070719968_bdcf7cca781844c8ac4add133791713f\\"\\n }\\n ],\\n \\"description\\": \\"o11y-demo-cn-heyuan\\",\\n \\"environments\\": [\\n {\\n \\"enable\\": false,\\n \\"label\\": \\"容器环境\\",\\n \\"dependencies\\": {\\n \\"clusterTypes\\": [\\n \\"ManagedKubernetes/Default\\"\\n ],\\n \\"features\\": {\\n \\"key\\": true\\n },\\n \\"services\\": [\\n \\"Prometheus\\"\\n ]\\n },\\n \\"description\\": \\"Observability integration.\\",\\n \\"name\\": \\"cs-default-umodel-1752755202744_k8s.metric.high_level_metric_deployment_cn-hangzhou/c0a686118449c4390b9cc0a07ea3e0e85\\",\\n \\"policies\\": {\\n \\"alertDefaultStatus\\": \\"true\\",\\n \\"defaultInstall\\": true,\\n \\"enableServiceAccount\\": true,\\n \\"metricCheckRule\\": {\\n \\"promQL\\": [\\n \\"up=1\\"\\n ]\\n },\\n \\"needRestartAfterIntegration\\": true,\\n \\"protocols\\": [\\n {\\n \\"description\\": \\"Support OpenTelemetry Protocol\\",\\n \\"icon\\": \\"icon URL\\",\\n \\"label\\": \\"OpenTelemetry\\",\\n \\"name\\": \\"OpenTelemetry\\"\\n }\\n ],\\n \\"targetAddonName\\": \\"cs-default\\"\\n },\\n \\"policyType\\": \\"CS\\",\\n \\"commonSchemaRefs\\": [\\n {\\n \\"group\\": \\"acs-ecs\\",\\n \\"version\\": \\"0.1.3\\"\\n }\\n ]\\n }\\n ],\\n \\"icon\\": \\"https://xxxxx\\",\\n \\"keywords\\": [\\n \\"metrics\\"\\n ],\\n \\"language\\": \\"zh\\",\\n \\"latestReleaseCreateTime\\": \\"2023-09-12 12:30:30\\",\\n \\"name\\": \\"rum_api_dashboard_explorer_link_metric_set\\",\\n \\"once\\": true,\\n \\"scene\\": \\"middleware\\",\\n \\"version\\": \\"*\\",\\n \\"weight\\": \\"10\\"\\n },\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8\\"\\n}","type":"json"}]', - 'title' => '获取 Addon 配置详情', - 'description' => '获取Addon详情。', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', ], - 'GetAddonCodeTemplate' => [ - 'summary' => '插件schema详情(Addon)', - 'path' => '/addons/{addonName}/alert-code-template', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'UpdateNotifyStrategy' => [ + 'path' => '/notifyStrategies/{notifyStrategyId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'addonName', - 'in' => 'path', - 'schema' => [ - 'title' => 'Addon的名称信息', - 'description' => 'Addon的名称信息', - 'type' => 'string', - 'required' => true, - 'example' => 'apm-opentelemetry', - ], - ], - [ - 'name' => 'aliyunLang', + 'name' => 'workspace', 'in' => 'query', - 'schema' => [ - 'title' => '语言环境,默认为中文 zh | en', - 'description' => '语言环境,默认为中文 zh | en', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => false, 'example' => 'workspace-test'], ], [ - 'name' => 'environmentType', - 'in' => 'query', - 'schema' => [ - 'title' => '环境类型 CS(容器) | ECS', - 'description' => '环境类型 CS(容器) | ECS', - 'type' => 'string', - 'required' => false, - 'example' => 'Client', - ], + 'name' => 'body', + 'in' => 'body', + 'allowEmptyValue' => false, + 'schema' => ['description' => '请求体参数。', 'required' => false, '$ref' => '#/components/schemas/NotifyStrategyForModify'], ], [ - 'name' => 'version', - 'in' => 'query', - 'schema' => [ - 'description' => '组件版本。', - 'type' => 'string', - 'required' => false, - 'example' => '0.1.0', - ], + 'name' => 'notifyStrategyId', + 'in' => 'path', + 'schema' => ['description' => '通知策略UUID', 'type' => 'string', 'required' => true, 'example' => '12312-31-23-123-1-23123'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '响应内容结构', 'type' => 'object', 'properties' => [ - 'codes' => [ - 'description' => '代码模版信息列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'codeTemplate' => [ - 'description' => '代码模版', - 'type' => 'string', - 'example' => 'javascript\\nnpm install @arms/rum-miniapp --save', - ], - 'name' => [ - 'description' => '代码模版名称', - 'type' => 'string', - 'example' => 'cs-default-CS-cs-default-1753236205394-cs-default-CS-kubeApiserver', - ], - ], - ], - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-***', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求的唯一 ID，用于排查问题', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'notifyStrategyId' => ['description' => '通知策略UUID', 'type' => 'string', 'example' => '12312-31-23-123-1-23123'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => '参数错误。'], + ['errorCode' => 'StrategyNameConflict', 'errorMessage' => 'The specified strategy name exits already.', 'description' => '指定的策略名称已经存在'], + ], + 403 => [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => '没有权限，请使用RAM进行授权'], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => '未找到指定资源。'], + ], + 500 => [ + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => '服务运行错误。'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"codes\\": [\\n {\\n \\"codeTemplate\\": \\"javascript\\\\\\\\nnpm install @arms/rum-miniapp --save\\",\\n \\"name\\": \\"cs-default-CS-cs-default-1753236205394-cs-default-CS-kubeApiserver\\"\\n }\\n ],\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-***\\"\\n}","type":"json"}]', - 'title' => '获取Addon内代码模版', - 'description' => '本文将提供一个示例，修改版本`1`的报警模板`123456`，将报警级别修改为`Critical`，报警统计方法修改为`Average`，报警阈值比较符修改为`GreaterThanOrEqualToThreshold`，报警阈值修改为`90`，报警重试次数修改为`3`。返回结果显示，修改报警模板成功。', - ], - 'GetAddonSchema' => [ - 'summary' => '插件schema详情(Addon)。', - 'path' => '/addons/{addonName}/schema', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新通知策略', + 'summary' => '更新通知策略', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateNotifyStrategy'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpdateNotifyStrategy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'NotifyStrategy', 'arn' => 'acs:cms:{#regionId}:{#accountId}:notifyStrategy/{#notifyStrategyId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"notifyStrategyId\\": \\"12312-31-23-123-1-23123\\"\\n}","type":"json"}]', + ], + 'UpdatePipeline' => [ + 'path' => '/workspace/{workspace}/pipeline/{pipelineName}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'addonName', + 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'title' => 'Addon的名称信息', - 'description' => 'Addon的名称信息', - 'type' => 'string', - 'required' => true, - 'example' => 'cloud-rds-audit-log', - ], - ], - [ - 'name' => 'aliyunLang', - 'in' => 'query', - 'schema' => [ - 'title' => '语言环境,默认为中文 zh | en', - 'description' => '语言环境,默认为中文 zh | en', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => false, 'example' => 'workspace-test'], ], [ - 'name' => 'environmentType', - 'in' => 'query', - 'schema' => [ - 'title' => '环境类型 CS(容器) | ECS', - 'description' => '环境类型 CS(容器) | ECS', - 'type' => 'string', - 'required' => false, - 'example' => 'CS', - ], + 'name' => 'pipelineName', + 'in' => 'path', + 'schema' => ['description' => '流水线名称', 'type' => 'string', 'required' => false, 'example' => 'pipeline-name-1'], ], [ - 'name' => 'version', - 'in' => 'query', - 'schema' => [ - 'description' => '组件版本。', - 'type' => 'string', - 'required' => false, - 'example' => '0.1.1', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ + 'description' => '请求数据', 'type' => 'object', 'properties' => [ - 'fields' => [ - 'description' => '数据表字段列表。', - 'type' => 'array', - 'items' => [ - 'description' => '数据表字段信息。', - 'type' => 'object', - 'properties' => [ - 'conditions' => [ - 'description' => '展示条件列表。', - 'type' => 'array', - 'items' => [ - 'description' => '展示条件。', - 'type' => 'object', - 'properties' => [ - 'action' => [ - 'description' => '字段控制模式。', - 'type' => 'string', - 'example' => 'show', - ], - 'field' => [ - 'description' => '字段名称', - 'type' => 'string', - 'example' => 'store.storageTarget', - ], - 'op' => [ - 'description' => '判断条件操作符。', - 'type' => 'string', - 'example' => '==', - ], - 'value' => [ - 'description' => '判断目标值。', - 'type' => 'any', - 'example' => 'Custom', - ], - ], - ], - ], - 'defaultValue' => [ - 'description' => '默认值', - 'type' => 'any', - 'example' => 'mysql.default', - ], - 'description' => [ - 'description' => '描述', - 'type' => 'string', - 'example' => 'MySQL datasource', - ], - 'disabled' => [ - 'description' => '是否隐藏: true - 隐藏， false - 显示', - 'type' => 'boolean', - 'example' => 'false', - ], - 'element' => [ - 'description' => '元素类型。', - 'type' => 'string', - 'example' => 'input', - ], - 'fieldPath' => [ - 'description' => '字段路径。', - 'type' => 'string', - 'example' => 'mysql.host', - ], - 'label' => [ - 'description' => '字段展示名称。', - 'type' => 'string', - 'example' => 'mysql', - ], - 'name' => [ - 'description' => '字段名称。', - 'type' => 'string', - 'example' => 'host', - ], - 'placeholder' => [ - 'description' => '输入提示。', - 'type' => 'string', - 'example' => 'Please enter the metrics collection interval', - ], - 'props' => [ - 'description' => '组件其他属性。', - 'type' => 'object', - 'properties' => [ - 'dataSource' => [ - 'description' => '数据源信息。', - 'type' => 'array', - 'items' => [ - 'description' => '数据源信息。', - 'type' => 'object', - 'properties' => [ - 'label' => [ - 'description' => '标签。', - 'type' => 'string', - 'example' => 'tagKey', - ], - 'value' => [ - 'description' => '标签Value。', - 'type' => 'string', - 'example' => 'tagValue', - ], - ], - ], - ], - 'related' => [ - 'description' => '相关的数据集合。', - 'type' => 'array', - 'items' => [ - 'description' => '相关数据。', - 'type' => 'string', - 'example' => 'mysql.host', - ], - ], - 'selectMode' => [ - 'description' => '模式。', - 'type' => 'string', - 'example' => 'single', - ], - ], - ], - 'type' => [ - 'description' => '字段类型。', - 'type' => 'string', - 'example' => 'string', + 'description' => ['description' => '描述', 'type' => 'string', 'required' => false, 'example' => 'test pipeline '], + 'source' => [ + 'description' => '数据源', + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => '数据源类型', 'type' => 'string', 'required' => false, 'example' => 'logstore'], + 'logstore' => [ + 'description' => '日志服务Logstore信息', + 'type' => 'object', + 'properties' => [ + 'logstore' => ['description' => '日志服务Logstore名称', 'type' => 'string', 'required' => false, 'example' => 'test-logstore'], + 'query' => ['description' => '过滤语句', 'type' => 'string', 'required' => false, 'example' => 'status:500 and method:GET'], ], - 'validation' => [ - 'description' => '字段校验规则', + 'required' => false, + ], + ], + 'required' => false, + ], + 'pipeline' => [ + 'description' => '流水线配置', + 'type' => 'object', + 'properties' => [ + 'nodes' => [ + 'description' => '节点', + 'type' => 'array', + 'items' => [ + 'description' => '节点', 'type' => 'object', 'properties' => [ - 'max' => [ - 'description' => '分数区间最大值（包含）', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2000', - ], - 'maxLength' => [ - 'description' => '文本控件支持的最大长度。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'message' => [ - 'description' => '详细信息。', - 'type' => 'string', - 'example' => 'length limit', - ], - 'min' => [ - 'description' => '最小值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'minLength' => [ - 'description' => '最短长度。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - ], - 'regular' => [ - 'description' => '正则表达式。', - 'type' => 'string', - 'example' => '^(http|https)://', - ], - 'required' => [ - 'description' => '参数是否必填。', - 'type' => 'boolean', - 'example' => 'false', + 'id' => ['description' => '节点Id', 'type' => 'string', 'required' => false, 'example' => 'node_1'], + 'type' => ['description' => '节点类型', 'type' => 'string', 'required' => false, 'example' => 'dedup-fuzzy'], + 'parameters' => [ + 'description' => '参数', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'any', 'description' => '参数', 'example' => '{'."\n" + .' "output": "ID,key_0,key_2,key_3,key_4",'."\n" + .' "workspace": "workspace-test-dataset",'."\n" + .' "field": "key_0",'."\n" + .' "global": true,'."\n" + .' "dataset": "dataset_1"'."\n" + .' }'], ], ], + 'required' => false, ], + 'required' => false, ], ], + 'required' => false, ], - 'requestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E5B1D3D4-BB28-5996-8AD2-***********', + 'sink' => [ + 'description' => '输出目标', + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => '输出目标类型', 'type' => 'string', 'required' => false, 'example' => 'dataset'], + 'dataset' => [ + 'description' => '数据集', + 'type' => 'object', + 'properties' => [ + 'workspace' => ['description' => '工作空间ID', 'type' => 'string', 'required' => false, 'example' => 'workspace-test'], + 'dataset' => ['description' => '数据集', 'type' => 'string', 'required' => false, 'example' => 'dataset_1'], + ], + 'required' => false, + ], + ], + 'required' => false, ], - 'type' => [ - 'description' => 'Schema类型。', - 'type' => 'string', - 'example' => 'common', + 'executePolicy' => [ + 'description' => '执行策略', + 'type' => 'object', + 'properties' => [ + 'mode' => ['description' => '执行模式', 'type' => 'string', 'required' => false, 'example' => 'runOnce'], + 'runOnce' => [ + 'description' => '只执行一次时的配置', + 'type' => 'object', + 'properties' => [ + 'fromTime' => ['description' => '开始时间时间戳', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1772519013'], + 'toTime' => ['description' => '结束时间时间戳', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1772605413'], + ], + 'required' => false, + ], + 'scheduled' => [ + 'description' => '定时执行时的配置', + 'type' => 'object', + 'properties' => [ + 'interval' => ['description' => '时间间隔', 'type' => 'string', 'required' => false, 'example' => '86400'], + 'fromTime' => ['description' => '开始时间时间戳', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1772519013'], + ], + 'required' => false, + ], + ], + 'required' => false, ], ], + 'required' => false, ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"fields\\": [\\n {\\n \\"conditions\\": [\\n {\\n \\"action\\": \\"show\\",\\n \\"field\\": \\"store.storageTarget\\",\\n \\"op\\": \\"==\\",\\n \\"value\\": \\"Custom\\"\\n }\\n ],\\n \\"defaultValue\\": \\"mysql.default\\",\\n \\"description\\": \\"MySQL datasource\\",\\n \\"disabled\\": false,\\n \\"element\\": \\"input\\",\\n \\"fieldPath\\": \\"mysql.host\\",\\n \\"label\\": \\"mysql\\",\\n \\"name\\": \\"host\\",\\n \\"placeholder\\": \\"Please enter the metrics collection interval\\",\\n \\"props\\": {\\n \\"dataSource\\": [\\n {\\n \\"label\\": \\"tagKey\\",\\n \\"value\\": \\"tagValue\\"\\n }\\n ],\\n \\"related\\": [\\n \\"mysql.host\\"\\n ],\\n \\"selectMode\\": \\"single\\"\\n },\\n \\"type\\": \\"string\\",\\n \\"validation\\": {\\n \\"max\\": 2000,\\n \\"maxLength\\": 100,\\n \\"message\\": \\"length limit\\",\\n \\"min\\": 0,\\n \\"minLength\\": 16,\\n \\"regular\\": \\"^(http|https)://\\",\\n \\"required\\": false\\n }\\n }\\n ],\\n \\"requestId\\": \\"E5B1D3D4-BB28-5996-8AD2-***********\\",\\n \\"type\\": \\"common\\"\\n}","type":"json"}]', - 'title' => '获取Addon的Schema信息', - 'description' => '获取Addon的Schema信息。', - ], - 'GetBizTrace' => [ - 'summary' => '查询业务链路', - 'path' => '/bizTrace/{bizTraceId}', - 'methods' => [ - 'get', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应数据', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => '请求 ID', 'type' => 'string', 'example' => 'E99F1CCD-256A-5DF9-9B67-8F4A7ACE7132'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新流水线', + 'summary' => '更新流水线', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E99F1CCD-256A-5DF9-9B67-8F4A7ACE7132\\"\\n}","type":"json"}]', + ], + 'UpdatePrometheusInstance' => [ + 'summary' => '更新Prometheus实例信息。', + 'path' => '/prometheus-instances/{prometheusInstanceId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'bizTraceId', + 'name' => 'prometheusInstanceId', 'in' => 'path', + 'allowEmptyValue' => false, + 'schema' => ['title' => 'prometheus实例ID', 'description' => 'prometheus实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rw-xxxxxxx'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '业务链路id', - 'type' => 'string', + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'archiveDuration' => [ + 'title' => '存储到期后，自动归档保存的天数，0表示不归档保存。归档天数取值范围：'."\n" + .'V1：1~365天。仅按指标写入量支持。'."\n" + .'V2：1~3650天（3650表示永久保存）。', + 'description' => '存储到期后，自动归档保存的天数，0表示不归档保存。归档天数取值范围：'."\n" + .'V1：1~365天。仅按指标写入量支持。'."\n" + .'V2：1~3650天（3650表示永久保存）。', + 'type' => 'integer', + 'required' => false, + 'example' => '365', + 'enum' => [], + ], + 'authFreeReadPolicy' => ['title' => '是否开启免密读的ip地址列表，支持CIDR配置。多个ip之间换行符分隔。', 'description' => '免密读策略（支持IP段和VpcId）。', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "SourceIp": ['."\n" + .' "192.168.1.0/24",'."\n" + .' "172.168.2.22"'."\n" + .' ],'."\n" + .' "SourceVpc": ['."\n" + .' "vpc-xx1",'."\n" + .' "vpc-xx2"'."\n" + .' ]'."\n" + .'}'], + 'authFreeWritePolicy' => ['title' => '是否开启免密写的ip地址列表，支持CIDR配置。多个ip之间换行符分隔。', 'description' => '免密读策略（支持IP段和VpcId）。', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "SourceIp": ['."\n" + .' "192.168.1.0/24",'."\n" + .' "172.168.2.22"'."\n" + .' ],'."\n" + .' "SourceVpc": ['."\n" + .' "vpc-xx1",'."\n" + .' "vpc-xx2"'."\n" + .' ]'."\n" + .'}'], + 'enableAuthFreeRead' => ['title' => '是否开启免密读', 'description' => '是否开启免密读。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'enableAuthFreeWrite' => ['title' => '是否开启免密写', 'description' => '是否开启免密写。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'enableAuthToken' => ['title' => '是否开启访问Token鉴权', 'description' => '是否开启访问Token鉴权。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'prometheusInstanceName' => ['description' => '实例名称。', 'type' => 'string', 'required' => false, 'example' => 'test-prom-name'], + 'status' => ['title' => '实例存储db状态（仅支持RUNNING）。为空时，不改变存储db状态。', 'description' => '实例存储db状态（仅支持RUNNING）。为空时，不改变存储db状态。', 'type' => 'string', 'required' => false, 'example' => 'RUNNING'], + 'storageDuration' => [ + 'title' => '存储时长（天）：'."\n" + .'按写入量：90、180'."\n" + .'按指标上报量：15、30、60、90、180', + 'description' => '存储时长（天）：'."\n" + .'按写入量：90、180。'."\n" + .'按指标上报量：15、30、60、90、180。', + 'type' => 'integer', + 'required' => false, + 'enumValueTitles' => [15 => '15天', 30 => '30天', 60 => '60天', 90 => '90天', 180 => '180天', 365 => '365天'], + 'example' => '90', + 'enum' => ['15', '30', '60', '90', '180', '365'], + ], + 'paymentType' => [ + 'title' => '计费方式（实例的生命周期内，只能修改一次）：'."\n" + .'POSTPAY：按指标上报量后付费。'."\n" + .'POSTPAY_GB：按指标写入量后付费。', + 'description' => '计费方式（实例的生命周期内，只能修改一次）：'."\n" + .'POSTPAY：按指标上报量后付费。'."\n" + .'POSTPAY_GB：按指标写入量后付费。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['POSTPAY_GB' => '写入量', 'POSTPAY' => '上报量'], + 'example' => 'POSTPAY_GB', + 'enum' => ['POSTPAY_GB', 'POSTPAY'], + ], + 'workspace' => ['title' => '归属的工作空间。', 'description' => '归属的工作空间。', 'type' => 'string', 'required' => false, 'example' => 'default-cms-1500199863951574-cn-shanghai'], + ], 'required' => false, - 'example' => 'e339260ed64c95d', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], - 'item' => [ - 'description' => '业务链路', - '$ref' => '#/components/schemas/BizTraceConfig', - ], + 'prometheusInstanceId' => ['description' => '实例id。', 'type' => 'string', 'example' => 'rw-abc123'], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1E92F783-E057-58F1-BD5C-92DED088E7A5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"item\\": {\\n \\"workspace\\": \\"default-cms-xxxxxxx-cn-hangzhou\\",\\n \\"bizTraceId\\": \\"e339260ed64c95d\\",\\n \\"bizTraceName\\": \\"just test\\",\\n \\"bizTraceCode\\": \\"label_env\\",\\n \\"ruleConfig\\": \\"[{\\\\\\"entrancePid\\\\\\":\\\\\\"xxxxx@b57c44xx6e86\\\\\\",\\\\\\"rpcMatcher\\\\\\":{\\\\\\"matchType\\\\\\":\\\\\\"EQUALS\\\\\\",\\\\\\"pattern\\\\\\":\\\\\\"/createApp\\\\\\"},\\\\\\"characteristics\\\\\\":{\\\\\\"operation\\\\\\":\\\\\\"AND\\\\\\",\\\\\\"rules\\\\\\":[{\\\\\\"target\\\\\\":\\\\\\"CUSTOM_EXTRACT\\\\\\",\\\\\\"matcher\\\\\\":{\\\\\\"matchType\\\\\\":\\\\\\"CONTAINS\\\\\\",\\\\\\"pattern\\\\\\":[]}}]}}]\\",\\n \\"advancedConfig\\": \\"{\\\\\\"sample\\\\\\":{\\\\\\"strategy\\\\\\":\\\\\\"BY_APP\\\\\\"}}\\",\\n \\"createTime\\": \\"2025-12-12 00:00:00\\",\\n \\"regionId\\": \\"cn-beijing\\"\\n }\\n}","type":"json"}]', - 'title' => '查询业务链路', - ], - 'GetIntegrationVersionForCS' => [ - 'summary' => '查询容器集群链接的接入中心版本。', - 'path' => '/integration-version/cs', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusInstanceId\\": \\"rw-abc123\\",\\n \\"requestId\\": \\"1E92F783-E057-58F1-BD5C-92DED088E7A5\\"\\n}","type":"json"}]', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], - 'schemes' => [ - 'https', + 'title' => '更新Prometheus实例信息', + 'description' => '更新Prometheus实例信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePrometheusInstance'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + ], + 'UpdatePrometheusUserSetting' => [ + 'summary' => '更新Prometheus用户配置信息。'."\n" + .'注意：修改settingKey=financeUsageRegion，会将Prometheus用量数据切换到指定region的sls，同时历史用量数据将无法在Prometheus控制台查看。', + 'path' => '/prometheus-user-setting/{settingKey}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'clusterId', - 'in' => 'query', + 'name' => 'settingKey', + 'in' => 'path', 'schema' => [ - 'title' => '集群ID。', - 'description' => '集群ID。', + 'description' => '用户配置key。', 'type' => 'string', 'required' => true, - 'example' => 'c502646fd0d1249baaf792b3a1b589e1b', + 'enumValueTitles' => ['defaultPaymentType' => '默认付费方式', 'defaultPostPayDays' => '上报量付费方式的默认存量时长', 'financeUsageRegion' => '用量统计的存量regionId', 'defaultPostPayGBDays' => '写入量付费方式的默认存量时长'], + 'example' => 'financeUsageRegion', ], ], [ - 'name' => 'clusterType', + 'name' => 'settingValue', 'in' => 'query', - 'schema' => [ - 'title' => '集群类型。取值：acs.ack.cluster,acs.asi.cluster。', - 'description' => '集群类型。取值：acs.ack.cluster,acs.asi.cluster。', - 'type' => 'string', - 'required' => true, - 'example' => 'acs.ack.cluster', - ], + 'allowEmptyValue' => false, + 'schema' => ['title' => 'setting值', 'description' => '用户配置setting值。', 'type' => 'string', 'required' => true, 'example' => 'ap-southeast-1'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'integrationVersion' => [ - 'title' => '接入中心版本。', - 'description' => '接入中心版本。', - 'type' => 'string', - 'example' => 'V1', - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'CD9BCF34-EA09-5643-BC11-AF41C8DFAE5A', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"integrationVersion\\": \\"V1\\",\\n \\"requestId\\": \\"CD9BCF34-EA09-5643-BC11-AF41C8DFAE5A\\"\\n}","type":"json"}]', - 'title' => '查询容器集群链接的接入中心版本', - 'description' => '根据传入ID获取集成', - ], - 'GetPrometheusUserSetting' => [ - 'summary' => '查询Prometheus用户配置。', - 'path' => '/prometheus-user-setting', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + 'title' => '更新Prometheus用户配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpdatePrometheusUserSetting', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdatePrometheusView' => [ + 'summary' => '更新Prometheus视图实例信息。', + 'path' => '/prometheus-views/{prometheusViewId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcmsCP2WWY', - ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'aliyunLang', - 'in' => 'query', + 'name' => 'prometheusViewId', + 'in' => 'path', + 'schema' => ['description' => 'Prometheus 视图实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rw-xxxxxxxx'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '语言环境, 默认为中文 zh | en', - 'description' => '语言环境, 默认为中文 zh | en', - 'type' => 'string', + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'authFreeReadPolicy' => ['description' => '免密读策略（支持IP段和VpcId）。', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "SourceIp": ['."\n" + .' "192.168.1.0/24",'."\n" + .' "172.168.2.22"'."\n" + .' ],'."\n" + .' "SourceVpc": ['."\n" + .' "vpc-xx1",'."\n" + .' "vpc-xx2"'."\n" + .' ]'."\n" + .'}'], + 'enableAuthFreeRead' => ['title' => '是否支持免密读', 'description' => '是否支持免密读。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'enableAuthToken' => ['title' => '是否支持authToken', 'description' => '是否支持authToken。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'prometheusInstances' => [ + 'description' => 'Prometheus 实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Prometheus 实例列表。', + 'type' => 'object', + 'properties' => [ + 'prometheusInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'c7ba84651c71e442c8d0653085d862164'], + 'regionId' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-north-2-gov-1'], + 'userId' => ['description' => '用户ID。', 'type' => 'string', 'required' => false, 'example' => '16727123456789'], + ], + 'required' => false, + ], + 'required' => false, + ], + 'prometheusViewName' => ['description' => 'Prometheus 视图名称。', 'type' => 'string', 'required' => false, 'example' => 'test-prom-view-name'], + 'status' => ['description' => '运行状态。', 'type' => 'string', 'required' => false, 'example' => 'Running'], + 'workspace' => ['title' => '归属的工作空间。', 'description' => '归属的工作空间。', 'type' => 'string', 'required' => false, 'example' => 'default-cms-108490012345-cn-heyuan'], + ], 'required' => false, - 'example' => 'zh', - 'default' => 'zh', ], ], ], @@ -21710,102 +18313,75 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'prometheusUserSetting' => [ - 'description' => 'Prometheus用户配置详情。', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '配置值。', - 'example' => 'value1', - ], - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '058550FA-DDBE-519E-9C6D-93521B9A5E90', - ], + 'prometheusViewId' => ['title' => '操作结果', 'description' => 'Prometheus 视图实例ID。', 'type' => 'string', 'example' => 'rw-xxxxxx'], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '64D964F5-76C7-19A2-9399-457744AB3619'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusUserSetting\\": {\\n \\"key\\": \\"value1\\"\\n },\\n \\"requestId\\": \\"058550FA-DDBE-519E-9C6D-93521B9A5E90\\"\\n}","type":"json"}]', - 'title' => '获取Prometheus用户配置。', - ], - 'ListAddons' => [ - 'summary' => '新版接入中心产品列表(分组)。', - 'path' => '/addons', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新Prom视图实例信息', + 'description' => '更新Prom视图实例信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePrometheusView'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpdatePrometheusView', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'PrometheusView', 'arn' => 'acs:cms:{#regionId}:{#accountId}:prometheusview/{#prometheusViewId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusViewId\\": \\"rw-xxxxxx\\",\\n \\"requestId\\": \\"64D964F5-76C7-19A2-9399-457744AB3619\\"\\n}","type":"json"}]', + ], + 'UpdateService' => [ + 'path' => '/workspace/{workspace}/service/{serviceId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'aliyunLang', - 'in' => 'query', - 'schema' => [ - 'title' => '语言环境：zh / en'."\n" - .'默认为中文 zh', - 'description' => '语言环境：zh / en'."\n" - .'默认为中文 zh', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - [ - 'name' => 'category', - 'in' => 'query', - 'schema' => [ - 'title' => '标签筛选', - 'description' => '标签筛选', - 'type' => 'string', - 'required' => false, - 'example' => 'database', - ], + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => '工作空间名称。', 'type' => 'string', 'required' => true, 'example' => 'workspace-test'], ], [ - 'name' => 'search', - 'in' => 'query', - 'schema' => [ - 'title' => 'addon名称', - 'description' => '支持 Addon 名称、描述、关键词查询', - 'type' => 'string', - 'required' => false, - 'example' => '105095', - ], + 'name' => 'serviceId', + 'in' => 'path', + 'schema' => ['description' => '服务ID。', 'type' => 'string', 'required' => true, 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb'], ], [ - 'name' => 'regexp', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '查询字段, 是否正则匹配, 默认为false'."\n", - 'description' => '查询字段, 是否正则匹配, 默认为false'."\n", - 'type' => 'boolean', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'displayName' => ['description' => '显示名称，仅当serviceType=RUM时有效。', 'type' => 'string', 'required' => false, 'example' => 'api-monitor-test'], + 'description' => ['description' => '服务描述，仅当serviceType=RUM时有效。', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'attributes' => ['description' => '扩展属性。', 'type' => 'string', 'required' => false, 'example' => '{"language":"java"}'], + 'serviceStatus' => ['description' => '服务状态，仅当serviceType=RUM时有效。', 'type' => 'string', 'required' => false, 'example' => 'Stopped'], + ], 'required' => false, ], ], @@ -21815,349 +18391,92 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'addons' => [ - 'description' => '可用接入组件列表。', - 'type' => 'array', - 'items' => [ - 'description' => '接入组件详情。', - 'type' => 'object', - 'properties' => [ - 'alias' => [ - 'description' => '接入组件别名。', - 'type' => 'string', - 'example' => 'resume_vector_alias', - ], - 'categories' => [ - 'description' => '接入组件标签列表。', - 'type' => 'array', - 'items' => [ - 'description' => '标签。', - 'type' => 'string', - 'example' => 'middleware', - ], - ], - 'dashboards' => [ - 'description' => '仪表盘的列表。', - 'type' => 'array', - 'items' => [ - 'description' => '仪表盘信息。', - 'type' => 'object', - 'properties' => [ - 'description' => [ - 'description' => '仪表盘描述。', - 'type' => 'string', - 'example' => 'test', - ], - 'name' => [ - 'description' => '仪表盘名称。', - 'type' => 'string', - 'example' => 'rum_view_link_rum_api', - ], - 'url' => [ - 'description' => '仪表盘效果图地址。', - 'type' => 'string', - 'example' => 'http://xxxxxxx', - ], - ], - ], - ], - 'description' => [ - 'description' => '描述', - 'type' => 'string', - 'example' => 'workspace api monitor test', - ], - 'environments' => [ - 'description' => '支持的接入策略类型列表。', - 'type' => 'array', - 'items' => [ - 'description' => '接入策略类型信息', - 'type' => 'object', - 'properties' => [ - 'dependencies' => [ - 'description' => '接入组件的依赖列表。', - 'type' => 'object', - 'properties' => [ - 'clusterTypes' => [ - 'description' => '支持的集群类型。', - 'type' => 'array', - 'items' => [ - 'description' => '集群类型。', - 'type' => 'string', - 'example' => 'ManagedKubernetes/Default', - ], - ], - 'features' => [ - 'description' => '接入依赖的探针。', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'boolean', - 'description' => '是否支持。', - 'example' => 'true', - ], - ], - 'services' => [ - 'description' => '依赖的服务列表', - 'type' => 'array', - 'items' => [ - 'description' => '服务名称', - 'type' => 'string', - 'example' => 'Prometheus', - ], - ], - ], - ], - 'description' => [ - 'description' => '接入策略类型描述信息', - 'type' => 'string', - 'example' => 'o11y-demo-cn-heyuan', - ], - 'enable' => [ - 'description' => '是否启用', - 'type' => 'boolean', - 'example' => 'false', - ], - 'label' => [ - 'description' => '接入策略类型标签。', - 'type' => 'string', - 'example' => '容器环境', - ], - 'name' => [ - 'description' => '接入策略类型名称。', - 'type' => 'string', - 'example' => 'CS', - ], - 'policies' => [ - 'description' => '接入策略配置。', - 'type' => 'object', - 'properties' => [ - 'alertDefaultStatus' => [ - 'description' => '告警规则默认策略的启用状态。', - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'defaultInstall' => [ - 'description' => '是否默认安装', - 'type' => 'boolean', - 'example' => 'true'."\n", - ], - 'enableServiceAccount' => [ - 'description' => '是否分配 Service Account 用以与 Console API 通信。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'metricCheckRule' => [ - 'description' => '指标检测规则。', - 'type' => 'object', - 'properties' => [ - 'promQL' => [ - 'description' => 'PromQL 查询语句列表。', - 'type' => 'array', - 'items' => [ - 'description' => 'PromQL 查询语句。', - 'type' => 'string', - 'example' => 'scraper_up{scraper=\\"ecs\\"}==1', - ], - ], - ], - ], - 'needRestartAfterIntegration' => [ - 'description' => '是否在插件接入时完成安装后即进入 Pod 重启引导。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'protocols' => [ - 'description' => '配置支持的协议类型。', - 'type' => 'array', - 'items' => [ - 'description' => '配置支持的协议类型详情。', - 'type' => 'object', - 'properties' => [ - 'description' => [ - 'description' => '协议描述。', - 'type' => 'string', - 'example' => 'Support OpenTelemetry Protocal', - ], - 'icon' => [ - 'description' => '图标URL。', - 'type' => 'string', - 'example' => 'http://xxxxxxx', - ], - 'label' => [ - 'description' => '协议展示名称。', - 'type' => 'string', - 'example' => 'OpenTelemetry', - ], - 'name' => [ - 'description' => '协议名称。', - 'type' => 'string', - 'example' => 'openTelemetry', - ], - ], - ], - ], - 'targetAddonName' => [ - 'description' => '目标Addon名称。', - 'type' => 'string', - 'example' => 'cloud-acs-ecs', - ], - ], - ], - 'policyType' => [ - 'description' => '接入中心策略类型', - 'type' => 'string', - 'example' => 'CS', - ], - 'commonSchemaRefs' => [ - 'description' => '关联的Common Schema列表', - 'type' => 'array', - 'items' => [ - 'description' => '关联的Common Schema信息', - 'type' => 'object', - 'properties' => [ - 'group' => [ - 'description' => 'Common Schema 的分组名称', - 'type' => 'string', - 'example' => 'acs-ecs', - ], - 'version' => [ - 'description' => 'Common Schema的版本', - 'type' => 'string', - 'example' => '0.1.4', - ], - ], - ], - ], - ], - ], - ], - 'icon' => [ - 'description' => '图标URL地址', - 'type' => 'string', - 'example' => 'http://xxxxxxx', - ], - 'keywords' => [ - 'description' => '关键词列表', - 'type' => 'array', - 'items' => [ - 'description' => '关键词', - 'type' => 'string', - 'example' => 'Container', - ], - ], - 'language' => [ - 'description' => '语言。', - 'type' => 'string', - 'example' => 'zh', - ], - 'latestReleaseCreateTime' => [ - 'description' => '最新一次创建时间。', - 'type' => 'string', - 'example' => '2025-09-03T03:15:56Z', - ], - 'name' => [ - 'description' => '接入组件名称。', - 'type' => 'string', - 'example' => 'rum_api_dashboard_explorer_link_metric_set', - ], - 'once' => [ - 'description' => '是否只能安装一次。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'scene' => [ - 'description' => '组件场景。', - 'type' => 'string', - 'example' => 'middleware', - ], - 'version' => [ - 'description' => '组件版本。', - 'type' => 'string', - 'example' => '*', - ], - 'weight' => [ - 'description' => '接入组件展示权重。', - 'type' => 'string', - 'example' => '99', - ], - ], - ], - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], + 'requestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '123-0F43-23423-AC43-34234'], + 'serviceId' => ['description' => '服务ID。', 'type' => 'string', 'example' => 'em87vd@c2e25bcfe0e21ce0***'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"addons\\": [\\n {\\n \\"alias\\": \\"resume_vector_alias\\",\\n \\"categories\\": [\\n \\"middleware\\"\\n ],\\n \\"dashboards\\": [\\n {\\n \\"description\\": \\"test\\",\\n \\"name\\": \\"rum_view_link_rum_api\\",\\n \\"url\\": \\"http://xxxxxxx\\"\\n }\\n ],\\n \\"description\\": \\"workspace api monitor test\\",\\n \\"environments\\": [\\n {\\n \\"dependencies\\": {\\n \\"clusterTypes\\": [\\n \\"ManagedKubernetes/Default\\"\\n ],\\n \\"features\\": {\\n \\"key\\": true\\n },\\n \\"services\\": [\\n \\"Prometheus\\"\\n ]\\n },\\n \\"description\\": \\"o11y-demo-cn-heyuan\\",\\n \\"enable\\": false,\\n \\"label\\": \\"容器环境\\",\\n \\"name\\": \\"CS\\",\\n \\"policies\\": {\\n \\"alertDefaultStatus\\": \\"RUNNING\\",\\n \\"defaultInstall\\": true,\\n \\"enableServiceAccount\\": true,\\n \\"metricCheckRule\\": {\\n \\"promQL\\": [\\n \\"scraper_up{scraper=\\\\\\\\\\\\\\"ecs\\\\\\\\\\\\\\"}==1\\"\\n ]\\n },\\n \\"needRestartAfterIntegration\\": true,\\n \\"protocols\\": [\\n {\\n \\"description\\": \\"Support OpenTelemetry Protocal\\",\\n \\"icon\\": \\"http://xxxxxxx\\",\\n \\"label\\": \\"OpenTelemetry\\",\\n \\"name\\": \\"openTelemetry\\"\\n }\\n ],\\n \\"targetAddonName\\": \\"cloud-acs-ecs\\"\\n },\\n \\"policyType\\": \\"CS\\",\\n \\"commonSchemaRefs\\": [\\n {\\n \\"group\\": \\"acs-ecs\\",\\n \\"version\\": \\"0.1.4\\"\\n }\\n ]\\n }\\n ],\\n \\"icon\\": \\"http://xxxxxxx\\",\\n \\"keywords\\": [\\n \\"Container\\"\\n ],\\n \\"language\\": \\"zh\\",\\n \\"latestReleaseCreateTime\\": \\"2025-09-03T03:15:56Z\\",\\n \\"name\\": \\"rum_api_dashboard_explorer_link_metric_set\\",\\n \\"once\\": true,\\n \\"scene\\": \\"middleware\\",\\n \\"version\\": \\"*\\",\\n \\"weight\\": \\"99\\"\\n }\\n ],\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', - 'title' => '查询接入组件列表', - 'description' => '用于创建一个站点监控任务', - ], - 'ListBizTraces' => [ - 'summary' => '业务链路列表', - 'path' => '/bizTraces', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新应用可观测服务', + 'summary' => '更新应用可观测服务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateService'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpdateService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Service', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#Workspace}/service/{#ServiceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"123-0F43-23423-AC43-34234\\",\\n \\"serviceId\\": \\"em87vd@c2e25bcfe0e21ce0***\\"\\n}","type":"json"}]', + ], + 'UpdateServiceRecord' => [ + 'path' => '/workspace/{workspace}/service/{serviceId}/record', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'workspace', - 'in' => 'query', - 'schema' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => false, - 'example' => 'default-cms-xxxxxx-cn-beijing', - ], + 'in' => 'path', + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => 'workspace-test'], ], [ - 'name' => 'maxResults', - 'in' => 'query', - 'schema' => [ - 'description' => '最大返回结果数，最大值100', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'name' => 'serviceId', + 'in' => 'path', + 'schema' => ['description' => '服务ID。', 'type' => 'string', 'required' => true, 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb'], ], [ - 'name' => 'nextToken', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'allowEmptyValue' => false, + 'style' => 'json', 'schema' => [ - 'description' => '分页Token', - 'type' => 'string', + 'description' => '请求响应体', + 'type' => 'object', + 'properties' => [ + 'recordType' => [ + 'title' => '关联条目类型，目前支持:'."\n" + .'logCorrelation，标识应用日志关联', + 'description' => '关联条目类型，目前支持:'."\n" + .'logCorrelation，标识应用日志关联', + 'type' => 'string', + 'required' => true, + 'example' => 'logCorrelation', + 'enum' => ['logCorrelation'], + ], + 'recordContent' => ['title' => '条目内容，一般为JSON格式，不同的recordType的格式不同；'."\n" + .'当recordType=logCorreation时，recordContent的示例请求内容为：{"project":"proj-xtrace-16c988dcfe21fcb73c5e6f234927d998-cn-hangzhou","storeName":"app-biz-log","regionId":"cn-hangzhou","bindType":"logstore","traceIdRelateField":""}', 'description' => '条目内容，JSON字符串格式，不同的recordType的格式不同', 'type' => 'string', 'required' => true, 'example' => '{'."\n" + .' "project": "proj-xtrace-16c988dcfe21fcb73c5e6f234927d998-cn-hangzhou",'."\n" + .' "storeName": "app-biz-log",'."\n" + .' "regionId": "cn-hangzhou",'."\n" + .' "bindType": "logstore",'."\n" + .' "traceIdRelateField": ""'."\n" + .'}'], + ], 'required' => false, - 'example' => 'aa9d0e569b88098a0e3155c29b473201a', ], ], ], @@ -22168,882 +18487,277 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-*****', - ], - 'maxResults' => [ - 'description' => '最大返回结果数，最大值100', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'nextToken' => [ - 'description' => '下一次查询的令牌。', - 'type' => 'string', - 'example' => 'aa9d0e569b88098a0e3155c29b473201a', - ], - 'totalCount' => [ - 'description' => '总条数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '66', - ], - 'items' => [ - 'description' => '业务链路列表', - 'type' => 'array', - 'items' => [ - 'description' => '业务链路', - '$ref' => '#/components/schemas/BizTraceConfig', - ], - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0CEC5375-XXXX-XXXX-XXXX-9A629907C1F0'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新服务关联条目', + 'summary' => '更新服务关联条目', + 'description' => '更新已有的服务关联条目', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-*****\\",\\n \\"maxResults\\": 20,\\n \\"nextToken\\": \\"aa9d0e569b88098a0e3155c29b473201a\\",\\n \\"totalCount\\": 66,\\n \\"items\\": [\\n {\\n \\"workspace\\": \\"default-cms-xxxxxxx-cn-hangzhou\\",\\n \\"bizTraceId\\": \\"e339260ed64c95d\\",\\n \\"bizTraceName\\": \\"just test\\",\\n \\"bizTraceCode\\": \\"label_env\\",\\n \\"ruleConfig\\": \\"[{\\\\\\"entrancePid\\\\\\":\\\\\\"xxxxx@b57c44xx6e86\\\\\\",\\\\\\"rpcMatcher\\\\\\":{\\\\\\"matchType\\\\\\":\\\\\\"EQUALS\\\\\\",\\\\\\"pattern\\\\\\":\\\\\\"/createApp\\\\\\"},\\\\\\"characteristics\\\\\\":{\\\\\\"operation\\\\\\":\\\\\\"AND\\\\\\",\\\\\\"rules\\\\\\":[{\\\\\\"target\\\\\\":\\\\\\"CUSTOM_EXTRACT\\\\\\",\\\\\\"matcher\\\\\\":{\\\\\\"matchType\\\\\\":\\\\\\"CONTAINS\\\\\\",\\\\\\"pattern\\\\\\":[]}}]}}]\\",\\n \\"advancedConfig\\": \\"{\\\\\\"sample\\\\\\":{\\\\\\"strategy\\\\\\":\\\\\\"BY_APP\\\\\\"}}\\",\\n \\"createTime\\": \\"2025-12-12 00:00:00\\",\\n \\"regionId\\": \\"cn-beijing\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询业务链路列表', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-XXXX-XXXX-XXXX-9A629907C1F0\\"\\n}","type":"json"}]', ], - 'ListIntegrationPolicyAddons' => [ - 'summary' => '获取当前策略安装的Addon列表。', - 'path' => '/integration-policies/{policyId}/addons', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'UpdateSubscription' => [ + 'path' => '/subscriptions/{subscriptionId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'policyId', + 'name' => 'workspace', + 'in' => 'query', + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => false, 'example' => 'workspace-test'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'allowEmptyValue' => false, + 'schema' => ['description' => '请求Body。', 'required' => false, '$ref' => '#/components/schemas/SubscriptionForModify'], + ], + [ + 'name' => 'subscriptionId', 'in' => 'path', - 'schema' => [ - 'title' => '环境id', - 'description' => '环境id', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-3563e6bf338141b3b92c118e2c318c37', - ], + 'schema' => ['description' => '订阅ID。', 'type' => 'string', 'required' => true, 'example' => '123123123123'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应内容结构', 'type' => 'object', 'properties' => [ - 'addons' => [ - 'description' => 'Addon列表。', - 'type' => 'array', - 'items' => [ - 'description' => 'Addon信息。', - 'type' => 'object', - 'properties' => [ - 'alias' => [ - 'description' => '展示名。', - 'type' => 'string', - 'example' => 'MySQL', - ], - 'categories' => [ - 'description' => '类别。', - 'type' => 'array', - 'items' => [ - 'description' => '类别。', - 'type' => 'string', - 'example' => 'database', - ], - ], - '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://xxxxxxx', - ], - ], - ], - ], - 'description' => [ - 'description' => '描述。', - 'type' => 'string', - 'example' => 'Observability integration.', - ], - 'environments' => [ - 'description' => '支持的环境列表。', - 'type' => 'array', - 'items' => [ - 'description' => '环境信息。', - 'type' => 'object', - 'properties' => [ - 'dependencies' => [ - 'description' => '依赖。', - 'type' => 'object', - 'properties' => [ - 'clusterTypes' => [ - 'description' => '对集群类型的依赖。', - 'type' => 'array', - 'items' => [ - 'description' => '集群类型。', - 'type' => 'string', - 'example' => 'ACK', - ], - ], - 'features' => [ - 'description' => '对探针的依赖。', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'boolean', - 'description' => 'metric-agent', - 'example' => 'true', - ], - ], - 'services' => [ - 'description' => '对产品 Code 的依赖。', - 'type' => 'array', - 'items' => [ - 'description' => '服务名称', - 'type' => 'string', - 'example' => 'Prometheus', - ], - ], - ], - ], - 'description' => [ - 'description' => '描述。', - 'type' => 'string', - 'example' => 'o11y-demo-cn-heyuan', - ], - 'enable' => [ - 'description' => '是否启用', - 'type' => 'boolean', - 'example' => 'true', - ], - 'label' => [ - 'description' => '环境展示名称。', - 'type' => 'string', - 'example' => 'Cloud', - ], - 'name' => [ - 'description' => '环境名称。', - 'type' => 'string', - 'example' => 'Cloud', - ], - 'policies' => [ - 'description' => '策略。', - 'type' => 'object', - 'properties' => [ - 'alertDefaultStatus' => [ - 'description' => '告警规则默认策略的启用状态。', - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'defaultInstall' => [ - 'description' => '是否默认安装', - 'type' => 'boolean', - 'example' => 'true'."\n", - ], - 'enableServiceAccount' => [ - 'description' => '是否分配 Service Account 用以与 Console API 通信。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'metricCheckRule' => [ - 'description' => '指标检测规则。', - 'type' => 'object', - 'properties' => [ - 'promQl' => [ - 'description' => 'Prom查询语句。', - 'type' => 'array', - 'items' => [ - 'description' => 'Prom查询语句', - 'type' => 'string', - 'example' => 'up{job="mysql"} > 0', - ], - ], - ], - ], - 'needRestartAfterIntegration' => [ - 'description' => '是否在插件接入时完成安装后即进入 Pod 重启引导。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'protocols' => [ - 'description' => '协议。', - 'type' => 'array', - 'items' => [ - 'description' => '协议。', - 'type' => 'object', - 'properties' => [ - 'description' => [ - 'description' => '描述', - 'type' => 'string', - 'example' => 'test', - ], - 'icon' => [ - 'description' => '图标', - 'type' => 'string', - 'example' => ' https://img.alixxxx', - ], - 'label' => [ - 'description' => '展示名称。', - 'type' => 'string', - 'example' => 'Golang', - ], - 'name' => [ - 'description' => '协议名称。', - 'type' => 'string', - 'example' => 'golang', - ], - ], - ], - ], - 'targetAddonName' => [ - 'description' => '目标Addon名称。', - 'type' => 'string', - 'example' => 'mysql', - ], - ], - ], - ], - ], - ], - 'icon' => [ - 'description' => '组件图标。', - 'type' => 'string', - 'example' => 'asert/mysql.svg', - ], - 'keywords' => [ - 'description' => '关键词', - 'type' => 'array', - 'items' => [ - 'description' => '关键词', - 'type' => 'string', - 'example' => 'container', - ], - ], - 'language' => [ - 'description' => '语言。', - 'type' => 'string', - 'example' => 'zh', - ], - 'latestReleaseCreateTime' => [ - 'description' => '最新一次创建时间。', - 'type' => 'string', - 'example' => '2025-09-03T03:15:56Z', - ], - 'name' => [ - 'description' => 'Addon名称。', - 'type' => 'string', - 'example' => 'mysql', - ], - 'once' => [ - 'description' => '是否只能安装一次。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'scene' => [ - 'description' => '组件场景。', - 'type' => 'string', - 'example' => 'container', - ], - 'version' => [ - 'description' => '组件版本。', - 'type' => 'string', - 'example' => '0.1.1', - ], - 'weight' => [ - 'description' => '权重。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '99', - ], - ], - ], - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '7E00EF90-CEF9-57C9-9AE9-5AA937D37C03', - ], - 'total' => [ - 'description' => '总条数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求的唯一标识 ID', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-******'], + 'subscriptionId' => ['description' => '订阅ID。', 'type' => 'string', 'example' => '123123123123'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => '参数错误。'], + ], + 403 => [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => '没有权限，请使用RAM进行授权'], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => '未找到指定资源。'], + ], + 500 => [ + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => '服务运行错误。'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"addons\\": [\\n {\\n \\"alias\\": \\"MySQL\\",\\n \\"categories\\": [\\n \\"database\\"\\n ],\\n \\"dashboards\\": [\\n {\\n \\"description\\": \\"用于mysql的监控大盘\\",\\n \\"name\\": \\"MySQL Overview\\",\\n \\"url\\": \\"http://xxxxxxx\\"\\n }\\n ],\\n \\"description\\": \\"Observability integration.\\",\\n \\"environments\\": [\\n {\\n \\"dependencies\\": {\\n \\"clusterTypes\\": [\\n \\"ACK\\"\\n ],\\n \\"features\\": {\\n \\"key\\": true\\n },\\n \\"services\\": [\\n \\"Prometheus\\"\\n ]\\n },\\n \\"description\\": \\"o11y-demo-cn-heyuan\\",\\n \\"enable\\": true,\\n \\"label\\": \\"Cloud\\",\\n \\"name\\": \\"Cloud\\",\\n \\"policies\\": {\\n \\"alertDefaultStatus\\": \\"RUNNING\\",\\n \\"defaultInstall\\": true,\\n \\"enableServiceAccount\\": true,\\n \\"metricCheckRule\\": {\\n \\"promQl\\": [\\n \\"up{job=\\\\\\"mysql\\\\\\"} > 0\\"\\n ]\\n },\\n \\"needRestartAfterIntegration\\": true,\\n \\"protocols\\": [\\n {\\n \\"description\\": \\"test\\",\\n \\"icon\\": \\" https://img.alixxxx\\",\\n \\"label\\": \\"Golang\\",\\n \\"name\\": \\"golang\\"\\n }\\n ],\\n \\"targetAddonName\\": \\"mysql\\"\\n }\\n }\\n ],\\n \\"icon\\": \\"asert/mysql.svg\\",\\n \\"keywords\\": [\\n \\"container\\"\\n ],\\n \\"language\\": \\"zh\\",\\n \\"latestReleaseCreateTime\\": \\"2025-09-03T03:15:56Z\\",\\n \\"name\\": \\"mysql\\",\\n \\"once\\": true,\\n \\"scene\\": \\"container\\",\\n \\"version\\": \\"0.1.1\\",\\n \\"weight\\": 99\\n }\\n ],\\n \\"requestId\\": \\"7E00EF90-CEF9-57C9-9AE9-5AA937D37C03\\",\\n \\"total\\": 5\\n}","type":"json"}]', - 'title' => '获取当前策略安装的Addon列表', - 'description' => '获取当前策略安装的Addon列表。', - ], - 'ListIntegrationPolicyCollectors' => [ - 'summary' => '获取接入中心策略的采集器信息', - 'path' => '/integration-policies/{policyId}/collectors', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], - 'schemes' => [ - 'https', + 'title' => '更新订阅', + 'summary' => '更新订阅', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSubscription'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-******\\",\\n \\"subscriptionId\\": \\"123123123123\\"\\n}","type":"json"}]', + ], + 'UpdateUmodel' => [ + 'path' => '/workspace/{workspace}/umodel', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'policyId', + 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'title' => '接入中心策略ID。', - 'description' => '接入中心策略ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'env-d95435164593aece55f9999ce45c', - ], + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'workspace-test'], ], [ - 'name' => 'addonReleaseName', - 'in' => 'query', - 'schema' => [ - 'title' => 'Addon Release名称。', - 'description' => 'Addon Release名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'release-1234567', - ], - ], - [ - 'name' => 'collectorType', - 'in' => 'query', - 'schema' => [ - 'description' => '采集器类型', - 'type' => 'string', - 'required' => true, - 'example' => 'Exporter', - ], - ], - [ - 'name' => 'language', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '语言。', - 'type' => 'string', + 'description' => '请求 Body', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => '描述', 'type' => 'string', 'required' => false, 'example' => 'workspace test'], + ], 'required' => false, - 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'collectors' => [ - 'description' => '采集器列表。', - 'type' => 'array', - 'items' => [ - 'description' => '采集器信息。', - 'type' => 'object', - 'properties' => [ - 'collectorName' => [ - 'description' => '采集器名称', - 'type' => 'string', - 'example' => 'collector-kkxx', - ], - 'collectorType' => [ - 'description' => '采集器类型', - 'type' => 'string', - 'example' => 'Exporter', - ], - 'conditions' => [ - 'description' => '阶段状态。', - 'type' => 'array', - 'items' => [ - 'description' => '详细信息。', - 'type' => 'object', - 'properties' => [ - 'firstTransitionTime' => [ - 'description' => '第一次转换时间。', - 'type' => 'string', - 'example' => '2024-08-27T13:59:23+08:00', - ], - 'lastTransitionTime' => [ - 'description' => '最后一次转换时间。', - 'type' => 'string', - 'example' => '2024-08-27T13:59:23+08:00', - ], - 'message' => [ - 'description' => '详细信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'reason' => [ - 'description' => '失败原因', - 'type' => 'string', - 'example' => 'Probe', - ], - 'status' => [ - 'description' => '阶段状态。', - 'type' => 'string', - 'example' => 'True', - ], - 'type' => [ - 'description' => '阶段类型', - 'type' => 'string', - 'example' => 'Ready', - ], - ], - ], - ], - 'managed' => [ - 'description' => '是否为托管组件。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'state' => [ - 'description' => '采集器状态。', - 'type' => 'string', - 'example' => 'xx', - ], - 'version' => [ - 'description' => '组件版本。', - 'type' => 'string', - 'example' => '2.6.2', - ], - 'workloads' => [ - 'description' => '工作负载列表', - 'type' => 'array', - 'items' => [ - 'description' => '工作负载详情', - 'type' => 'object', - 'properties' => [ - 'hostIp' => [ - 'description' => '主机IP', - 'type' => 'string', - 'example' => '10.10.10.10', - ], - 'ip' => [ - 'description' => '工作负载的IP地址。', - 'type' => 'string', - 'example' => '11.193.82.198', - ], - 'managed' => [ - 'description' => '是否为托管组件。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'managedInfo' => [ - 'description' => '策略管理信息。', - 'type' => 'object', - 'properties' => [ - 'securityGroupId' => [ - 'description' => '安全组ID。', - 'type' => 'string', - 'example' => 'sg-xxxxx', - ], - 'vswitchId' => [ - 'description' => '交换机ID。', - 'type' => 'string', - 'example' => 'vsw-xxxxxx', - ], - ], - ], - 'message' => [ - 'description' => '详细信息。', - 'type' => 'string', - 'example' => 'ok', - ], - 'name' => [ - 'description' => '工作负载名称', - 'type' => 'string', - 'example' => 'exporter-xxx', - ], - 'namespace' => [ - 'description' => '工作负载命名空间', - 'type' => 'string', - 'example' => 'prod-db', - ], - 'ownerReferenceKind' => [ - 'description' => '引用上级的Kind', - 'type' => 'string', - 'example' => 'Deployment', - ], - 'ownerReferenceName' => [ - 'description' => '引用上级的名称', - 'type' => 'string', - 'example' => 'exporter', - ], - 'startTime' => [ - 'description' => '开始时间。', - 'type' => 'string', - 'example' => '2024-08-27T13:59:23+08:00', - ], - 'status' => [ - 'description' => '状态。', - 'type' => 'string', - 'example' => '{}', - ], - 'version' => [ - 'description' => '工作负载版本。', - 'type' => 'string', - 'example' => 'v2.4.4', - ], - ], - ], - ], - 'releaseName' => [ - 'description' => 'AddonRelease名称。', - 'type' => 'string', - 'example' => 'ecs-loong-collector-i-f8z1176fg57rlwmc1rfi', - ], - 'addonMeta' => [ - 'description' => 'Addon详情。', - '$ref' => '#/components/schemas/AddonMeta', - ], - ], - ], - ], - 'requestId' => [ - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8', - ], + 'requestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '234324-123-123-123-23423'], + 'workspace' => ['description' => '工作空间名称', 'type' => 'string', 'example' => 'workspace-test'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新 Umodel', + 'summary' => '更新Umodel配置信息。', + 'description' => '更新Umodel配置信息', + 'changeSet' => [ + ['createdAt' => '2025-08-12T02:41:41.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"collectors\\": [\\n {\\n \\"collectorName\\": \\"collector-kkxx\\",\\n \\"collectorType\\": \\"Exporter\\",\\n \\"conditions\\": [\\n {\\n \\"firstTransitionTime\\": \\"2024-08-27T13:59:23+08:00\\",\\n \\"lastTransitionTime\\": \\"2024-08-27T13:59:23+08:00\\",\\n \\"message\\": \\"success\\",\\n \\"reason\\": \\"Probe\\",\\n \\"status\\": \\"True\\",\\n \\"type\\": \\"Ready\\"\\n }\\n ],\\n \\"managed\\": false,\\n \\"state\\": \\"xx\\",\\n \\"version\\": \\"2.6.2\\",\\n \\"workloads\\": [\\n {\\n \\"hostIp\\": \\"10.10.10.10\\",\\n \\"ip\\": \\"11.193.82.198\\",\\n \\"managed\\": false,\\n \\"managedInfo\\": {\\n \\"securityGroupId\\": \\"sg-xxxxx\\",\\n \\"vswitchId\\": \\"vsw-xxxxxx\\"\\n },\\n \\"message\\": \\"ok\\",\\n \\"name\\": \\"exporter-xxx\\",\\n \\"namespace\\": \\"prod-db\\",\\n \\"ownerReferenceKind\\": \\"Deployment\\",\\n \\"ownerReferenceName\\": \\"exporter\\",\\n \\"startTime\\": \\"2024-08-27T13:59:23+08:00\\",\\n \\"status\\": \\"{}\\",\\n \\"version\\": \\"v2.4.4\\"\\n }\\n ],\\n \\"releaseName\\": \\"ecs-loong-collector-i-f8z1176fg57rlwmc1rfi\\",\\n \\"addonMeta\\": {\\n \\"name\\": \\"\\",\\n \\"version\\": \\"\\",\\n \\"language\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"scene\\": \\"\\",\\n \\"alias\\": \\"\\",\\n \\"icon\\": \\"\\",\\n \\"keywords\\": [\\n \\"\\"\\n ],\\n \\"once\\": true,\\n \\"environments\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"enable\\": true,\\n \\"label\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"policies\\": {\\n \\"defaultInstall\\": true,\\n \\"targetAddonName\\": \\"\\",\\n \\"alertDefaultStatus\\": \\"\\",\\n \\"protocols\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"label\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"icon\\": \\"\\"\\n }\\n ],\\n \\"metricCheckRule\\": {\\n \\"promQL\\": [\\n \\"\\"\\n ]\\n },\\n \\"needRestartAfterIntegration\\": true,\\n \\"enableServiceAccount\\": true,\\n \\"bindEntity\\": {\\n \\"entityGroupMode\\": true,\\n \\"singleEntityMode\\": true,\\n \\"entityType\\": \\"\\",\\n \\"vpcIdFieldKey\\": \\"\\"\\n },\\n \\"bindDefaultPolicy\\": true\\n },\\n \\"dependencies\\": {\\n \\"features\\": {\\n \\"key\\": true\\n },\\n \\"services\\": [\\n \\"\\"\\n ],\\n \\"clusterTypes\\": [\\n \\"\\"\\n ]\\n },\\n \\"policyType\\": \\"\\",\\n \\"commonSchemaRefs\\": [\\n {\\n \\"group\\": \\"\\",\\n \\"version\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"categories\\": [\\n \\"\\"\\n ],\\n \\"dashboards\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"description\\": \\"\\"\\n }\\n ],\\n \\"weight\\": 0,\\n \\"latestReleaseCreateTime\\": \\"\\"\\n }\\n }\\n ],\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8\\"\\n}","type":"json"}]', - 'title' => '获取接入中心策略的采集器', - ], - 'ListIntegrationPolicyServiceMonitors' => [ - 'summary' => '获取接入中心策略的ServiceMonitor信息', - 'path' => '/integration-policies/{policyId}/service-monitors', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUmodel'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpdateUmodel', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Umodel', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/umodel'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"234324-123-123-123-23423\\",\\n \\"workspace\\": \\"workspace-test\\"\\n}","type":"json"}]', + ], + 'UpsertUmodelCommonSchemaRef' => [ + 'path' => '/workspace/{workspace}/umodel/common-schema-ref', + 'methods' => ['patch'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'policyId', + 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'title' => '接入中心策略ID。', - 'description' => '接入中心策略ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e', - ], - ], - [ - 'name' => 'addonReleaseName', - 'in' => 'query', - 'schema' => [ - 'title' => 'Addon Release名称。', - 'description' => 'Addon Release名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'release-12345678', - ], + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'workspace-test'], ], [ - 'name' => 'namespace', + 'name' => 'group', 'in' => 'query', - 'schema' => [ - 'title' => '命名空间。', - 'description' => '命名空间。', - 'type' => 'string', - 'required' => false, - 'example' => 'arms-prom', - ], + 'schema' => ['description' => '公共Umodel Schema group', 'type' => 'string', 'required' => true, 'example' => 'card-service-daily01'], ], [ - 'name' => 'encryptYaml', + 'name' => 'version', 'in' => 'query', - 'schema' => [ - 'title' => '是否加密Yaml。', - 'description' => '是否加密Yaml。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '版本号', 'type' => 'string', 'required' => true, 'example' => '0.1.0'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'clusterId' => [ - 'description' => '集群ID.', - 'type' => 'string', - 'example' => 'ea119prod-ea119blinkcptssd1', - ], - 'policyId' => [ - 'description' => '策略 ID。', - 'type' => 'string', - 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e', - ], - 'serviceMonitors' => [ - 'description' => 'ServiceMonitor列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'addonName' => [ - 'description' => 'Addon 名称。', - 'type' => 'string', - 'example' => 'cloud-acs-ecs', - ], - 'addonReleaseName' => [ - 'description' => 'AddonRelease名称', - 'type' => 'string', - 'example' => 'release-1234567', - ], - 'addonVersion' => [ - 'description' => 'Addon版本', - 'type' => 'string', - 'example' => '0.0.1', - ], - 'configYaml' => [ - 'description' => '配置yaml', - 'type' => 'string', - 'example' => 'apiVersion: xxxxx', - ], - 'enableStatus' => [ - 'description' => '启用状态', - 'type' => 'string', - 'example' => 'run', - ], - 'encryptYaml' => [ - 'description' => '加密yaml', - 'type' => 'boolean', - 'example' => 'YXBpVmVyc2lvbjogeHh4eHgK', - ], - 'endpoints' => [ - 'description' => 'Endpoint列表。', - 'type' => 'array', - 'items' => [ - 'description' => 'Endpoint列表', - 'type' => 'object', - 'properties' => [ - 'interval' => [ - 'description' => '采集时间', - 'type' => 'string', - 'example' => '30s', - ], - 'matchedTargetCount' => [ - 'description' => '匹配的target数量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '65', - ], - 'path' => [ - 'description' => '采集路径', - 'type' => 'string', - 'example' => '/metrics', - ], - 'port' => [ - 'description' => '采集端口', - 'type' => 'string', - 'example' => '9100', - ], - 'targetPort' => [ - 'description' => '目标端口', - 'type' => 'string', - 'example' => 'http', - ], - ], - ], - ], - 'matchedServiceCount' => [ - 'description' => '匹配service的数量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50', - ], - 'name' => [ - 'description' => 'ServiceMonitor名称。', - 'type' => 'string', - 'example' => '62a526c5-f6ca-4cfb-b5a4-b76974cffe51', - ], - 'namespace' => [ - 'description' => '项目空间名称。', - 'type' => 'string', - 'example' => 'arms-prom', - ], - ], - ], - ], - 'requestId' => [ - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5', - ], + 'requestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-************'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"clusterId\\": \\"ea119prod-ea119blinkcptssd1\\",\\n \\"policyId\\": \\"policy-ac38a7cb02d14ff48bc9f97d0a75063e\\",\\n \\"serviceMonitors\\": [\\n {\\n \\"addonName\\": \\"cloud-acs-ecs\\",\\n \\"addonReleaseName\\": \\"release-1234567\\",\\n \\"addonVersion\\": \\"0.0.1\\",\\n \\"configYaml\\": \\"apiVersion: xxxxx\\",\\n \\"enableStatus\\": \\"run\\",\\n \\"encryptYaml\\": true,\\n \\"endpoints\\": [\\n {\\n \\"interval\\": \\"30s\\",\\n \\"matchedTargetCount\\": 65,\\n \\"path\\": \\"/metrics\\",\\n \\"port\\": \\"9100\\",\\n \\"targetPort\\": \\"http\\"\\n }\\n ],\\n \\"matchedServiceCount\\": 50,\\n \\"name\\": \\"62a526c5-f6ca-4cfb-b5a4-b76974cffe51\\",\\n \\"namespace\\": \\"arms-prom\\"\\n }\\n ],\\n \\"requestId\\": \\"CD8BA7D6-995D-578D-9941-78B0FECD14B5\\"\\n}","type":"json"}]', - 'title' => '获取接入中心策略的ServiceMonitor信息', - ], - 'UpdateBizTrace' => [ - 'summary' => '修改业务链路', - 'path' => '/bizTrace/{bizTraceId}', - 'methods' => [ - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '引用指定的公共Umodel Schema', + 'summary' => '更新引用的公共Umodel Schema。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpsertUmodelCommonSchemaRef'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpsertUmodelCommonSchemaRef', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Umodel', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/umodel'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-************\\"\\n}","type":"json"}]', + ], + 'UpsertUmodelData' => [ + 'path' => '/workspace/{workspace}/umodel/data', + 'methods' => ['patch'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'bizTraceId', + 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'description' => '业务链路id', - 'type' => 'string', - 'required' => false, - 'example' => 'e339260ed64c95d', - ], + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'workspace-test'], + ], + [ + 'name' => 'method', + 'in' => 'query', + 'schema' => ['description' => '方法', 'type' => 'string', 'required' => false, 'example' => 'Upsert'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求body。', + 'description' => '元素列表', 'type' => 'object', 'properties' => [ - 'bizTraceName' => [ - 'description' => '业务链路名称', - 'type' => 'string', - 'required' => false, - 'example' => 'just test', - ], - 'workspace' => [ - 'description' => '工作空间。', - 'type' => 'string', - 'required' => false, - 'example' => 'default-cms-xxxxxxx-cn-hangzhou', - ], - 'ruleConfig' => [ - 'description' => '配置规则列表', - 'type' => 'string', - 'required' => false, - 'example' => '[{"entrancePid":"xxx@d9w3jd9j3","rpcMatcher":{"matchType":"EQUALS","pattern":"/"},"characteristics":{"operation":"OR","rules":[{"target":"CUSTOM_EXTRACT","id":"oi0b3bb7","key":"biz.test","matcher":{"matchType":"CONTAINS","pattern":["1"]}}]}}]', - ], - 'advancedConfig' => [ - 'description' => '高级配置', - 'type' => 'string', + 'elements' => [ + 'description' => '元素内容', + 'type' => 'array', + 'items' => ['description' => '元素内容', 'type' => 'any', 'required' => false, 'example' => '{}'], 'required' => false, - 'example' => '{"sample":{"strategy":"BY_APP"}}', ], ], 'required' => false, @@ -23053,275 +18767,265 @@ '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' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'bizTraceId' => [ - 'description' => '业务链路id', - 'type' => 'string', - 'example' => 'e339260ed64c95d', - ], + 'requestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"bizTraceId\\": \\"e339260ed64c95d\\"\\n}","type":"json"}]', - 'title' => '修改业务链路', - ], - 'UpdatePrometheusUserSetting' => [ - 'summary' => '更新Prometheus用户配置信息。'."\n" - .'注意：修改settingKey=financeUsageRegion，会将Prometheus用量数据切换到指定region的sls，同时历史用量数据将无法在Prometheus控制台查看。', - 'path' => '/prometheus-user-setting/{settingKey}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '添加或覆盖Umodel（元素）', + 'summary' => '写入 Umodel Elements。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpsertUmodelData'], ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'settingKey', - 'in' => 'path', - 'schema' => [ - 'description' => '用户配置key。', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'defaultPaymentType' => '默认付费方式', - 'defaultPostPayDays' => '上报量付费方式的默认存量时长', - 'financeUsageRegion' => '用量统计的存量regionId', - 'defaultPostPayGBDays' => '写入量付费方式的默认存量时长', - ], - 'example' => 'financeUsageRegion', - ], - ], + 'ramActions' => [ [ - 'name' => 'settingValue', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => 'setting值', - 'description' => '用户配置setting值。', - 'type' => 'string', - 'required' => true, - 'example' => 'ap-southeast-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' => '8FDE2569-626B-5176-9844-28877A*****', - ], + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpsertUmodelData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Umodel', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/umodel'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', - 'title' => '更新Prometheus用户配置。', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', ], ], 'endpoints' => [ + ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'metrics.cn-beijing.aliyuncs.com', 'endpoint' => 'metrics.cn-beijing.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-zhengzhou-jva', 'regionName' => '郑州（联通合营）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'metrics.cn-zhengzhou-jva.aliyuncs.com', 'endpoint' => 'metrics.cn-zhengzhou-jva.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-zhengzhou-jva.aliyuncs.com'], + ['regionId' => 'cn-heyuan', 'regionName' => '华南2（河源）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'metrics.cn-heyuan.aliyuncs.com', 'endpoint' => 'metrics.cn-heyuan.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-heyuan.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3（张家口）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'metrics.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'metrics.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'ap-northeast-2', 'regionName' => '韩国（首尔）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'metrics.ap-northeast-2.aliyuncs.com', 'endpoint' => 'metrics.ap-northeast-2.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-northeast-2.aliyuncs.com'], + ['regionId' => 'ap-northeast-1', 'regionName' => '日本（东京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'metrics.ap-northeast-1.aliyuncs.com', 'endpoint' => 'metrics.ap-northeast-1.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-northeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'metrics.ap-southeast-1.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-1.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-2', 'regionName' => '澳大利亚（悉尼）已关停', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'metrics.ap-southeast-2.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-2.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-southeast-2.aliyuncs.com'], + ['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚（吉隆坡）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'metrics.ap-southeast-3.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-3.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-southeast-3.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚（雅加达）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'metrics.ap-southeast-5.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-5.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-southeast-5.aliyuncs.com'], + ['regionId' => 'ap-southeast-6', 'regionName' => '菲律宾（马尼拉）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'metrics.ap-southeast-6.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-6.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-southeast-6.aliyuncs.com'], + ['regionId' => 'ap-southeast-7', 'regionName' => '泰国（曼谷）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'metrics.ap-southeast-7.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-7.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-southeast-7.aliyuncs.com'], + ['regionId' => 'ap-southeast-8', 'regionName' => '马来西亚（柔佛州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'metrics.ap-southeast-8.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-8.aliyuncs.com', 'vpc' => 'cms-vpc.ap-southeast-8.aliyuncs.com'], + ['regionId' => 'cn-zhongwei', 'regionName' => '西北2（中卫）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'metrics.cn-zhongwei.aliyuncs.com', 'endpoint' => 'metrics.cn-zhongwei.aliyuncs.com', 'vpc' => 'cms-vpc.cn-zhongwei.aliyuncs.com'], + ['regionId' => 'cn-wulanchabu', 'regionName' => '华北6（乌兰察布）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'metrics.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'metrics.cn-wulanchabu.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-wulanchabu.aliyuncs.com'], + ['regionId' => 'cn-qingdao', 'regionName' => '华北1（青岛）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'metrics.cn-qingdao.aliyuncs.com', 'endpoint' => 'metrics.cn-qingdao.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-qingdao.aliyuncs.com'], + ['regionId' => 'cn-wuhan-lr', 'regionName' => '华中1（武汉-本地地域）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'metrics.cn-wuhan-lr.aliyuncs.com', 'endpoint' => 'metrics.cn-wuhan-lr.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-wuhan-lr.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'metrics.cn-shanghai.aliyuncs.com', 'endpoint' => 'metrics.cn-shanghai.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'metrics.cn-hongkong.aliyuncs.com', 'endpoint' => 'metrics.cn-hongkong.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'metrics.cn-shenzhen.aliyuncs.com', 'endpoint' => 'metrics.cn-shenzhen.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'cn-nanjing', 'regionName' => '华东5（南京-本地地域）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'metrics.cn-nanjing.aliyuncs.com', 'endpoint' => 'metrics.cn-nanjing.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-nanjing.aliyuncs.com'], + ['regionId' => 'cn-fuzhou', 'regionName' => '华东6（福州-本地地域）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'metrics.cn-fuzhou.aliyuncs.com', 'endpoint' => 'metrics.cn-fuzhou.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-fuzhou.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => '西南1（成都）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'metrics.cn-chengdu.aliyuncs.com', 'endpoint' => 'metrics.cn-chengdu.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-chengdu.aliyuncs.com'], + ['regionId' => 'cn-guangzhou', 'regionName' => '华南3（广州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'metrics.cn-guangzhou.aliyuncs.com', 'endpoint' => 'metrics.cn-guangzhou.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-guangzhou.aliyuncs.com'], + ['regionId' => 'cn-huhehaote', 'regionName' => '华北5（呼和浩特）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'metrics.cn-huhehaote.aliyuncs.com', 'endpoint' => 'metrics.cn-huhehaote.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-huhehaote.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'metrics.cn-hangzhou.aliyuncs.com', 'endpoint' => 'metrics.cn-hangzhou.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'us-southeast-1', 'regionName' => '美国（亚特兰大）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'metrics.us-southeast-1.aliyuncs.com', 'endpoint' => 'metrics.us-southeast-1.aliyuncs.com', 'vpc' => 'metrics-vpc.us-southeast-1.aliyuncs.com'], + ['regionId' => 'eu-west-1', 'regionName' => '英国（伦敦）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'metrics.eu-west-1.aliyuncs.com', 'endpoint' => 'metrics.eu-west-1.aliyuncs.com', 'vpc' => 'metrics-vpc.eu-west-1.aliyuncs.com'], + ['regionId' => 'eu-west-2', 'regionName' => '法国（巴黎）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'metrics.eu-west-2.aliyuncs.com', 'endpoint' => 'metrics.eu-west-2.aliyuncs.com', 'vpc' => 'cms-vpc.eu-west-2.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'metrics.eu-central-1.aliyuncs.com', 'endpoint' => 'metrics.eu-central-1.aliyuncs.com', 'vpc' => 'metrics-vpc.eu-central-1.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => '美国（弗吉尼亚）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'metrics.us-east-1.aliyuncs.com', 'endpoint' => 'metrics.us-east-1.aliyuncs.com', 'vpc' => 'metrics-vpc.us-east-1.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => '美国（硅谷）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'metrics.us-west-1.aliyuncs.com', 'endpoint' => 'metrics.us-west-1.aliyuncs.com', 'vpc' => 'metrics-vpc.us-west-1.aliyuncs.com'], + ['regionId' => 'na-south-1', 'regionName' => '墨西哥', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'metrics.na-south-1.aliyuncs.com', 'endpoint' => 'metrics.na-south-1.aliyuncs.com', 'vpc' => 'metrics-vpc.na-south-1.aliyuncs.com'], + ['regionId' => 'me-east-1', 'regionName' => '阿联酋（迪拜）', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'metrics.me-east-1.aliyuncs.com', 'endpoint' => 'metrics.me-east-1.aliyuncs.com', 'vpc' => 'metrics-vpc.me-east-1.aliyuncs.com'], + ['regionId' => 'ap-south-1', 'regionName' => '印度（孟买）已关停', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'metrics.ap-south-1.aliyuncs.com', 'endpoint' => 'metrics.ap-south-1.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-south-1.aliyuncs.com'], + ['regionId' => 'me-central-1', 'regionName' => '沙特（利雅得）', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'metrics.me-central-1.aliyuncs.com', 'endpoint' => 'metrics.me-central-1.aliyuncs.com', 'vpc' => 'metrics-vpc.me-central-1.aliyuncs.com'], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => '华东1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'metrics.cn-hangzhou-finance.aliyuncs.com', 'endpoint' => 'metrics.cn-hangzhou-finance.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-hangzhou-finance.aliyuncs.com'], + ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => '华南1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'metrics.cn-shenzhen-finance-1.aliyuncs.com', 'endpoint' => 'metrics.cn-shenzhen-finance-1.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-shenzhen-finance-1.aliyuncs.com'], + ['regionId' => 'cn-beijing-finance-1', 'regionName' => '华北2 金融云（邀测）', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'metrics.cn-beijing-finance-1.aliyuncs.com', 'endpoint' => 'metrics.cn-beijing-finance-1.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-beijing-finance-1.aliyuncs.com'], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'metrics.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'metrics.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-shanghai-finance-1.aliyuncs.com'], + ['regionId' => 'cn-wulanchabu-gic-1', 'regionName' => '华北6（乌兰察布）通用行业云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'metrics.cn-wulanchabu-gic-1.aliyuncs.com', 'endpoint' => 'metrics.cn-wulanchabu-gic-1.aliyuncs.com', 'vpc' => 'cms-vpc.cn-wulanchabu-gic-1.aliyuncs.com'], + ['regionId' => 'cn-heyuan-acdr-1', 'regionName' => '河源专属云汽车合规', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'metrics.cn-heyuan-acdr-1.aliyuncs.com', 'endpoint' => 'metrics.cn-heyuan-acdr-1.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-heyuan-acdr-1.aliyuncs.com'], + ['regionId' => 'cn-north-2-gov-1', 'regionName' => '北京政务云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'metrics.cn-north-2-gov-1.aliyuncs.com', 'endpoint' => 'metrics.cn-north-2-gov-1.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-north-2-gov-1.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'AccessDeniedException', 'message' => 'You do not have the authority to operate this rule.', 'http_code' => 401, 'description' => 'ess规则不可在云监控控制台修改。'], + ['code' => 'AccessForbidden', 'message' => 'No permission, please use Ram for authorization.', 'http_code' => 403, 'description' => '没有权限，请使用Ram进行授权。'], + ['code' => 'AgentStateError', 'message' => 'Expected agent running state is stopped.', 'http_code' => 412, 'description' => '插件状态是“已停止”时才能卸载。'], + ['code' => 'BadRequest', 'message' => 'Bad request.', 'http_code' => 400, 'description' => '错误参数请求'], + ['code' => 'ContactNotExists', 'message' => 'ContactName does not exist.', 'http_code' => 404, 'description' => '找不到联系人名称'], + ['code' => 'CSS_CREATE_ORDER_ERROR', 'message' => 'Create order error', 'http_code' => 400, 'description' => '创建订单失败'], + ['code' => 'EmptyProbeList', 'message' => 'The selected probe list is empty.', 'http_code' => 400, 'description' => '选择的探测点列表为空'], + ['code' => 'ExceedingQuota', 'message' => 'You have exceeded the task limit.', 'http_code' => 406, 'description' => '您已经超过任务限额'], + ['code' => 'ExceedingQuota', 'message' => 'Exceeding quota limits.', 'http_code' => 406, 'description' => '任务数量超出限额'], + ['code' => 'Forbidden', 'message' => 'You are not authorized to operate the specified resource.', 'http_code' => 403, 'description' => '没有权限，请使用RAM进行授权'], + ['code' => 'FrequencyLimit', 'message' => 'Frequency too high, please try again later.', 'http_code' => 429, 'description' => '频率过高，请稍后再试'], + ['code' => 'Illegal Task Name', 'message' => 'The task name of the sitemonitor task is illegal.', 'http_code' => 400, 'description' => '站点监控任务名称不合法'], + ['code' => 'IllegalAddress', 'message' => 'illegal address.', 'http_code' => 400, 'description' => '非法的地址'], + ['code' => 'Illgeal Task Name', 'message' => 'The task name for sitemonitor task is illegal.', 'http_code' => 400, 'description' => '站点监控任务名称不合法'], + ['code' => 'InsecureParams', 'message' => 'The params for site monitor is insecure.', 'http_code' => 400, 'description' => '站点监控任务的参数存在安全风险'], + ['code' => 'InternalError', 'message' => '%s.', 'http_code' => 500, 'description' => '%s'], + ['code' => 'InternalUnknownError', 'message' => 'The request processing has failed due to some unknown error.', 'http_code' => 500, 'description' => '服务运行错误。'], + ['code' => 'InternetServerError', 'message' => 'System internal error.', 'http_code' => 500, 'description' => '系统内部错误'], + ['code' => 'InvalidAuthorization', 'message' => 'Permission denied', 'http_code' => 403, 'description' => '没有权限。'], + ['code' => 'InvalidAuthorization', 'message' => 'InvalidAuthorization.', 'http_code' => 403, 'description' => '没有权限。'], + ['code' => 'InvalidAuthorization', 'message' => 'Permission denied.', 'http_code' => 403, 'description' => '没有权限。'], + ['code' => 'InvalidAuthorizationTokenExpire', 'message' => 'Authentication token expired, please re-authenticate.', 'http_code' => 403, 'description' => '认证Token过期，请重新认证'], + ['code' => 'InvalidClientTokenId', 'message' => 'not allow this operation.', 'http_code' => 403, 'description' => '没有权限'], + ['code' => 'InvalidParameter', 'message' => '%s is missing or invalid.', 'http_code' => 400, 'description' => '参数%s缺失或不合法。'], + ['code' => 'InvalidParameter', 'message' => 'Invalid parameter.', 'http_code' => 400, 'description' => '参数错误'], + ['code' => 'InvalidParameterValue', 'message' => 'Illegal parameters.', 'http_code' => 400, 'description' => '参数错误。'], + ['code' => 'InvalidQueryParameter', 'message' => 'Parameter error.', 'http_code' => 400, 'description' => '查询参数错误'], + ['code' => 'InvalidQueryParameter', 'message' => 'Invalid query parameter.', 'http_code' => 400, 'description' => '错误的查询参数'], + ['code' => 'MaxRcaTimesExceed', 'message' => 'The maximum reanalysis limit has been reached.', 'http_code' => 400, 'description' => '已达到最大重新分析次数限制。'], + ['code' => 'NameRepeat', 'message' => 'The task name already exists.', 'http_code' => 400, 'description' => '任务名称已经存在，请确认任务名称在协议拨测和浏览器拨测中都没有被重复定义'], + ['code' => 'NotAuthSLR', 'message' => 'You are not authorized role AliyunServiceRoleForCloudMonitor.', 'http_code' => 403, 'description' => '需要授权角色AliyunServiceRoleForCloudMonitor。'], + ['code' => 'NotFound', 'message' => 'The specified resource is not found.', 'http_code' => 404, 'description' => '没有找到对应的资源。'], + ['code' => 'NotFound.EndpointConnector', 'message' => 'endpoint connector not found.', 'http_code' => 404, 'description' => '服务端点不存在'], + ['code' => 'OperatorCityInvalid', 'message' => 'Invalid Isp.', 'http_code' => 400, 'description' => '运营商无效'], + ['code' => 'OperatorCityInvalid', 'message' => 'Invalid IspCity for certain probes.', 'http_code' => 400, 'description' => '提供的某些拨测点的城市运营商不合法。'], + ['code' => 'OperatorCityInvalid', 'message' => 'The synthetic probe info provided is incorrect. The incorrect probe info are as below. %s.', 'http_code' => 400, 'description' => '提供的拨测点信息不正确。'], + ['code' => 'ParameterInvalid', 'message' => 'The parameter is missing or invalid. %s', 'http_code' => 400, 'description' => '参数缺失或者参数无效。'], + ['code' => 'ParameterInvalid', 'message' => 'Parameter invalid.', 'http_code' => 400, 'description' => '非法参数'], + ['code' => 'PhoneIsEmptyOrNotVerified', 'message' => 'Contact does not have a phone number configured or not verified.', 'http_code' => 400, 'description' => '联系人未配置手机号码或未验证手机号码'], + ['code' => 'RateLimit', 'message' => 'Service rate limit.', 'http_code' => 400, 'description' => '服务负载高，请稍后再试'], + ['code' => 'ResourceExist', 'message' => 'Resource already exist .', 'http_code' => 400, 'description' => '资源已经存在。'], + ['code' => 'ResourceLimit', 'message' => 'Namespace limited.', 'http_code' => 400, 'description' => '一个账号最多允许创建30个指标仓库.'], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource is not found.', 'http_code' => 404, 'description' => '未找到指定资源。'], + ['code' => 'ResourceNotFound', 'message' => 'Resource % not found.', 'http_code' => 404, 'description' => '已废弃'], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource %s is not found.', 'http_code' => 404, 'description' => '指定资源%s不存在。'], + ['code' => 'ResourceOverLimit', 'message' => 'The resource has exceeded the limit. %s', 'http_code' => 429, 'description' => '超过数量限制。'], + ['code' => 'RestrictedUser', 'message' => 'The user has no access to this operation. %s.', 'http_code' => 403, 'description' => '用户没有当前操作的权限。'], + ['code' => 'RmcNotEnabled', 'message' => 'ResourceCenter Service is not enabled.', 'http_code' => 403, 'description' => '您尚未开通资源中心'], + ['code' => 'StrategyNameConflict', 'message' => 'The specified strategy name exits already.', 'http_code' => 400, 'description' => '指定的策略名称已经存在'], + ['code' => 'TaskIdNotExist', 'message' => 'Task does not exist.', 'http_code' => 404, 'description' => '任务不存在'], + ['code' => 'TaskNotExist', 'message' => 'Task does not exist.', 'http_code' => 400, 'description' => '站点监控任务不存在'], + ['code' => 'TaskNotExist', 'message' => 'The specified task does not exist.', 'http_code' => 404, 'description' => '任务不存在'], + ['code' => 'UnauthorizedTasks', 'message' => 'You are not permitted to operate the specified tasks.', 'http_code' => 403, 'description' => '您无权操作对应的任务'], + ['code' => 'UnsupportedWorkspaceRegion', 'message' => 'Synthetic monitoring is not supported in this workspace region.', 'http_code' => 400, 'description' => '拨测尚不支持该地域的工作空间'], + ['code' => 'VerifyCodeIsSent', 'message' => 'Verification code sent too often, please try again later.', 'http_code' => 400, 'description' => '验证码发送过于频繁，请稍后重试。'], + ['code' => 'WorkspaceNotExist', 'message' => 'The specified workspace does not exist.', 'http_code' => 400, 'description' => '工作空间不存在'], + ['code' => 'InvalidParameter', 'message' => 'The request parameter is invalid or a required parameter is missing.', 'http_code' => 400, 'description' => '请求参数非法或缺少必填参数(如 GroupName、WorkspaceId、GroupId、region 等为空)。'], + ['code' => 'InvalidMaxResults', 'message' => 'The MaxResults parameter is invalid.', 'http_code' => 400, 'description' => 'MaxResults 参数非法，应为正整数且不超过上限(分组列表 200 / 实例列表 200)。'], + ['code' => 'InvalidParameter.NextToken', 'message' => 'The NextToken is invalid or does not match the request parameters.', 'http_code' => 400, 'description' => 'NextToken 非法，或与本次请求的过滤条件不一致(翻页途中不能更改查询条件)。'], + ['code' => 'InvalidParameter.RegionId', 'message' => 'Unable to determine the region for the observe group.', 'http_code' => 400, 'description' => '无法确定分组地域(region_id)：账号未开通云资源中心(CloudResource)且无法推导中心地域。'], + ['code' => 'ObserveGroup.AlreadyExists', 'message' => 'An observe group with the same name already exists in the workspace.', 'http_code' => 409, 'description' => '同一工作空间下已存在同名观测分组，分组名称需唯一。'], + ['code' => 'DatabaseError', 'message' => 'A database error occurred while processing the request.', 'http_code' => 500, 'description' => '数据库操作失败。请稍后重试或联系管理员。'], + ['code' => 'ObserveGroup.NotFound', 'message' => 'The specified observe group does not exist.', 'http_code' => 404, 'description' => '指定的观测分组不存在。请检查 ObserveGroupId(GroupId) 是否正确，或该分组是否已被删除。'], + ['code' => 'InternalError', 'message' => 'An internal error occurred while processing the request.', 'http_code' => 500, 'description' => '服务内部错误(如下发 Diamond 配置或投递 MetaQ 失败)。请稍后重试，若持续请联系管理员。'], + ['code' => 'Workspace.NotFound', 'message' => 'The specified workspace does not exist or you have no permission.', 'http_code' => 404, 'description' => '指定的工作空间(WorkspaceId)不存在或您无权访问。租户隔离下，访问他人工作空间会按不存在处理。'], + ], + 'changeSet' => [ [ - 'regionId' => 'cn-qingdao', - 'endpoint' => 'cms.cn-qingdao.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'cms.cn-beijing.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'cms.cn-zhangjiakou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhengzhou-jva', - 'endpoint' => 'metrics.cn-zhengzhou-jva.aliyuncs.com', - ], - [ - 'regionId' => 'cn-huhehaote', - 'endpoint' => 'metrics.cn-huhehaote.aliyuncs.com', - ], - [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'metrics.cn-wulanchabu.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'metrics.cn-hangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'metrics.cn-shanghai.aliyuncs.com', - ], - [ - 'regionId' => 'cn-nanjing', - 'endpoint' => 'metrics.cn-nanjing.aliyuncs.com', - ], - [ - 'regionId' => 'cn-fuzhou', - 'endpoint' => 'metrics.cn-fuzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'metrics.cn-shenzhen.aliyuncs.com', - ], - [ - 'regionId' => 'cn-heyuan', - 'endpoint' => 'metrics.cn-heyuan.aliyuncs.com', - ], - [ - 'regionId' => 'cn-guangzhou', - 'endpoint' => 'metrics.cn-guangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'metrics.cn-chengdu.aliyuncs.com', - ], - [ - 'regionId' => 'cn-wuhan-lr', - 'endpoint' => 'metrics.cn-wuhan-lr.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'metrics.cn-hongkong.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'metrics.ap-northeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-2', - 'endpoint' => 'metrics.ap-northeast-2.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'metrics.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-2', - 'endpoint' => 'metrics.ap-southeast-2.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'metrics.ap-southeast-3.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'cms.ap-southeast-5.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-6', - 'endpoint' => 'metrics.ap-southeast-6.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-7', - 'endpoint' => 'metrics.ap-southeast-7.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhongwei', - 'endpoint' => 'metrics.cn-zhongwei.aliyuncs.com', - ], - [ - 'regionId' => 'us-east-1', - 'endpoint' => 'metrics.us-east-1.aliyuncs.com', - ], - [ - 'regionId' => 'us-west-1', - 'endpoint' => 'metrics.us-west-1.aliyuncs.com', - ], - [ - 'regionId' => 'eu-west-1', - 'endpoint' => 'metrics.eu-west-1.aliyuncs.com', - ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'metrics.eu-central-1.aliyuncs.com', - ], - [ - 'regionId' => 'na-south-1', - 'endpoint' => 'metrics.na-south-1.aliyuncs.com', - ], - [ - 'regionId' => 'us-southeast-1', - 'endpoint' => 'metrics.us-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-south-1', - 'endpoint' => 'metrics.ap-south-1.aliyuncs.com', - ], - [ - 'regionId' => 'me-east-1', - 'endpoint' => 'metrics.me-east-1.aliyuncs.com', - ], - [ - 'regionId' => 'me-central-1', - 'endpoint' => 'metrics.me-central-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-finance', - 'endpoint' => 'cms.cn-hangzhou-finance.aliyuncs.com', + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListIntegrationPolicies'], + ], + 'createdAt' => '2025-10-30T12:37:24.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'metrics.cn-shanghai-finance-1.aliyuncs.com', + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetIntegrationPolicy'], + ['description' => '响应参数发生变更', 'api' => 'ListIntegrationPolicies'], + ], + 'createdAt' => '2025-10-30T11:47:29.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shenzhen-finance-1', - 'endpoint' => 'metrics.cn-shenzhen-finance-1.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateIntegrationPolicy'], + ], + 'createdAt' => '2025-10-28T08:08:49.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-beijing-finance-1', - 'endpoint' => 'metrics.cn-beijing-finance-1.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ListIntegrationPolicyDashboards'], + ], + 'createdAt' => '2025-10-20T14:08:17.000Z', + 'description' => '', ], - [ - 'regionId' => 'cn-heyuan-acdr-1', - 'endpoint' => 'metrics.cn-heyuan-acdr-1.aliyuncs.com', + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAddonReleases'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAggTaskGroup'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntegrationPolicyStorageRequirements'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUmodelData'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAlertActions'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePrometheusInstance'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntegrationPolicyCustomScrapeJobRules'], + ['threshold' => '40', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPrometheusInstance'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetServiceObservability'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrometheusVirtualInstances'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPrometheusView'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSubscription'], + ['threshold' => '210', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAddonRelease'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEntityStore'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTicket'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAggTaskGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEntityStore'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUmodelCommonSchemaRef'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrometheusViews'], + ['threshold' => '40', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServices'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePrometheusView'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEntityStoreData'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpsertUmodelCommonSchemaRef'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWorkspace'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePrometheusVirtualInstance'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePrometheusView'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateService'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateIntegrationPolicy'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateService'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePrometheusView'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUmodelCommonSchemaRef'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutWorkspace'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntegrationPolicies'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrometheusInstances'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWorkspace'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteService'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAggTaskGroupStatus'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAggTaskGroup'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIntegrationPolicy'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAddonRelease'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUmodel'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrometheusDashboards'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpsertUmodelData'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUmodel'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUmodel'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateNotifyStrategy'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIntegrationPolicy'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAggTaskGroups'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUmodelData'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIntegrationPolicy'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWorkspaces'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAddonRelease'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntegrationPolicyDashboards'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntegrationPolicyPodMonitors'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEntityStore'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePrometheusInstance'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAggTaskGroup'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePrometheusInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUmodel'], + ['threshold' => '40', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetService'], + ['threshold' => '210', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAddonRelease'], ], - [ - 'regionId' => 'cn-north-2-gov-1', - 'endpoint' => 'metrics.cn-north-2-gov-1.aliyuncs.com', + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ram' => [ + 'productCode' => 'Cms', + 'productName' => '云监控', + 'ramCodes' => ['cms'], + 'ramLevel' => '服务级', + 'ramConditions' => [ + [ + 'name' => 'acs:Service', + 'schema' => ['type' => 'String'], + ], + [ + 'name' => 'acs:ResourceGroupId', + 'schema' => ['type' => 'String'], + ], ], + 'ramActions' => [], + 'resourceTypes' => [], ], ]; |