diff options
Diffstat (limited to 'data/en_us/cms/2024-03-30/api-docs.php')
| -rw-r--r-- | data/en_us/cms/2024-03-30/api-docs.php | 35057 |
1 files changed, 15917 insertions, 19140 deletions
diff --git a/data/en_us/cms/2024-03-30/api-docs.php b/data/en_us/cms/2024-03-30/api-docs.php index 58f41b1..8194fe6 100644 --- a/data/en_us/cms/2024-03-30/api-docs.php +++ b/data/en_us/cms/2024-03-30/api-docs.php @@ -1,2638 +1,1548 @@ <?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' => null, + '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' => 'Datasets', ], [ - 'id' => 372150, - 'title' => null, + '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' => 'Context library', ], [ - 'id' => 372163, - 'title' => null, + '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' => 'Memory library', ], [ - 'id' => 372178, - 'title' => null, - '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' => 'Workspaces', ], [ - 'id' => 372185, - 'title' => null, + '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' => 'Data access', ], [ - 'id' => 372210, - 'title' => null, + 'children' => ['CreateServiceObservability', 'GetServiceObservability', 'DeleteService', 'UpdateService', 'GetService', 'CreateService', 'ListServices'], 'type' => 'directory', - 'children' => [ - 'ListAlertActions', - 'UpdateSubscription', - 'CreateAlertWebhook', - 'DeleteAlertWebhooks', - 'ListAlertWebhooks', - 'UpdateAlertWebhook', - 'UpdateNotifyStrategy', - ], + 'title' => 'Application monitoring/user experience monitoring', ], [ - 'id' => 372218, - 'title' => null, - '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' => 372220, - 'title' => null, + 'children' => ['ListAlertActions', 'CreateAlertWebhook', 'DeleteAlertWebhooks', 'ListAlertWebhooks', 'UpdateAlertWebhook', 'UpdateNotifyStrategy'], 'type' => 'directory', - 'children' => [ - 'TagResources', - 'UntagResources', - 'ListTagResources', - 'ChangeResourceGroup', - ], + 'title' => 'Alerting', ], [ - 'id' => 372225, - 'title' => null, + 'children' => ['CreateTicket'], 'type' => 'directory', - 'children' => [ - 'DescribeRegions', - ], + 'title' => 'Console embedding', ], [ - 'id' => 372227, - 'title' => null, + 'children' => ['GetCmsService'], 'type' => 'directory', - 'children' => [ - 'GetCmsService', - ], + 'title' => 'Service activation', ], [ - 'id' => 372229, - 'title' => null, - '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', 'CreateServiceRecord', 'DeleteServiceRecord', 'GetServiceRecord', 'ListServiceRecords', + 'UpdateServiceRecord', ], + 'type' => 'directory', + 'title' => 'Others', ], ], 'components' => [ 'schemas' => [ - 'AddonMeta' => [ - 'description' => '', - 'visibility' => 'Public', + 'ActionIntegrationConfig' => [ + 'description' => 'Contains configuration for action integration.', 'type' => 'object', 'properties' => [ - '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' => '', - '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', + 'enabled' => ['description' => 'Indicates whether action integration is enabled.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'actions' => [ + 'description' => 'A list of actions to perform.', + 'type' => 'array', + 'items' => ['description' => 'The name of the action to perform.', 'type' => 'string', 'title' => '', 'example' => ''], + 'title' => '', 'example' => '', - 'backendName' => 'alias', - ], - 'icon' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'assets/logos/ecs.svg', - 'backendName' => 'icon', ], + ], + 'title' => '', + 'example' => '', + ], + 'AddonMeta' => [ + 'description' => 'Information about the integration component.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the component.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'title' => '', 'example' => 'cloud-acs-ecs'], + 'version' => ['description' => 'The version number.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'version', 'title' => '', 'example' => '0.0.1'], + 'language' => ['description' => 'The language. Valid values:'."\n" + ."\n" + .'- zh: Chinese (default)'."\n" + ."\n" + .'- en: English', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'language', 'title' => '', 'example' => 'zh'], + 'description' => ['description' => 'The description.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'title' => '', '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' => 'The scenario.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'scene', 'title' => '', 'example' => 'feature'], + 'alias' => ['description' => 'The alias of the component. This is the display name.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'alias', 'title' => '', 'example' => 'ECS 监控'], + 'icon' => ['description' => 'The icon of the component.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'icon', 'title' => '', 'example' => 'assets/logos/ecs.svg'], 'keywords' => [ - 'description' => '', + 'description' => 'The list of keywords.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Monitor', - 'extendType' => 'true', - ], + 'items' => ['description' => 'A keyword.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'Monitor'], 'backendName' => 'keywords', + 'title' => '', + 'example' => '', ], - 'once' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true/false', - 'backendName' => 'once', - ], + 'once' => ['description' => 'Indicates whether the component can be installed only once under a policy.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'once', 'title' => '', 'example' => 'true/false'], 'environments' => [ - 'description' => '', + 'description' => 'The list of supported environment types.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The description of the integration environment type.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - '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', - ], + 'name' => ['description' => 'The name of the environment type.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'title' => '', 'example' => 'CS/ECS/Cloud/Client'], + 'enable' => ['description' => 'Indicates whether the environment type is enabled.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'enable', 'title' => '', 'example' => 'true/false'], + 'label' => ['description' => 'The display name of the environment type.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'label', 'title' => '', 'example' => '容器环境'], + 'description' => ['description' => 'The description of the environment type.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'title' => '', 'example' => '支持容器集群的工作覆盖监控'], 'policies' => [ - 'description' => '', + 'description' => 'Information about the control policy group for the component.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - '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', - ], + 'defaultInstall' => ['description' => 'Indicates whether the component is installed by default.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'defaultInstall', 'title' => '', 'example' => 'true/false'], + 'targetAddonName' => ['description' => 'The name of the target component for redirection.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'targetAddonName', 'title' => '', 'example' => 'cloud-acs-ecs'], + 'alertDefaultStatus' => ['description' => 'Indicates whether the alert rule is enabled by default after installation.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'alertDefaultStatus', 'title' => '', 'example' => 'RUNNING'], 'protocols' => [ - 'description' => '', + 'description' => 'The list of supported client protocols.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Information about the protocol.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Prometheus', - 'backendName' => 'name', - ], - 'label' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'label', - ], - 'description' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'description', - ], - 'icon' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'assets/logos/ecs.svg'."\n", - 'backendName' => 'icon', - ], + 'name' => ['description' => 'The name of the protocol.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'title' => '', 'example' => 'Prometheus'], + 'label' => ['description' => 'The display name of the protocol.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'label', 'title' => '', 'example' => 'Prometheus 协议'], + 'description' => ['description' => 'The description of the protocol.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'title' => '', 'example' => '使用 Prometheus 协议写入指标数据'], + 'icon' => ['description' => 'The display icon for the protocol.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'icon', 'title' => '', 'example' => 'assets/logos/ecs.svg'."\n"], ], 'extendType' => 'true', + 'title' => '', + 'example' => '', ], 'backendName' => 'protocols', + 'title' => '', + 'example' => '', ], 'metricCheckRule' => [ - 'description' => '', + 'description' => 'The data check rule after the component is integrated.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'promQL' => [ - 'description' => '', + 'description' => 'The Prometheus Query Language (PromQL) for the check rule.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'up{job="acs-ecs"}==1', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The PromQL for the check rule.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'up{job="acs-ecs"}==1'], 'backendName' => 'promQL', + 'title' => '', + 'example' => '', ], ], 'backendName' => 'metricCheckRule', + 'title' => '', + 'example' => '', ], - 'needRestartAfterIntegration' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true/false', - 'backendName' => 'needRestartAfterIntegration', - ], - 'enableServiceAccount' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true/false', - 'backendName' => 'enableServiceAccount', - ], + 'needRestartAfterIntegration' => ['description' => 'Indicates whether to prompt for a workload restart after integration.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'needRestartAfterIntegration', 'title' => '', 'example' => 'true/false'], + 'enableServiceAccount' => ['description' => 'Indicates whether to enable internal authorization token allocation.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'enableServiceAccount', 'title' => '', 'example' => 'true/false'], 'bindEntity' => [ - 'description' => '', + 'description' => 'Information about the attached target entity.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - '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' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'vpcId', - 'backendName' => 'vpcIdFieldKey', - ], + 'entityGroupMode' => ['description' => 'Indicates whether group mode is used.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'entityGroupMode', 'title' => '', 'example' => 'true/false'], + 'singleEntityMode' => ['description' => 'Indicates whether single-entity mode is used.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'singleEntityMode', 'title' => '', 'example' => 'true/false'."\n"], + 'entityType' => ['description' => 'The entity type.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'entityType', 'title' => '', 'example' => 'acs.ecs.instance'], + 'vpcIdFieldKey' => ['description' => 'The field in the entity from which to fetch the VPC ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'vpcIdFieldKey', 'title' => '', 'example' => 'vpcId'], ], 'backendName' => 'bindEntity', + 'title' => '', + 'example' => '', ], - 'bindDefaultPolicy' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true/false', - 'backendName' => 'bindDefaultPolicy', - ], + 'bindDefaultPolicy' => ['description' => 'The default mode. This integration mode does not require attaching an entity.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'bindDefaultPolicy', 'title' => '', 'example' => 'true/false'], ], 'backendName' => 'policies', + 'title' => '', + 'example' => '', ], 'dependencies' => [ - 'description' => '', + 'description' => 'The dependency description.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'features' => [ - 'description' => '', + 'description' => 'The probe dependency description. This is the component name. In later versions, this field is replaced by the collectors field.', 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true/false', - ], + 'additionalProperties' => ['description' => 'Indicates whether there is a dependency.', 'visibility' => 'Public', 'type' => 'boolean', 'title' => '', 'example' => 'true/false'], 'backendName' => 'features', + 'title' => '', + 'example' => '', ], 'services' => [ - 'description' => '', + 'description' => 'The list of dependent services.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cmee', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The code name of the service. The service check is performed by the frontend.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'cmee'], 'backendName' => 'services', + 'title' => '', + 'example' => '', ], 'clusterTypes' => [ - 'description' => '', + 'description' => 'The supported cluster types.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ManagedKubernetes/Default', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The name of the cluster type.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'ManagedKubernetes/Default'], 'backendName' => 'clusterTypes', + 'title' => '', + 'example' => '', ], ], 'backendName' => 'dependencies', + 'title' => '', + 'example' => '', ], - 'policyType' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ECS', - 'backendName' => 'policyType', - ], + 'policyType' => ['description' => 'The policy type.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'policyType', 'title' => '', 'example' => 'ECS'], 'commonSchemaRefs' => [ - 'description' => '', + 'description' => 'The list of attached CommonSchemas.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'group' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'acs-ecs', - 'backendName' => 'group', - ], - 'version' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '0.1.0', - 'backendName' => 'version', - ], + 'group' => ['description' => 'The group name of the CommonSchema.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'group', 'title' => '', 'example' => 'acs-ecs'], + 'version' => ['description' => 'The group version of the CommonSchema.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'version', 'title' => '', 'example' => '0.1.0'], ], 'extendType' => 'true', + 'description' => '', + 'title' => '', + 'example' => '', ], 'backendName' => 'commonSchemaRefs', + 'title' => '', + 'example' => '', ], ], 'extendType' => 'true', + 'title' => '', + 'example' => '', ], 'backendName' => 'environments', + 'title' => '', + 'example' => '', ], 'categories' => [ - 'description' => '', + 'description' => 'The categorization information of the component.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'infrastructure', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The category name.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'infrastructure'], 'backendName' => 'categories', + 'title' => '', + 'example' => '', ], 'dashboards' => [ - 'description' => '', + 'description' => 'A list of component diagrams.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'A list of diagrams.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'name', - ], - 'url' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'assets/dashboards/ecs.png'."\n", - 'backendName' => 'url', - ], - 'description' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'description', - ], + 'name' => ['description' => 'The name of the diagram.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'title' => '', 'example' => 'ECS 监控概览大盘'], + 'url' => ['description' => 'The URL of the diagram.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'url', 'title' => '', 'example' => 'assets/dashboards/ecs.png'."\n"], + 'description' => ['description' => 'The description.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'title' => '', 'example' => '描述信息'], ], 'extendType' => 'true', + 'title' => '', + 'example' => '', ], 'backendName' => 'dashboards', + 'title' => '', + 'example' => '', ], - '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', - ], + 'weight' => ['description' => 'The sorting weight of the component.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'weight', 'title' => '', 'example' => '1000'], + 'latestReleaseCreateTime' => ['description' => 'The last time the component was integrated.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'latestReleaseCreateTime', 'title' => '', 'example' => '2025-10-25 09:12:12'], ], + 'title' => '', + 'example' => '', ], 'AlertEventIntegrationPolicyForModify' => [ 'title' => 'A short description of struct', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The entity.', 'type' => 'object', 'properties' => [ 'transformerSetting' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The transform settings.', 'type' => 'array', - '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' => [ + 'items' => ['description' => 'A single transform configuration.', '$ref' => '#/components/schemas/TransformAction', 'title' => '', 'example' => '', 'visibility' => 'Public', 'extendType' => 'true'], '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' => '', + 'example' => '', 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'test integration', - 'backendName' => 'alertEventIntegrationPolicyName', + 'backendName' => 'transformerSetting', ], + 'description' => ['title' => '描述', 'description' => 'The description.', 'type' => 'string', 'example' => 'test', 'visibility' => 'Public', 'backendName' => 'description'], + 'filterSetting' => ['description' => 'The filter settings.', '$ref' => '#/components/schemas/FilterSetting', 'title' => '', 'example' => '', 'visibility' => 'Public', 'backendName' => 'filterSetting'], + 'integrationSetting' => ['title' => '订阅设置', 'description' => 'The subscription settings.', 'type' => 'string', 'example' => '{"region":"cn-hangzhou"}', 'visibility' => 'Public', 'backendName' => 'integrationSetting'], + 'type' => ['title' => '类型', 'description' => 'The type.', 'type' => 'string', 'example' => 'ALERT_CUSTOM', 'visibility' => 'Public', 'backendName' => 'type'], + 'alertEventIntegrationPolicyName' => ['title' => '名称', 'description' => 'The name.', 'type' => 'string', 'required' => true, 'example' => 'test integration', 'visibility' => 'Public', 'backendName' => 'alertEventIntegrationPolicyName'], ], + 'example' => '', + 'visibility' => 'Public', ], 'AlertEventIntegrationPolicyForView' => [ 'title' => 'A short description of struct', - 'description' => '', + 'description' => 'The entity for viewing.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - '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' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '123123', - 'backendName' => 'userId', - ], - 'alertEventIntegrationPolicyId' => [ - 'title' => 'UUID', - 'description' => 'UUID', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '123123123', - 'backendName' => 'alertEventIntegrationPolicyId', - ], - 'token' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '10-16818f1445e10a1d012922b285bfb334', - 'backendName' => 'token', - ], + 'workspace' => ['title' => 'workspace', 'description' => 'The workspace.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'workspace', 'example' => 'workspace-test'], + 'description' => ['title' => '描述', 'description' => 'The description.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'example' => 'workspace test'], + 'filterSetting' => ['description' => 'The filter configuration.', 'visibility' => 'Public', 'backendName' => 'filterSetting', '$ref' => '#/components/schemas/FilterSetting', 'title' => '', 'example' => ''], + 'updateTime' => ['title' => '更新时间', 'description' => 'The time when the policy was last updated.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'updateTime', 'example' => '2024-12-16T02:00:23Z'], + 'type' => ['title' => '类型', 'description' => 'The type.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'type', 'example' => 'ALERT_CUSTOM'], + 'userId' => ['title' => '用户id', 'description' => 'The user ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'userId', 'example' => '123123'], + 'alertEventIntegrationPolicyId' => ['title' => 'UUID', 'description' => 'The universally unique identifier (UUID).', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'alertEventIntegrationPolicyId', 'example' => '123123123'], + 'token' => ['description' => 'The key for the integration\'s reporting endpoint.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'token', 'title' => '', 'example' => '10-16818f1445e10a1d012922b285bfb334'], 'transformerSetting' => [ - 'description' => '', + 'description' => 'The transformation settings.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/TransformAction', - ], + 'items' => ['description' => 'A single transformation configuration.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/TransformAction', 'title' => '', 'example' => ''], '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', ], + 'createTime' => ['title' => '创建时间', 'description' => 'The time when the policy was created.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'createTime', 'example' => '2025-03-11T08:21:58Z'], + 'enable' => ['title' => '是否启用', 'description' => 'Indicates whether the policy is enabled.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'enabled', 'example' => 'true'], + 'integrationSetting' => ['title' => '订阅设置', 'description' => 'The subscription settings.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'integrationSetting', 'example' => '{"region":"cn-hangzhou"}'], + 'alertEventIntegrationPolicyName' => ['title' => '名称', 'description' => 'The name.', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'backendName' => 'alertEventIntegrationPolicyName', 'example' => '集成名'], ], + 'example' => '', ], 'AlertRuleAction' => [ - 'description' => '', + 'description' => 'The action integration configuration for the alert rule.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'actions' => [ - 'description' => '', + 'description' => 'A list of action integration IDs.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myTestAction', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The action integration ID.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'myTestAction'], 'backendName' => 'actions', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], 'AlertRuleAlertMetricFilterDef' => [ - 'description' => 'Alert Rule Alert Metric Filter Definition Object.', + 'description' => 'An object that defines the metric filter for an alert rule.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'opt' => [ - 'description' => 'Filter Condition Operator.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '=', - 'backendName' => 'opt', - ], - 'hidden' => [ - 'title' => '', - 'description' => 'Whether to hide. If hidden, it will not be displayed in the frontend UI, but its value can still be included when rendering the PromQL. A typical example is the "pid" filter condition in APM scenarios, which is generally not exposed through configurable UI elements but instead presented as a separate application search list in the frontend.', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'hidden', - ], - 'displayNameCn' => [ - 'description' => 'Display Name (Chinese).', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Application Status', - 'backendName' => 'displayNameCn', - ], - 'dim' => [ - 'description' => 'Dimension in APM metrics.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'status', - 'backendName' => 'dim', - ], - 'displayNameEn' => [ - 'description' => 'Display Name (English).', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Application Status', - 'backendName' => 'displayNameEn', - ], - 'labelDisabled' => [ - 'title' => '', - 'description' => 'When true, the filter item will not appear in the label filter of the PromQL.', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'labelDisabled', - ], - 'dimDisabled' => [ - 'title' => '', - 'description' => 'When true, the filter item will not appear in the GROUP BY clause of the PromQL.', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'dimDisabled', - ], + 'opt' => ['description' => 'The operator for the filter condition.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'opt', 'title' => '', 'example' => '='], + 'hidden' => ['title' => '是否隐藏。 如果隐藏则在前端交互中不显示，但在渲染promQL时可将该过滤条件的值上传上来。 典型的例子是APM场景中的pid这个过滤条件，一般不会通过配置化的方式进行显示，而是前端显为独立的应用搜索列表。', 'description' => 'Specifies whether to hide the filter. If hidden, the filter does not appear in the frontend UI. However, its value can be uploaded when rendering a PromQL query. For example, in an Application Performance Management (APM) scenario, the pid filter is typically hidden from the configuration UI. The frontend displays it as a separate application search list.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'hidden', 'example' => 'true'], + 'displayNameCn' => ['description' => 'The display name in Chinese.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'displayNameCn', 'title' => '', 'example' => '应用状态'], + 'dim' => ['description' => 'The dimension in APM metrics.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'dim', 'title' => '', 'example' => 'status'], + 'displayNameEn' => ['description' => 'The display name in English.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'displayNameEn', 'title' => '', 'example' => 'Application Status'], + 'labelDisabled' => ['title' => '为true时，过滤项不出现在promQL的label filter中', 'description' => 'If set to \\`true\\`, the filter item does not appear in the label filter of a PromQL query.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'labelDisabled', 'example' => 'true'], + 'dimDisabled' => ['title' => '为true是，过滤项不出现在promQL的group by中', 'description' => 'If set to \\`true\\`, the filter item does not appear in the \\`group by\\` clause of a PromQL query.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'dimDisabled', 'example' => 'true'], 'supportedOpts' => [ - 'description' => 'List of supported options.', + 'description' => 'A list of supported options.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ - 'description' => 'Supported options.', + 'description' => 'A supported option.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'displayNameCn' => [ - 'description' => 'Display Name (Chinese).', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Online', - 'backendName' => 'displayNameCn', - ], - 'displayNameEn' => [ - 'description' => 'Display Name (English).', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Online', - 'backendName' => 'displayNameEn', - ], - 'value' => [ - 'description' => 'Matching value.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'online', - 'backendName' => 'value', - ], + 'displayNameCn' => ['description' => 'The display name in Chinese.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'displayNameCn', 'title' => '', 'example' => '在线'], + 'displayNameEn' => ['description' => 'The display name in English.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'displayNameEn', 'title' => '', 'example' => 'Online'], + 'value' => ['description' => 'The matching value.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'value', 'title' => '', 'example' => 'online'], ], 'extendType' => 'true', + 'title' => '', + 'example' => '', ], 'backendName' => 'supportedOpts', 'itemName' => 'opt', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], 'AlertRuleAlertMetricFilterDef_array' => [ - 'description' => '', + 'description' => 'An array of alert metric filter definition objects.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/AlertRuleAlertMetricFilterDef', - ], + 'items' => ['description' => 'An alert metric filter definition object.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/AlertRuleAlertMetricFilterDef', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], 'AlertRuleAlertMetricInput' => [ - 'description' => 'Predefined Metric Input Configuration.', + 'description' => 'The input configuration for a predefined metric.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'filterValues' => [ - 'title' => '', - 'description' => 'List of user-provided filter conditions. The supported parameters and filter conditions for the metric can be queried via ListAlertMetrics.', + 'title' => '用户输入的过滤条件列表。指标所支持的参数列表、过滤条件列表可通过ListAlertMetrics进行查询。', + 'description' => 'A list of filter conditions. Call the ListAlertMetrics operation to query the lists of parameters and filter conditions that the metric supports.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'Filter Item Configuration.', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/AlertRuleAlertMetricInputFilterValue', - ], + 'items' => ['description' => 'The configuration of a filter item.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/AlertRuleAlertMetricInputFilterValue', 'title' => '', 'example' => ''], 'backendName' => 'filterValues', + 'example' => '', ], 'paramValues' => [ - 'title' => '', - 'description' => 'List of input parameters. The metric\'s supported parameters and filter conditions can be queried via ListAlertMetrics.', + 'title' => '输入的参数列表。 指标所支持的参数列表、过滤条件列表可通过ListAlertMetrics进行查询。', + 'description' => 'A list of parameters. Call the ListAlertMetrics operation to query the lists of parameters and filter conditions that the metric supports.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'Predefined Metric Parameter Configuration.', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/AlertRuleAlertMetricInputParamValue', - ], + 'items' => ['description' => 'The parameter configuration for the predefined metric.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/AlertRuleAlertMetricInputParamValue', 'title' => '', 'example' => ''], 'backendName' => 'paramValues', + 'example' => '', ], - 'metricId' => [ - 'title' => '', - 'description' => 'Key of the predefined metric selected by the user.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'appstat.jvm.GcPsMarkSweepCount', - 'backendName' => 'metricKey', - ], - 'groupId' => [ - 'title' => '', - 'description' => 'Key of the metric group selected by the user.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'apm.jvm'."\n", - 'backendName' => 'groupKey', - ], + 'metricId' => ['title' => '用户所选预定义指标的key', 'description' => 'The key of the predefined metric.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'metricKey', 'example' => 'appstat.jvm.GcPsMarkSweepCount'], + 'groupId' => ['title' => '用户所选指标组的key', 'description' => 'The key of the metric group.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'groupKey', 'example' => 'apm.jvm'."\n"], ], + 'title' => '', + 'example' => '', ], 'AlertRuleAlertMetricInputFilterValue' => [ - 'description' => 'Filter Condition Configuration Object.', - 'visibility' => 'Public', + 'description' => 'The configuration object for the filter condition.', 'type' => 'object', 'properties' => [ - 'opt' => [ - 'title' => '', - 'description' => 'Filter Condition Operator.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'ALL', - 'backendName' => 'opt', - ], - 'dim' => [ - 'title' => '', - 'description' => 'Dimension of the filter condition.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'rootIp', - 'backendName' => 'dim', - ], - 'value' => [ - 'description' => 'Filter Condition Value.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '127.0.0.1', - 'backendName' => 'value', - ], + 'opt' => ['title' => '过滤条件操作符', 'description' => 'The operator for the filter condition.', 'type' => 'string', 'required' => true, 'example' => 'ALL', 'visibility' => 'Public', 'backendName' => 'opt'], + 'dim' => ['title' => '过滤条件的维度', 'description' => 'The dimension of the filter condition.', 'type' => 'string', 'required' => true, 'example' => 'rootIp', 'visibility' => 'Public', 'backendName' => 'dim'], + 'value' => ['description' => 'The value of the filter condition.', 'type' => 'string', 'title' => '', 'example' => '127.0.0.1', 'visibility' => 'Public', 'backendName' => 'value'], ], + 'title' => '', + 'example' => '', + 'visibility' => 'Public', ], 'AlertRuleAlertMetricInputParamValue' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The parameter settings object for a predefined metric.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'paramName', - 'backendName' => 'name', - ], - 'value' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'paramValue', - 'backendName' => 'value', - ], + 'name' => ['description' => 'The name of the predefined metric parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'paramName', 'visibility' => 'Public', 'backendName' => 'name'], + 'value' => ['description' => 'The value of the predefined metric parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'paramValue', 'visibility' => 'Public', 'backendName' => 'value'], ], + 'title' => '', + 'example' => '', + 'visibility' => 'Public', ], 'AlertRuleAlertMetricParamDef' => [ - 'description' => '', + 'description' => 'Defines the alert metric parameters for an alert rule.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'placeholderEn' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Enter value', - 'backendName' => 'placeholderEn', - ], - 'placeholderCn' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'placeholderCn', - ], + 'placeholderEn' => ['title' => '仅对INPUT_PARAM有效。用于前端展示的英文展位符', 'description' => 'The English placeholder text displayed on the frontend. This parameter is valid only for INPUT\\_PARAM.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'placeholderEn', 'example' => 'Enter value'], + 'placeholderCn' => ['title' => '仅对INPUT_PARAM有效。用于前端展示的中文展位符', 'description' => 'The Chinese placeholder text displayed on the frontend. This parameter is valid only for INPUT\\_PARAM.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'placeholderCn', 'example' => '请输入值'], 'values' => [ - 'title' => '', - 'description' => '', + 'title' => '仅对SELECT_PARAM有效。 下拉列表的可选值列表。', + 'description' => 'The list of available options in the drop-down list. This parameter is valid only for SELECT\\_PARAM.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'An object that represents an option.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - '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', - ], + 'labelCn' => ['title' => '选项的中文显示名称', 'description' => 'The Chinese display name of the option.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'labelCn', 'example' => '测试环境'], + 'labelEn' => ['title' => '选项的英文显示名称', 'description' => 'The English display name of the option.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'labelEn', 'example' => 'Staging'], + 'value' => ['description' => 'The value.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'value', 'title' => '', 'example' => 'staging'], ], 'extendType' => 'true', + 'title' => '', + 'example' => '', ], 'backendName' => 'values', 'itemName' => 'value', + 'example' => '', ], - 'name' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'env', - 'backendName' => 'name', - ], - 'minWidth' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - 'backendName' => 'minWidth', - ], - 'type' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'TEXT_PARAM', - 'backendName' => 'type', - ], - 'value' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'staging', - 'backendName' => 'value', - ], - 'maxWidth' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - 'backendName' => 'maxWidth', - ], + 'name' => ['description' => 'The name.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'title' => '', 'example' => 'env'], + 'minWidth' => ['title' => '输入框的最小宽度，仅对SELECT_PARAM、INPUT_PARAM生效', 'description' => 'The minimum width of the input control. This parameter is valid only for SELECT\\_PARAM and INPUT\\_PARAM.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'minWidth', 'example' => '100'], + 'type' => ['title' => '● TEXT_PARAM: 只读文本参数，由后台定义，前端不显示用户输入控件'."\n" + .'● INPUT_PARAM：输入框参数'."\n" + .'● SELECT_PARAM：选择框参数', 'description' => '● TEXT\\_PARAM: A read-only text parameter defined by the backend. No user input control is displayed on the frontend.● INPUT\\_PARAM: An input box parameter.● SELECT\\_PARAM: A selection box parameter.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'type', 'example' => 'TEXT_PARAM'], + 'value' => ['description' => 'The value.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'value', 'title' => '', 'example' => 'staging'], + 'maxWidth' => ['title' => '输入框的最大宽度，仅对SELECT_PARAM、INPUT_PARAM生效', 'description' => 'The maximum width of the input control. This parameter is valid only for SELECT\\_PARAM and INPUT\\_PARAM.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'maxWidth', 'example' => '200'], ], + 'title' => '', + 'example' => '', ], 'AlertRuleAlertMetricParamDef_array' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'A list of parameter definition objects for alert rule metrics.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/AlertRuleAlertMetricParamDef', - ], + 'items' => ['description' => 'A parameter definition object for an alert rule metric.', '$ref' => '#/components/schemas/AlertRuleAlertMetricParamDef', 'title' => '', 'example' => '', 'visibility' => 'Public', 'extendType' => 'true'], + 'title' => '', + 'example' => '', + 'visibility' => 'Public', ], 'AlertRuleCondition' => [ - 'description' => 'Alert rule condition configuration. The fields included in this configuration object depend on the condition type (the "type" field), and different condition types use different fields.', - 'visibility' => 'Public', + 'description' => 'The alert rule condition configuration. The fields included in this configuration object depend on the condition type (the type field). Different condition types use different fields.', 'type' => 'object', 'properties' => [ - 'alertCount' => [ - 'title' => '', - 'description' => 'Applicable condition type: SLS_CONDITION.'."\n" - .'Number of times the condition must be met before triggering an alert, default is 1.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'pattern' => '', - 'backendName' => 'alertCount', - 'sensitive' => false, - 'default' => '1', - ], + 'alertCount' => ['title' => '', 'description' => 'Applicable condition type: SLS_CONDITION.'."\n" + ."\n" + .'The number of times the condition must be met before an alert is triggered. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'pattern' => '', 'default' => '1', 'example' => '1'], 'caseList' => [ 'title' => '', 'description' => 'Applicable condition type: SLS_CONDITION.'."\n" - .'SLS alert condition list.', - 'visibility' => 'Public', + ."\n" + .'The list of Simple Log Service alert conditions.', 'type' => 'array', 'items' => [ - 'description' => 'SLS alert condition object.', - 'visibility' => 'Public', + 'description' => 'The SLS alert condition object.', 'type' => 'object', 'properties' => [ - 'condition' => [ - 'title' => '', - 'description' => 'Matching expression, example: logLevel: error.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'logLevel: error', - 'backendName' => 'condition', - ], - 'countCondition' => [ - 'title' => '', - 'description' => 'Count matching expression, examples: range combination: count >= 3 && count <= 10; single range: count >= 3.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'count >= 3', - 'backendName' => 'countCondition', - ], - 'level' => [ - 'title' => '', - 'description' => 'Alert severity level after condition is met.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'INFO', - 'backendName' => 'level', - ], + 'condition' => ['title' => '', 'description' => 'The match expression. Example: logLevel: error.', 'type' => 'string', 'example' => 'logLevel: error'], + 'countCondition' => ['title' => '', 'description' => 'The count match expression. Examples:'."\n" + .'Range combination: __count__ >= 3 && __count__ <= 10'."\n" + .'Single range: __count__ >= 3', 'type' => 'string', 'example' => 'count >= 3'], + 'level' => ['title' => '', 'description' => 'The alert level when the condition is met.', 'type' => 'string', 'example' => 'INFO'], 'type' => [ 'title' => '', - 'description' => 'Matching type: Has data / Has a specific number of data entries / Has matching data / Has a specific number of matching entries.'."\n" + 'description' => 'The match type: has data, has a specific number of data entries, has data match, or has a specific number of data matches.'."\n" ."\n" .'Valid values:'."\n" - ."\n" - .'- HasData: Has data.'."\n" - .'- HasDataCount: Has a specific number of data entries.'."\n" - .'- HasDataMatch: Has matching data.'."\n" - .'- HasDataMatchCount: Has a specific number of matching entries.', - 'visibility' => 'Public', + .'- HasData: has data'."\n" + .'- HasDataCount: has a specific number of data entries'."\n" + .'- HasDataMatch: has data match'."\n" + .'- HasDataMatchCount: has a specific number of data matches', 'type' => 'string', + 'enum' => ['HasData', 'HasDataCount', 'HasDataMatch', 'HasDataMatchCount'], 'example' => 'HasData', - 'backendName' => 'type', - 'enum' => [ - 'HasData', - 'HasDataCount', - 'HasDataMatch', - 'HasDataMatchCount', - ], ], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'caseList', - 'sensitive' => false, + 'example' => '', ], 'compareList' => [ 'title' => '', 'description' => 'Applicable condition type: APM_CONDITION.'."\n" - .'APM alert comparison condition list.', - 'visibility' => 'Public', + ."\n" + .'The list of Application Performance Monitoring (APM) alert comparison conditions.', 'type' => 'array', 'items' => [ - 'description' => 'APM alert condition object.', - 'visibility' => 'Public', + 'description' => 'The APM alert condition object.', 'type' => 'object', 'properties' => [ 'aggregate' => [ 'title' => '', - 'description' => 'Time series post-aggregation functions:'."\n" + 'description' => 'The aggregate functions applied after time series aggregation.'."\n" + ."\n" .'- count'."\n" - .'- sum '."\n" - .'- avg'."\n" - .'- min'."\n" - .'- max'."\n" - .'- p90'."\n" - .'- p95'."\n" - .'- p99', - 'visibility' => 'Public', + .'- sum'."\n" + .'- avg'."\n" + .'- min'."\n" + .'- max'."\n" + .'- p90'."\n" + .'- p95'."\n" + .'- p99', + 'enumValueTitles' => ['p99' => 'p99', 'avg' => 'avg', 'min' => 'min', 'max' => 'max', 'p90' => 'p90', 'count' => 'count', 'sum' => 'sum', 'p95' => 'p95'], 'type' => 'string', - 'enumValueTitles' => [ - 'p99' => 'p99', - 'avg' => 'avg', - 'min' => 'min', - 'max' => 'max', - 'p90' => 'p90', - 'count' => 'count', - 'sum' => 'sum', - 'p95' => 'p95', - ], 'example' => 'count', - 'backendName' => 'aggregate', ], 'oper' => [ 'title' => '', - 'description' => 'Comparison operations to determine whether it is year-over-year (YoY) or month-over-month (MoM):'."\n" - .'- Greater than (GT),'."\n" - .'- Greater than or equal to (GTE),'."\n" - .'- Less than (LT),'."\n" - .'- Less than or equal to (LTE),'."\n" - .'- Equal to (EQ),'."\n" - .'- Not equal to (NE),'."\n" - .'- Year-over-year increase (YOY_UP),'."\n" - .'- Year-over-year decrease (YOY_DOWN).', - 'visibility' => 'Public', + 'description' => 'The comparison operator. Determines whether year-over-year or period-over-period comparison is used.'."\n" + ."\n" + .'- Greater than: GT'."\n" + .'- Greater than or equal to: GTE'."\n" + .'- Less than: LT'."\n" + .'- Less than or equal to: LTE'."\n" + .'- Equal to: EQ'."\n" + .'- Not equal to: NE'."\n" + .'- Year-over-year increase: YOY_UP'."\n" + .'- Year-over-year decrease: YOY_DOWN', + 'enumValueTitles' => ['YOY_DOWN' => 'YOY_DOWN', 'YOY_UP' => 'YOY_UP', 'NE' => 'NE', 'LT' => 'LT', 'GTE' => 'GTE', 'LTE' => 'LTE', 'EQ' => 'EQ', 'GT' => 'GT'], 'type' => 'string', - 'enumValueTitles' => [ - 'YOY_DOWN' => 'YOY_DOWN', - 'YOY_UP' => 'YOY_UP', - 'NE' => 'NE', - 'LT' => 'LT', - 'GTE' => 'GTE', - 'LTE' => 'LTE', - 'EQ' => 'EQ', - 'GT' => 'GT', - ], 'example' => 'GT', - 'backendName' => 'oper', - ], - 'value' => [ - 'title' => '', - 'description' => 'Comparison threshold.', - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '50', - 'backendName' => 'value', ], + 'value' => ['title' => '', 'description' => 'The comparison threshold.', 'type' => 'number', 'format' => 'double', 'example' => '50'], 'valueLevelList' => [ 'title' => '', - 'description' => 'List of alert severity levels for different values.', - 'visibility' => 'Public', + 'description' => 'The list of alert levels for different values.', 'type' => 'array', 'items' => [ - 'description' => 'Alert severity levels for different values, used in multi-level severity scenarios.', - 'visibility' => 'Public', + 'description' => 'The alert level for a specific value. Used in multi-level scenarios.', 'type' => 'object', 'properties' => [ - 'level' => [ - 'title' => '', - 'description' => 'Severity level corresponding to the threshold.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'INFO', - 'backendName' => 'level', - ], - 'value' => [ - 'title' => '', - 'description' => 'Comparison threshold.', - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '120', - 'backendName' => 'value', - ], + 'level' => ['title' => '', 'description' => 'The level corresponding to the threshold.', 'type' => 'string', 'example' => 'INFO'], + 'value' => ['title' => '', 'description' => 'The comparison threshold.', 'type' => 'number', 'format' => 'double', 'example' => '120'], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'valueLevelList', - ], - 'yoyTimeUnit' => [ - 'title' => '', - 'description' => 'Year-over-year time unit (only applicable when oper=YOY_UP/YOY_DOWN): minute, hour, day, week, month.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'month', - 'backendName' => 'yoyTimeUnit', - ], - 'yoyTimeValue' => [ - 'title' => '', - 'description' => 'Year-over-year time value, used in conjunction with yoyTimeUnit.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'yoyTimeValue', - ], - 'baseUnit' => [ - 'title' => '数据单位', - 'description' => 'Data unit.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '%', - 'backendName' => 'baseUnit', - ], - 'displayUnit' => [ - 'title' => '展示单位', - 'description' => 'Display unit.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '%', - 'backendName' => 'displayUnit', + 'example' => '', ], + 'yoyTimeUnit' => ['title' => '', 'description' => 'The time unit for year-over-year comparison. Valid only when oper is set to YOY_UP or YOY_DOWN.'."\n" + .'Valid values: minute, hour, day, week, month.', 'type' => 'string', 'example' => 'month'], + 'yoyTimeValue' => ['title' => '', 'description' => 'The value of the year-over-year time period. Used together with yoyTimeUnit.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'baseUnit' => ['title' => '', 'description' => 'The data unit.', 'type' => 'string', 'example' => '%'], + 'displayUnit' => ['title' => '', 'description' => 'The display unit.', 'type' => 'string', 'example' => '%'], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'compareList', - ], - 'noDataAppendValue' => [ - 'title' => '', - 'description' => 'Applicable condition type: APM_CONDITION.'."\n" - .'Fallback value when no data is available.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1', - 'backendName' => 'noDataAppendValue', - ], - 'noDataAlertLevel' => [ - 'title' => '', - 'description' => 'Applicable condition type: APM_CONDITION.'."\n" - .'Alert severity level when no data is available; if not specified, no alert will be triggered for missing data.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'INFO', - 'pattern' => '', - 'backendName' => 'noDataAlertLevel', - 'sensitive' => false, - 'default' => '', + 'example' => '', ], + 'noDataAppendValue' => ['title' => '', 'description' => 'Applicable condition type: APM_CONDITION.'."\n" + ."\n" + .'The compensation value when no data is available.', 'type' => 'string', 'example' => '1'], + 'noDataAlertLevel' => ['title' => '', 'description' => 'Applicable condition type: APM_CONDITION.'."\n" + ."\n" + .'The alert level when no data is available. If this parameter is not specified, no alert is triggered when no data is available.', 'type' => 'string', 'pattern' => '', 'default' => '', 'example' => 'INFO'], 'type' => [ 'title' => '', - 'description' => 'Rule condition type, valid values:'."\n" - ."\n" - .'SLS_CONDITION (SLS alert condition),'."\n" - .'APM_CONDITION (APM alert condition),'."\n" - .'CMS_BASIC_CONDITION (Basic Cloud Monitoring alert condition).', - 'visibility' => 'Public', + 'description' => 'The rule condition type. Valid values:'."\n" + .'- SLS_CONDITION: Simple Log Service alert condition.'."\n" + .'- APM_CONDITION: APM alert condition.'."\n" + .'- CMS_BASIC_CONDITION: CloudMonitor Basic monitoring alert condition.', + 'enumValueTitles' => ['SLS_CONDITION' => 'SLS alert condition.', 'CMS_BASIC_CONDITION' => 'CloudMonitor alerts condition.', 'APM_CONDITION' => 'APM alert condition.'], 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'SLS_CONDITION' => '', - 'CMS_BASIC_CONDITION' => '', - 'APM_CONDITION' => '', - ], - 'example' => 'SLS_CONDITION', 'pattern' => '', - 'backendName' => 'type', - 'sensitive' => false, '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'], + 'example' => 'SLS_CONDITION', ], 'relation' => [ 'title' => '', 'description' => 'Applicable condition type: APM_CONDITION.'."\n" - .'Logical relationship between multiple conditions. Valid values: and, or.', - 'visibility' => 'Public', + ."\n" + .'The logical relationship between multiple conditions. Valid values:'."\n" + .'- and'."\n" + .'- or', + 'enumValueTitles' => ['or' => 'OR.', 'and' => 'AND.'], 'type' => 'string', - 'enumValueTitles' => [ - 'or' => '', - 'and' => '', - ], 'example' => 'and', - 'backendName' => 'relation', - ], - 'escalationType' => [ - 'title' => '', - 'description' => 'Applicable condition type: CMS_BASIC_CONDITION.'."\n" - .'Valid values:'."\n" - .'- simple: Simple metric condition,'."\n" - .'- composite: Composite metric condition,'."\n" - .'- express: Expression condition.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'simple', - 'backendName' => 'escalationType', ], + 'escalationType' => ['title' => '', 'description' => 'Applicable condition type: CMS_BASIC_CONDITION.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- simple: simple metric condition.'."\n" + .'- composite: composite metric condition.'."\n" + .'- express: expression condition.', 'type' => 'string', 'example' => 'simple'], 'simpleEscalation' => [ 'title' => '', 'description' => 'Applicable condition type: CMS_BASIC_CONDITION.'."\n" - .'Only valid when escalationType=simple; specifies the alert condition for a single metric.', - 'visibility' => 'Public', + ."\n" + .'This parameter takes effect only when escalationType is set to simple. The alert condition configured for a single metric.', 'type' => 'object', 'properties' => [ - 'metricName' => [ - 'title' => '', - 'description' => 'Applicable condition type: CMS_BASIC_CONDITION.'."\n" - .'Metric associated with the alert condition.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cpu_total', - 'backendName' => 'metricName', - ], - 'period' => [ - 'title' => '', - 'description' => 'Metric time window, in seconds.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '60', - 'backendName' => 'period', - ], + 'metricName' => ['title' => '', 'description' => 'Applicable condition type: CMS_BASIC_CONDITION.'."\n" + ."\n" + .'The metric associated with the alert condition.', 'type' => 'string', 'example' => 'cpu_total'], + 'period' => ['title' => '', 'description' => 'The time window of the metric. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '60'], 'escalations' => [ 'title' => '', - 'description' => 'List of conditions; for an alert rule with multiple severity levels, each level corresponds to one condition object.', - 'visibility' => 'Public', + 'description' => 'The list of conditions. When an alert rule corresponds to multiple levels, each level has a condition object.', 'type' => 'array', 'items' => [ - 'description' => 'Alert condition object.', - 'visibility' => 'Public', + 'description' => 'The alert condition object.', 'type' => 'object', 'properties' => [ 'level' => [ 'title' => '', - 'description' => 'Alert severity level triggered when the condition is met (expression-based alerts support only one level): '."\n" - .'- CRITICAL '."\n" - .'- WARNING '."\n" + 'description' => 'The alert level triggered when the condition is met. Expression-based alerts support only one level.'."\n" + ."\n" + .'- CRITICAL'."\n" + .'- WARNING'."\n" .'- INFO', - 'visibility' => 'Public', + 'enumValueTitles' => ['INFO' => 'INFO', 'WARNING' => 'WARNING', 'CRITICAL' => 'CRITICAL'], 'type' => 'string', - 'enumValueTitles' => [ - 'INFO' => 'INFO', - 'WARNING' => 'WARNING', - 'CRITICAL' => 'CRITICAL', - ], 'example' => 'INFO', - 'backendName' => 'level', - ], - 'comparisonOperator' => [ - 'title' => '', - 'description' => 'Threshold comparison operator, valid values:'."\n" - ."\n" - .'- GreaterThanOrEqualToThreshold: greater than or equal to.'."\n" - .'- GreaterThanThreshold: greater than.'."\n" - .'- LessThanOrEqualToThreshold: less than or equal to.'."\n" - .'- LessThanThreshold: less than.'."\n" - .'- NotEqualToThreshold: not equal to.'."\n" - .'- EqualToThreshold: equal to.'."\n" - .'- GreaterThanYesterday: increased compared to the same time yesterday.'."\n" - .'- LessThanYesterday: decreased compared to the same time yesterday.'."\n" - .'- GreaterThanLastWeek: increased compared to the same time last week.'."\n" - .'- LessThanLastWeek: decreased compared to the same time last week.'."\n" - .'- GreaterThanLastPeriod: increased compared to the previous period (MoM).'."\n" - .'- LessThanLastPeriod: decreased compared to the previous period (MoM).', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'GreaterThanOrEqualToThreshold', - 'backendName' => 'comparisonOperator', - ], - 'statistics' => [ - 'title' => '', - 'description' => 'Statistical method; the value of this parameter is determined by the Statistics column corresponding to the specified cloud product\'s MetricName, for example: Maximum, Minimum, and Average.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Average', - 'backendName' => 'statistics', - ], - 'times' => [ - 'title' => '', - 'description' => 'Number of times the condition must be met to trigger an alert.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'backendName' => 'times', - ], - 'threshold' => [ - 'title' => '', - 'description' => 'Alert threshold.', - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - 'backendName' => 'threshold', ], + 'comparisonOperator' => ['title' => '', 'description' => 'The threshold comparison operator. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: Greater than or equal to.'."\n" + .'- GreaterThanThreshold: Greater than.'."\n" + .'- LessThanOrEqualToThreshold: Less than or equal to.'."\n" + .'- LessThanThreshold: Less than.'."\n" + .'- NotEqualToThreshold: Not equal to.'."\n" + .'- EqualToThreshold: Equal to.'."\n" + .'- GreaterThanYesterday: Year-over-year increase compared with the same time yesterday.'."\n" + .'- LessThanYesterday: Year-over-year decrease compared with the same time yesterday.'."\n" + .'- GreaterThanLastWeek: Year-over-year increase compared with the same time last week.'."\n" + .'- LessThanLastWeek: Year-over-year decrease compared with the same time last week.'."\n" + .'- GreaterThanLastPeriod: Period-over-period increase compared with the previous period.'."\n" + .'- LessThanLastPeriod: Period-over-period decrease compared with the previous period.', 'type' => 'string', 'example' => 'GreaterThanOrEqualToThreshold'], + 'statistics' => ['title' => '', 'description' => 'The statistical method. The value of this parameter is determined by the Statistics column corresponding to the MetricName of the specified cloud service. Examples: Maximum, Minimum, and Average.', 'type' => 'string', 'example' => 'Average'], + 'times' => ['title' => '', 'description' => 'The number of times the condition must be met to trigger an alert.', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'threshold' => ['title' => '', 'description' => 'The alert threshold.', 'type' => 'number', 'format' => 'double', 'example' => '100'], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'escalations', + 'example' => '', ], ], - 'backendName' => 'simpleEscalation', + 'example' => '', ], 'compositeEscalation' => [ 'title' => '', 'description' => 'Applicable condition type: CMS_BASIC_CONDITION.'."\n" - .'Valid only when escalationType=composite; composite metric alert condition.', - 'visibility' => 'Public', + ."\n" + .'This parameter takes effect only when escalationType is set to composite. The composite metric alert condition.', 'type' => 'object', 'properties' => [ 'relation' => [ 'title' => '', - 'description' => 'Relationship between multiple metric conditions; valid values are "and" or "or".', - 'visibility' => 'Public', + 'description' => 'The relationship between multiple metric conditions. Valid values: and, or.', + 'enumValueTitles' => ['or' => 'or', 'and' => 'and'], 'type' => 'string', - 'enumValueTitles' => [ - 'or' => 'or', - 'and' => 'and', - ], 'example' => 'and', - 'backendName' => 'relation', - ], - 'level' => [ - 'title' => '', - 'description' => 'Alert severity level triggered when the condition is met (multi-metric composite alerts support only one level).', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'INFO', - 'backendName' => 'level', - ], - 'times' => [ - 'title' => '', - 'description' => 'Number of times the condition must be met to trigger an alert.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'backendName' => 'times', ], + 'level' => ['title' => '', 'description' => 'The alert level triggered when the condition is met. Composite metric alerts support only one level.', 'type' => 'string', 'example' => 'INFO'], + 'times' => ['title' => '', 'description' => 'The number of times the condition must be met to trigger an alert.', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], 'escalations' => [ 'title' => '', - 'description' => 'List of multi-metric composite conditions.', - 'visibility' => 'Public', + 'description' => 'The list of composite conditions for multiple metrics.', 'type' => 'array', 'items' => [ - 'description' => 'Condition object.', - 'visibility' => 'Public', + 'description' => 'The condition object.', 'type' => 'object', 'properties' => [ - 'comparisonOperator' => [ - 'title' => '', - 'description' => 'Threshold comparison operator, valid values:'."\n" - .'- GreaterThanOrEqualToThreshold: greater than or equal to.'."\n" - .'- GreaterThanThreshold: greater than.'."\n" - .'- LessThanOrEqualToThreshold: less than or equal to.'."\n" - .'- LessThanThreshold: less than.'."\n" - .'- NotEqualToThreshold: not equal to.'."\n" - .'- EqualToThreshold: equal to.'."\n" - .'- GreaterThanYesterday: increased compared to the same time yesterday.'."\n" - .'- LessThanYesterday: decreased compared to the same time yesterday.'."\n" - .'- GreaterThanLastWeek: increased compared to the same time last week.'."\n" - .'- LessThanLastWeek: decreased compared to the same time last week.'."\n" - .'- GreaterThanLastPeriod: increased compared to the previous period (MoM).'."\n" - .'- LessThanLastPeriod: decreased compared to the previous period (MoM).', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'GreaterThanOrEqualToThreshold', - 'backendName' => 'comparisonOperator', - ], - 'metricName' => [ - 'title' => '', - 'description' => 'Metric name.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cpu_total', - 'backendName' => 'metricName', - ], - 'period' => [ - 'title' => '', - 'description' => 'Metric time window.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '60', - 'backendName' => 'period', - ], - 'statistics' => [ - 'title' => '', - 'description' => 'Statistical method; the value of this parameter is determined by the Statistics column corresponding to the specified cloud product\'s MetricName. This represents the statistical method for the monitoring metric. Example values:'."\n" - .'- $Maximum: maximum value.'."\n" - .'- $Minimum: minimum value.'."\n" - .'- $Average: average value.'."\n" - .'- $Availability: availability (typically used for site monitoring).'."\n" - .'Note: "$" is a unified prefix symbol for monitoring metrics.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '$Maximum', - 'backendName' => 'statistics', - ], - 'threshold' => [ - 'title' => '', - 'description' => 'Alert threshold.', - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '50', - 'backendName' => 'threshold', - ], + 'comparisonOperator' => ['title' => '', 'description' => 'The threshold comparison operator. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: Greater than or equal to.'."\n" + .'- GreaterThanThreshold: Greater than.'."\n" + .'- LessThanOrEqualToThreshold: Less than or equal to.'."\n" + .'- LessThanThreshold: Less than.'."\n" + .'- NotEqualToThreshold: Not equal to.'."\n" + .'- EqualToThreshold: Equal to.'."\n" + .'- GreaterThanYesterday: Year-over-year increase compared with the same time yesterday.'."\n" + .'- LessThanYesterday: Year-over-year decrease compared with the same time yesterday.'."\n" + .'- GreaterThanLastWeek: Year-over-year increase compared with the same time last week.'."\n" + .'- LessThanLastWeek: Year-over-year decrease compared with the same time last week.'."\n" + .'- GreaterThanLastPeriod: Period-over-period increase compared with the previous period.'."\n" + .'- LessThanLastPeriod: Period-over-period decrease compared with the previous period.', 'type' => 'string', 'example' => 'GreaterThanOrEqualToThreshold'], + 'metricName' => ['title' => '', 'description' => 'The metric name.', 'type' => 'string', 'example' => 'cpu_total'], + 'period' => ['title' => '', 'description' => 'The time window of the metric.', 'type' => 'integer', 'format' => 'int64', 'example' => '60'], + 'statistics' => ['title' => '', 'description' => 'The statistical method. The value of this parameter is determined by the Statistics column corresponding to the MetricName of the specified cloud service. Example values for the statistical method of a metric:'."\n" + ."\n" + .'- $Maximum: Maximum value.'."\n" + .'- $Minimum: Minimum value.'."\n" + .'- $Average: Average value.'."\n" + .'- $Availability: Availability rate (typically used for site monitoring).'."\n" + ."\n" + .'Note: $ is the unified prefix symbol for metrics.', 'type' => 'string', 'example' => '$Maximum'], + 'threshold' => ['title' => '', 'description' => 'The alert threshold.', 'type' => 'number', 'format' => 'double', 'example' => '50'], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'escalations', + 'example' => '', ], ], - 'backendName' => 'compositeEscalation', + 'example' => '', ], 'expressEscalation' => [ 'title' => '', 'description' => 'Applicable condition type: CMS_BASIC_CONDITION.'."\n" - .'Valid only when escalationType=composite; multi-metric composite alert condition.', - 'visibility' => 'Public', + ."\n" + .'This parameter takes effect only when escalationType is set to composite. The multi-metric composite alert condition.', 'type' => 'object', 'properties' => [ - 'level' => [ - 'title' => '', - 'description' => 'Alert severity level triggered when the condition is met (expression-based alerts support only one level): '."\n" - ."\n" - .'- CRITICAL '."\n" - .'- WARNING '."\n" - .'- INFO', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'INFO', - 'backendName' => 'level', - ], - 'times' => [ - 'description' => 'Number of times the condition must be met to trigger an alert.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'backendName' => 'times', - ], - 'rawExpression' => [ - 'title' => '', - 'description' => 'Alert condition expression.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '@cpu_total[60].$Average > 60', - 'backendName' => 'rawExpression', - ], + 'level' => ['title' => '', 'description' => 'The alert level triggered when the condition is met. Expression-based alerts support only one level.'."\n" + ."\n" + .'- CRITICAL'."\n" + .'- WARNING'."\n" + .'- INFO', 'type' => 'string', 'example' => 'INFO'], + 'times' => ['description' => 'The number of times the condition must be met to trigger an alert.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3'], + 'rawExpression' => ['title' => '', 'description' => 'The alert condition expression.', 'type' => 'string', 'example' => '@cpu_total[60].$Average > 60'], ], - 'backendName' => 'expressEscalation', + 'example' => '', ], 'noDataPolicy' => [ 'title' => '', 'description' => 'Applicable condition type: CMS_BASIC_CONDITION.'."\n" - .'Handling method when no monitoring data is available. Valid values:'."\n" + ."\n" + .'The method used to handle alerts when no monitoring data is available. Valid values:'."\n" ."\n" .'- KEEP_LAST_STATE (default): No action is taken.'."\n" - .'- INSUFFICIENT_DATA: Alert with "insufficient data" message.'."\n" - .'- OK: Treat as normal.', - 'visibility' => 'Public', + .'- INSUFFICIENT_DATA: The alert content indicates that no data is available.'."\n" + .'- OK: Normal.', + 'enumValueTitles' => ['KEEP_LAST_STATE' => 'No action is taken.', 'INSUFFICIENT_DATA' => 'The alert content indicates no data.', 'OK' => 'Treated as normal.'], 'type' => 'string', - 'enumValueTitles' => [ - 'KEEP_LAST_STATE' => '', - 'INSUFFICIENT_DATA' => '', - 'OK' => '', - ], 'example' => 'KEEP_LAST_STATE', - 'backendName' => 'noDataPolicy', ], - 'oper' => [ - 'description' => 'Comparison operations to determine whether it is year-over-year (YoY) or month-over-month (MoM):'."\n" - ."\n" - .'- Greater than (GT),'."\n" - .'- Greater than or equal to (GTE),'."\n" - .'- Less than (LT),'."\n" - .'- Less than or equal to (LTE),'."\n" - .'- Equal to (EQ),'."\n" - .'- Not equal to (NE),'."\n" - .'- Year-over-year increase (YOY_UP),'."\n" - .'- Year-over-year decrease (YOY_DOWN).', - 'visibility' => 'Public', + 'oper' => ['title' => '', 'description' => 'The comparison operator. Specifies whether to use year-over-year or period-over-period comparison. Valid values:'."\n" + ."\n" + .'- GT: greater than.'."\n" + .'- GTE: greater than or equal to.'."\n" + .'- LT: less than.'."\n" + .'- LTE: less than or equal to.'."\n" + .'- EQ: equal to.'."\n" + .'- NE: not equal to.'."\n" + .'- YOY_UP: year-over-year increase.'."\n" + .'- YOY_DOWN: year-over-year decrease.', 'type' => 'string', 'example' => 'LT'], + 'value' => ['title' => '', 'description' => 'The threshold that triggers the alert.', 'type' => 'number', 'format' => 'double', 'example' => '60'], + 'min' => ['title' => '', 'type' => 'number', 'description' => '', 'example' => '', 'format' => 'double'], + 'max' => ['title' => '', 'type' => 'number', 'description' => '', 'example' => '', 'format' => 'double'], + 'matchField' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'matchOperator' => [ + 'title' => '', 'type' => 'string', - 'example' => 'LT', - 'backendName' => 'oper', + 'description' => '', + 'example' => '', + 'enum' => ['PRESENT', 'NOT_PRESENT', 'CONTAINS', 'EQUALS', 'REGEX'], ], - 'value' => [ - 'description' => 'Alert triggering threshold.', - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '60', - 'backendName' => 'value', + 'matchValue' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'countOperator' => [ + 'title' => '', + 'type' => 'string', + 'description' => '', + 'example' => '', + 'enum' => ['GTE', 'GT', 'EQ', 'LTE', 'LT'], + ], + 'countThreshold' => ['title' => '', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int64'], + 'thresholdList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'severity' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'threshold' => ['title' => '', 'type' => 'number', 'format' => 'double', 'description' => '', 'example' => ''], + 'min' => ['title' => '', 'type' => 'number', 'format' => 'double', 'description' => '', 'example' => ''], + 'max' => ['title' => '', 'type' => 'number', 'format' => 'double', 'description' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'triggers' => [ + 'title' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'severity' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'durationSecs' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'], + 'expression' => [ + 'type' => 'object', + 'properties' => [ + 'expressionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'logicOperator' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'conditions' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'expressionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'queryName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'operator' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'threshold' => ['type' => 'number', 'description' => '', 'title' => '', 'example' => '', 'format' => 'double'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'example' => '', + ], + 'enableSeveritySuppression' => ['title' => '', 'type' => 'boolean', 'description' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], 'AlertRuleDataSource' => [ - 'description' => 'Alert rule data source configuration. The fields included in this configuration object depend on the data source type (the "type" field), and different data source types support different fields.', - 'visibility' => 'Public', + 'description' => 'The data source configuration for the alert rule. The fields in this object depend on the data source type specified in the type field. Different data source types use different fields.', 'type' => 'object', 'properties' => [ 'dsList' => [ - 'title' => '', - 'description' => 'Applicable data source type: SLS_MULTI_DS.'."\n" - .'List of sub-data sources.', - 'visibility' => 'Public', + 'title' => 'type=SLS_MULTI_DS时才需要指定，子数据源列表', + 'description' => 'Applies to the SLS\\_MULTI\\_DS data source type.'."\n" + ."\n" + .'A list of sub-data sources.', 'type' => 'array', 'items' => [ - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'project' => [ - 'title' => 'sls project', - 'description' => 'SLS project', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'mySlsProject', - 'backendName' => 'project', - ], - 'regionId' => [ - 'title' => '', - 'description' => 'The region where the SLS project is located.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn-hangzhou', - 'backendName' => 'regionId', - ], - 'store' => [ - 'title' => '', - 'description' => 'LogStore/MetricStore name.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'mySlsLogStore', - 'backendName' => 'store', - ], + 'project' => ['title' => 'sls project', 'description' => 'The SLS project.', 'type' => 'string', 'example' => 'mySlsProject'], + 'regionId' => ['title' => 'sls project所在的region', 'description' => 'The region where the SLS project is located.', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'store' => ['title' => 'log/metric store名称', 'description' => 'The name of the LogStore or MetricStore.', 'type' => 'string', 'example' => 'mySlsLogStore'], 'type' => [ - 'title' => '', - 'description' => 'Type of SLS data sub-source:'."\n" + 'title' => 'sls数据子源的类型：'."\n" + .'SLS_LOG_DS: log store数据源'."\n" + .'SLS_METRIC_DS： metric store数据源', + 'description' => 'The type of the SLS sub-data source. Valid values:'."\n" ."\n" - .'- SLS_LOG_DS: LogStore data source.'."\n" - .'- SLS_METRIC_DS: MetricStore data source.', - 'visibility' => 'Public', + .'- SLS\\_LOG\\_DS: A LogStore data source.'."\n" + ."\n" + .'- SLS\\_METRIC\\_DS: A MetricStore data source.', 'type' => 'string', - 'example' => 'SLS_LOG_DS', - 'backendName' => 'type', 'default' => 'SLS_LOG_DS', - 'enum' => [ - 'SLS_LOG_DS', - 'SLS_METRIC_DS', - ], + 'enum' => ['SLS_LOG_DS', 'SLS_METRIC_DS'], + 'example' => 'SLS_LOG_DS', ], ], - 'extendType' => 'true', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'backendName' => 'dsList', - 'sensitive' => false, - ], - 'instanceId' => [ - 'title' => '', - 'description' => 'Applicable data source type: PROMETHEUS_DS.'."\n" - .'Prometheus instance ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'rw-bbe8961b4a59be0', - 'pattern' => '', - 'backendName' => 'instanceId', - 'sensitive' => false, - 'default' => '', - ], - 'namespace' => [ - 'title' => '', - 'description' => 'Applicable data source type: ENTERPRISE_DS.'."\n" - .'Name of the enterprise cloud monitoring metric repository.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'aliyun-default', - 'backendName' => 'namespace', + 'example' => '', ], + 'instanceId' => ['title' => 'type=PROMETHUES_DS时需指定prometheus实例id', 'description' => 'Applies to the PROMETHEUS\\_DS data source type.'."\n" + ."\n" + .'The ID of the Prometheus instance.', 'type' => 'string', 'pattern' => '', 'default' => '', 'example' => 'rw-bbe8961b4a59be0'], + 'namespace' => ['title' => 'type=ENTERPRISE_DS时需指定，企业云监控指标仓库的名称', 'description' => 'Applies to the ENTERPRISE\\_DS data source type.'."\n" + ."\n" + .'The name of the Hybrid Cloud Monitoring metric repository.', 'type' => 'string', 'example' => 'aliyun-default'], 'type' => [ - 'title' => '', - 'description' => 'Data source type.'."\n" + 'title' => '数据源类型:'."\n" + .'ENTERPRISE_DS： 企业云监控数据源'."\n" + .'PROMETHEUS_DS：Prometheus数据源(ARMS)'."\n" + .'SLS_MULTI_DS：sls数据源'."\n" + .'APM_DS: APM数据源'."\n" + .'CMS_BASIC_DS: 基础云监控数据源', + 'description' => 'The data source type.'."\n" + ."\n" .'Valid values:'."\n" - .'- PROMETHEUS_DS: Prometheus data source.'."\n" - .'- SLS_MULTI_DS: SLS data source.'."\n" - .'- APM_DS: Application monitoring data source.'."\n" - .'- CMS_BASIC_DS: Basic cloud monitoring data source.'."\n" - .'- ENTERPRISE_DS: Enterprise cloud monitoring data source.', - 'visibility' => 'Public', + ."\n" + .'- PROMETHEUS\\_DS: A Prometheus data source.'."\n" + ."\n" + .'- SLS\\_MULTI\\_DS: An SLS data source.'."\n" + ."\n" + .'- APM\\_DS: An Application Monitoring data source.'."\n" + ."\n" + .'- CMS\\_BASIC\\_DS: A basic Cloud Monitor data source.'."\n" + ."\n" + .'- ENTERPRISE\\_DS: A Hybrid Cloud Monitoring data source.', + 'enumValueTitles' => ['CMS_BASIC_DS' => '基础云监控数据源', 'APM_DS' => '应用监控数据源', 'ENTERPRISE_DS' => '企业云监控数据源', 'SLS_MULTI_DS' => 'SLS数据源', 'PROMETHEUS_DS' => 'Prometheus数据源'], 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'CMS_BASIC_DS' => '', - 'APM_DS' => '', - 'ENTERPRISE_DS' => '', - 'SLS_MULTI_DS' => '', - 'PROMETHEUS_DS' => '', - ], - 'example' => 'PROMETHEUS_DS', 'pattern' => '', - 'backendName' => 'type', - 'sensitive' => false, 'default' => '', - 'enum' => [ - 'ENTERPRISE_DS', - 'PROMETHEUS_DS', - 'SLS_MULTI_DS', - 'APM_DS', - 'CMS_BASIC_DS', - 'ENTITY_DS', - ], - ], - 'regionId' => [ - 'title' => '', - 'description' => 'Applicable data source types: APM_DS, PROMETHEUS_DS.'."\n" - .'The regionId to which the data source belongs.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn-hangzhou', - 'backendName' => 'regionId', + 'enum' => ['ENTERPRISE_DS', 'PROMETHEUS_DS', 'SLS_MULTI_DS', 'APM_DS', 'CMS_BASIC_DS', 'ENTITY_DS'], + 'example' => 'PROMETHEUS_DS', ], + 'regionId' => ['title' => '数据源所属的regionId。'."\n" + .'对APM_DS，指应用所属的地域'."\n" + .'对于PROMETHEUS_DS，指prometheus实例所属地域。'."\n" + .'如果未指定，则通过规则的regionId访问数据源。', 'description' => 'Applies to the APM\\_DS and PROMETHEUS\\_DS data source types.'."\n" + ."\n" + .'The ID of the region where the data source is located.', 'type' => 'string', 'example' => 'cn-hangzhou'], 'appType' => [ - 'title' => '', - 'description' => 'Applicable data source type: APM_DS.'."\n" - .'Application type: '."\n" + 'title' => '仅对APM_DS有效，应用的类型：'."\n" + .'* apm'."\n" + .'* rum'."\n" + .'* ebpf'."\n" + .'* xtrace', + 'description' => 'Applies to the APM\\_DS data source type.'."\n" ."\n" - .'- apm.', - 'visibility' => 'Public', + .'The type of the application. Valid value:'."\n" + ."\n" + .'- apm', + 'enumValueTitles' => ['apm' => 'APM应用'], 'type' => 'string', - 'enumValueTitles' => [ - 'apm' => '', - ], 'example' => 'apm', - 'backendName' => 'appType', ], + 'tenantId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], 'AlertRuleLabelFilter' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The label filter configuration.', 'type' => 'object', 'properties' => [ 'opt' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The relationship operator between multiple labels.', 'type' => 'string', 'required' => false, + 'default' => 'AND', + 'enum' => ['AND', 'OR'], + 'title' => '', 'example' => 'AND', + 'visibility' => 'Public', 'backendName' => 'opt', - 'default' => 'AND', - 'enum' => [ - 'AND', - 'OR', - ], ], 'labels' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The label filter.', 'type' => 'object', - 'additionalProperties' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn-shanghai', - ], + 'additionalProperties' => ['description' => 'The value of the label.', 'type' => 'string', 'title' => '', 'example' => 'cn-shanghai', 'visibility' => 'Public'], + 'title' => '', + 'example' => '', + 'visibility' => 'Public', 'backendName' => 'labels', ], ], + 'title' => '', + 'example' => '', + 'visibility' => 'Public', ], 'AlertRuleNotification' => [ - 'description' => 'Alert Notification Configuration Object.', - 'visibility' => 'Public', + 'description' => 'The alert notification configuration object.', 'type' => 'object', 'properties' => [ - 'slackWebhooks' => [ - 'description' => 'List of Slack webhook notification object IDs.', - 'visibility' => 'Public', + 'contacts' => [ + 'description' => 'A list of contact IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'Slack webhook notification object ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'mySlackWebhookId', - 'extendType' => 'true', - ], - 'backendName' => 'slackWebhooks', + 'items' => ['description' => 'A contact ID.', 'type' => 'string', 'title' => '', 'example' => 'myContactId'], + 'title' => '', + 'example' => '', ], - 'wxWebhooks' => [ - 'description' => 'List of WeChat webhook notification object IDs.', - 'visibility' => 'Public', + 'customWebhooks' => [ + 'description' => 'A list of custom webhook notification object IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'WeChat webhook notification object ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myWxWebhookId', - 'extendType' => 'true', - ], - 'backendName' => 'wxWebhooks', - ], - 'notifyTime' => [ + 'items' => ['description' => 'A custom webhook notification object ID.', 'type' => 'string', 'title' => '', 'example' => 'myCustomWebhookId'], 'title' => '', - 'description' => 'Notification time window; notifications are sent only during this period.', - 'visibility' => 'Public', - 'backendName' => 'notifyTime', - '$ref' => '#/components/schemas/AlertRuleTimeSpan', + 'example' => '', ], 'dingWebhooks' => [ - 'description' => 'List of DingTalk webhook notification object IDs.', - 'visibility' => 'Public', + 'description' => 'A list of DingTalk webhook notification object IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'DingTalk webhook notification object ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myDingWebhookId', - 'extendType' => 'true', - ], - 'backendName' => 'dingWebhooks', + 'items' => ['description' => 'A DingTalk webhook notification object ID.', 'type' => 'string', 'title' => '', 'example' => 'myDingWebhookId'], + 'title' => '', + 'example' => '', ], - 'customWebhooks' => [ - 'description' => 'List of custom webhook notification object IDs.', - 'visibility' => 'Public', + 'fsWebhooks' => [ + 'description' => 'A list of Lark webhook notification object IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'Custom webhook notification object ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myCustomWebhookId', - 'extendType' => 'true', - ], - 'backendName' => 'customWebhooks', + 'items' => ['description' => 'A Lark webhook notification object ID.', 'type' => 'string', 'title' => '', 'example' => 'myFsWebhookId'], + 'title' => '', + 'example' => '', ], 'groups' => [ - 'description' => 'List of contact group IDs.', - 'visibility' => 'Public', + 'description' => 'A list of contact group IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'Contact group ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myContactGroupId', - 'extendType' => 'true', - ], - 'backendName' => 'groups', - ], - 'silenceTime' => [ - 'description' => 'Notification silence duration, in seconds.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '86400', - 'backendName' => 'silenceTime', + 'items' => ['description' => 'A contact group ID.', 'type' => 'string', 'title' => '', 'example' => 'myContactGroupId'], + 'title' => '', + 'example' => '', ], - 'fsWebhooks' => [ - 'description' => 'List of Feishu webhook notification object IDs.', - 'visibility' => 'Public', + 'silenceTime' => ['description' => 'The notification silence period. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '86400'], + 'slackWebhooks' => [ + 'description' => 'A list of Slack webhook notification object IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'Feishu webhook notification object ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myFsWebhookId', - 'extendType' => 'true', - ], - 'backendName' => 'fsWebhooks', + 'items' => ['description' => 'A Slack webhook notification object ID.', 'type' => 'string', 'title' => '', 'example' => 'mySlackWebhookId'], + 'title' => '', + 'example' => '', ], - 'version' => [ + 'wxWebhooks' => [ + 'description' => 'A list of WeChat webhook notification object IDs.', + 'type' => 'array', + 'items' => ['description' => 'A WeChat webhook notification object ID.', 'type' => 'string', 'title' => '', 'example' => 'myWxWebhookId'], 'title' => '', - 'description' => 'Version of the notification object; the default (empty) value corresponds to the 2.0 notification object. When version=cmsV1, notifications are sent via Cloud Monitor 1.0 notification objects. This is a non-public attribute.', - 'visibility' => 'Private', - 'type' => 'string', - 'example' => 'cmsV1', - 'backendName' => 'version', + 'example' => '', ], - 'contacts' => [ - 'description' => 'List of contact IDs.', - 'visibility' => 'Public', + 'notifyTime' => ['title' => '', 'description' => 'The notification period. Notifications are sent only within this period.', '$ref' => '#/components/schemas/AlertRuleTimeSpan', 'example' => ''], + 'dingCoolAppWebhooks' => [ 'type' => 'array', - 'items' => [ - 'description' => 'Contact ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myContactId', - 'extendType' => 'true', + 'items' => ['description' => 'A single DingTalk Cool App webhook ID.', 'type' => 'string', 'title' => '', 'example' => 'myDingCoolAppWebhookId'], + 'description' => 'A list of DingTalk Cool App webhook notification object IDs.', + 'title' => '', + 'example' => '', + ], + 'qwencloudContacts' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'additionalProperties' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'backendName' => 'contacts', + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], 'AlertRuleNotificationFilter' => [ - 'description' => '', + 'description' => 'Filter configuration for notification recipients.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'slackWebhooks' => [ - 'description' => '', + 'description' => 'A list of Slack webhook IDs for filtering.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'webhook ID', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myWebhookId', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The webhook ID.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'myWebhookId'], 'backendName' => 'slackWebhooks', + 'title' => '', + 'example' => '', ], 'wxWebhooks' => [ - 'description' => '', + 'description' => 'A list of WeChat webhook IDs for filtering.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'webhook ID', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myWebhookId', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The webhook ID.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'myWebhookId'], 'backendName' => 'wxWebhooks', + 'title' => '', + 'example' => '', ], 'dingWebhooks' => [ - 'description' => '', + 'description' => 'A list of DingTalk webhook IDs for filtering.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'webhook ID', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myWebhookId', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The webhook ID.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'myWebhookId'], 'backendName' => 'dingWebhooks', + 'title' => '', + 'example' => '', ], 'customWebhooks' => [ - 'description' => '', + 'description' => 'A list of custom webhook IDs for filtering.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'webhook ID', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myWebhookId', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The webhook ID.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'myWebhookId'], 'backendName' => 'customWebhooks', + 'title' => '', + 'example' => '', ], 'groups' => [ - 'description' => '', + 'description' => 'A list of contact group IDs for filtering.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myContactGroup', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The contact group ID.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'myContactGroup'], 'backendName' => 'groups', + 'title' => '', + 'example' => '', ], 'fsWebhooks' => [ - 'description' => '', + 'description' => 'A list of Lark webhook IDs for filtering.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'webhook ID', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myWebhookId', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The webhook ID.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'myWebhookId'], 'backendName' => 'fsWebhooks', + 'title' => '', + 'example' => '', ], 'contacts' => [ - 'description' => '', + 'description' => 'A list of contact IDs for filtering.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myContactId', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The contact ID.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'myContactId'], 'backendName' => 'contacts', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], 'AlertRuleQuery' => [ - 'description' => 'Query configuration for alert rules. The fields included in this configuration object depend on the query type (the "type" field), and different data query types support different fields.', - 'visibility' => 'Public', + 'description' => 'The query configuration of the alert rule. The fields included in this configuration object depend on the query type (the type field). Different data query types use different fields.', 'type' => 'object', 'properties' => [ - 'duration' => [ - 'title' => '', - 'description' => 'Applicable query type: PROMQL_QUERY.'."\n" - .'Duration of alert data, in seconds.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '60', - 'backendName' => 'duration', - ], - 'expr' => [ - 'title' => '', - 'description' => 'Applicable query type: PROMQL_QUERY.'."\n" - .'Query expression (PromQL).', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'sum(sum(max_over_time(kube_pod_status_phase{phase=~\\"Pending\\",job=\\"_kube-state-metrics\\"}[5m])) by (pod)) > 1000', - 'backendName' => 'expr', - ], + 'duration' => ['title' => '', 'description' => 'Applicable query type: PROMQL_QUERY.'."\n" + ."\n" + .'The duration for which alert data persists. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '60'], + 'expr' => ['title' => '', 'description' => 'Applicable query type: PROMQL_QUERY.'."\n" + ."\n" + .'The query expression (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' => 'Applicable query type: SLS_MULTI_QUERY.'."\n" - .'List of grouping field names.', - 'visibility' => 'Public', + ."\n" + .'The list of group field names.', 'type' => 'array', - 'items' => [ - 'description' => 'Grouping field name.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'host_name', - 'extendType' => 'true', - ], - 'backendName' => 'groupFieldList', + 'items' => ['description' => 'The grouping field name.', 'type' => 'string', 'title' => '', 'example' => 'host_name'], + 'example' => '', ], 'groupType' => [ 'title' => '', 'description' => 'Applicable query type: SLS_MULTI_QUERY.'."\n" - .'Grouping type, with the following possible values:'."\n" ."\n" - .'- none: No grouping.'."\n" - .'- label: Automatic label grouping.'."\n" - .'- custom: Custom label grouping.', - 'visibility' => 'Public', + .'The group type. Valid values:'."\n" + .'- none: no grouping.'."\n" + .'- label: automatic label-based grouping.'."\n" + .'- custom: custom label-based grouping.', 'type' => 'string', + 'enum' => ['none', 'label', 'custom'], 'example' => 'label', - 'backendName' => 'groupType', - 'enum' => [ - 'none', - 'label', - 'custom', - ], ], 'queries' => [ 'title' => '', - 'description' => 'Applicable query types: SLS_MULTI_QUERY, APM_MULTI_QUERY.'."\n" - .'List of subqueries.'."\n" + 'description' => 'Applicable query types: SLS_MULTI_QUERY and APM_MULTI_QUERY.'."\n" ."\n" - .'For the SLS_MULTI_QUERY type, the list can contain up to three subqueries, and the number and order of subqueries must match the sub-datasource configurations in datasource.dsList.', - 'visibility' => 'Public', + .'The list of subqueries.'."\n" + ."\n" + .'For the SLS_MULTI_QUERY query type, a maximum of three subqueries are supported. The number and order of subqueries must match the sub-datasource config in datasource.dsList.', 'type' => 'array', 'items' => [ 'title' => '', - 'description' => 'Subquery.', - 'visibility' => 'Public', + 'description' => 'The subquery.', 'type' => 'object', 'properties' => [ - 'duration' => [ - 'title' => '', - 'description' => 'Applicable query type: ARMS_MULTI_QUERY.'."\n" - .'Alert (data) duration.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '120', - 'backendName' => 'duration', - ], - 'end' => [ - 'title' => '', - 'description' => 'Applicable query type: SLS_MULTI_QUERY.'."\n" - .'Time offset end time (relative).'."\n" - .'If start and end are specified, do not specify window.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - 'pattern' => '', - 'backendName' => 'end', - 'sensitive' => false, - 'default' => '', - ], - 'expr' => [ - 'title' => '', - 'description' => 'Applicable query types: APM_MULTI_QUERY, SLS_MULTI_QUERY.'."\n" - .'Query expression.'."\n" - ."\n" - .'- For APM_MULTI_QUERY, this field is optional and contains the PromQL generated for predefined metrics (used for data preview).'."\n" - .'- For SLS_MULTI_QUERY, this field contains the SQL query statement.', - 'visibility' => 'Public', - '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' => '', - 'backendName' => 'expr', - 'sensitive' => false, - 'default' => '', - ], - 'start' => [ - 'title' => '', - 'description' => 'Applicable query type: SLS_MULTI_QUERY.'."\n" - .'SLS query time offset start time (relative).'."\n" - .'If start and end are specified, do not specify window. For example: start=15, timeUnit=minute, which means 15 minutes ago.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - 'pattern' => '', - 'backendName' => 'start', - 'sensitive' => false, - 'default' => '', - ], + 'duration' => ['title' => '', 'description' => 'Applicable query type: ARMS_MULTI_QUERY.'."\n" + ."\n" + .'The alert data duration.', 'type' => 'integer', 'format' => 'int64', 'example' => '120'], + 'end' => ['title' => '', 'description' => 'Applicable query type: SLS_MULTI_QUERY.'."\n" + ."\n" + .'The relative time offset end time.'."\n" + ."\n" + .'If start and end are specified, do not specify window.', 'type' => 'integer', 'format' => 'int64', 'pattern' => '', 'default' => '', 'example' => '0'], + 'expr' => ['title' => '', 'description' => 'Applicable query types: APM_MULTI_QUERY, SLS_MULTI_QUERY.'."\n" + ."\n" + .'The query expression.'."\n" + ."\n" + .'- For APM_MULTI_QUERY, this field is optional and contains the PromQL generated for predefined metrics (used for data preview).'."\n" + .'- For SLS_MULTI_QUERY, this field contains the SQL query statement.', 'type' => 'string', 'pattern' => '', 'default' => '', '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]))'], + 'start' => ['title' => '', 'description' => 'Applicable query type: SLS_MULTI_QUERY.'."\n" + ."\n" + .'The relative time offset start time for the SLS query.'."\n" + ."\n" + .'If start and end are specified, do not specify window. Example: start=15, timeUnit=minute indicates 15 minutes ago.', 'type' => 'integer', 'format' => 'int64', 'pattern' => '', 'default' => '', 'example' => '15'], 'timeUnit' => [ 'title' => '', 'description' => 'Applicable query type: SLS_MULTI_QUERY.'."\n" - .'Time units for the start, end, and window parameters: day/hour/minute/second.', - 'visibility' => 'Public', + ."\n" + .'The time unit for the start, end, and window parameters: day/hour/minute/second.', 'type' => 'string', - 'example' => 'hour', 'pattern' => '', - 'backendName' => 'timeUnit', - 'sensitive' => false, 'default' => 'minute', - 'enum' => [ - 'second', - 'minute', - 'hour', - 'day', - ], - ], - 'window' => [ - 'title' => '', - 'description' => 'Applicable query type: SLS_MULTI_QUERY.'."\n" - .'Exact-hour time query interval. If window is specified, start and end should not be specified.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'pattern' => '', - 'backendName' => 'window', - 'sensitive' => false, - 'default' => '', - ], - 'apmAlertMetricId' => [ - 'title' => '', - 'description' => 'Applicable query type: APM_MULTI_QUERY.'."\n" - .'ID of the APM predefined metric.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'appstat.jvm.ThreadNewCount', - 'backendName' => 'measureCode', + 'enum' => ['second', 'minute', 'hour', 'day'], + 'example' => 'hour', ], + 'window' => ['title' => '', 'description' => 'Applicable query type: SLS_MULTI_QUERY.'."\n" + ."\n" + .'The time frame query interval. If window is specified, do not specify start or end.', 'type' => 'integer', 'format' => 'int64', 'pattern' => '', 'default' => '', 'example' => '1'], + 'apmAlertMetricId' => ['title' => '', 'description' => 'Applicable query type: APM_MULTI_QUERY.'."\n" + ."\n" + .'The ID of the APM predefined metric.', 'type' => 'string', 'example' => 'appstat.jvm.ThreadNewCount'], 'apmFilters' => [ 'title' => '', 'description' => 'Applicable query type: ARMS_MULTI_QUERY.'."\n" - .'Dimension filter configuration for APM metrics. Must be used in conjunction with apmAlertMetricId.', - 'visibility' => 'Public', + ."\n" + .'The dimension filter configuration for the APM metric. Must be used together with apmAlertMetricId.', 'type' => 'array', 'items' => [ - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'dim' => [ - 'title' => '', - 'description' => 'Dimension in APM metrics.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'rpcType', - 'backendName' => 'key', - ], - 'type' => [ - 'title' => '', - 'description' => 'Filter operation types:'."\n" - ."\n" - .'- eq: equals.'."\n" - .'- neq: not equals.'."\n" - .'- match: regular expression match.'."\n" - .'- nmatch: regular expression not match.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'eq', - 'backendName' => 'type', - ], - 'value' => [ - 'title' => '', - 'description' => 'The corresponding value for the filter operation.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'h3ji7a0y9i@2ac80e27fdfd0a2', - 'backendName' => 'value', - ], + 'dim' => ['title' => '', 'description' => 'The dimension in the APM metric.', 'type' => 'string', 'example' => 'rpcType'], + 'type' => ['title' => '', 'description' => 'The filter operation type. Valid values:'."\n" + .'- eq: equal to'."\n" + .'- neq: not equal to'."\n" + .'- match: regex match'."\n" + .'- nmatch: regex not match', 'type' => 'string', 'example' => 'eq'], + 'value' => ['title' => '', 'description' => 'The value corresponding to the filter operation.', 'type' => 'string', 'example' => 'h3ji7a0y9i@2ac80e27fdfd0a2'], ], - 'extendType' => 'true', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'backendName' => 'filters', + 'example' => '', ], 'apmGroupBy' => [ 'title' => '', 'description' => 'Applicable query type: ARMS_MULTI_QUERY.'."\n" - .'List of aggregation dimensions for the query, i.e., the dimensions by which the metric is aggregated.', - 'visibility' => 'Public', + ."\n" + .'The list of aggregation dimensions for the query, specifying which metric dimensions to aggregate by.', + 'type' => 'array', + 'items' => ['description' => 'The aggregation dimension of the metric.', 'type' => 'string', 'title' => '', 'example' => 'rpcType'], + 'example' => '', + ], + 'name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'promQl' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'metricSet' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'metric' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'labelFilters' => [ + 'title' => '', 'type' => 'array', 'items' => [ - 'description' => 'Aggregation dimensions of the metric.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'rpcType', - 'extendType' => 'true', + 'type' => 'object', + 'properties' => [ + 'name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'value' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'operator' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'backendName' => 'groupBy', + 'description' => '', + 'example' => '', ], ], - 'sensitive' => false, - 'extendType' => 'true', + 'example' => '', ], - 'backendName' => 'queries', - ], - 'firstJoin' => [ - 'description' => 'Applicable query type: SLS_MULTI_QUERY.'."\n" - .'Configuration for the set join operation between the results of subquery 1 (queries[0]) and subquery 2 (queries[1]).', - 'visibility' => 'Public', - 'backendName' => 'firstJoin', - '$ref' => '#/components/schemas/AlertRuleSlsQueryJoin', + 'example' => '', ], + 'firstJoin' => ['description' => 'Applicable query type: SLS_MULTI_QUERY.'."\n" + ."\n" + .'The set join operation configuration for the results of subquery 1 (queries[0]) and subquery 2 (queries[1]).', '$ref' => '#/components/schemas/AlertRuleSlsQueryJoin', 'title' => '', 'example' => ''], 'type' => [ 'title' => '', - 'description' => 'Query type.'."\n" + 'description' => 'The query type. '."\n" ."\n" .'Valid values:'."\n" + .'- PROMQL_QUERY: PromQL query.'."\n" + .'- SLS_MULTI_QUERY: SLS query.'."\n" + .'- APM_MULTI_QUERY: APM query.'."\n" + .'- CMS_BASIC_QUERY: basic cloud service monitoring query.'."\n" ."\n" - .'- PROMQL_QUERY: PromQL query'."\n" - .'- SLS_MULTI_QUERY: SLS query'."\n" - .'- APM_MULTI_QUERY: APM query'."\n" - .'- CMS_BASIC_QUERY: Basic CloudMonitor query'."\n" - ."\n" - .'The valid fields within the query object vary depending on the query type. Refer to the "Applicable query type" description in each field\'s documentation for details.'."\n" - ."\n" - .'The query type must match the data source type, with the following correspondences:'."\n" + .'Different query types use different valid fields in the query object. For more information, see the "Applicable query type" description of each field.'."\n" ."\n" + .'The query type must match the data source type. The mappings are as follows:'."\n" .'- Prometheus data source (PROMETHEUS_DS): PROMQL_QUERY'."\n" .'- APM data source (APM_DS): APM_MULTI_QUERY'."\n" .'- SLS data source (SLS_MULTI_DS): SLS_MULTI_QUERY'."\n" - .'- Basic CloudMonitor data source (CMS_BASIC_DS): CMS_BASIC_QUERY.', - 'visibility' => 'Public', + .'- Basic cloud service monitoring data source (CMS_BASIC_DS): CMS_BASIC_QUERY', + 'enumValueTitles' => ['PROMQL_QUERY' => 'PROMQL_QUERY', 'CMS_BASIC_QUERY' => 'CMS_BASIC_QUERY', 'APM_MULTI_QUERY' => 'APM_MULTI_QUERY', 'SLS_MULTI_QUERY' => 'SLS_MULTI_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', - ], - 'example' => 'PROMQL_QUERY', 'pattern' => '', - 'backendName' => 'type', - 'sensitive' => false, 'default' => 'PROMQL_QUERY', - 'enum' => [ - 'PROMQL_QUERY', - 'SLS_MULTI_QUERY', - 'APM_MULTI_QUERY', - 'CMS_BASIC_QUERY', - 'METRIC_SET_QUERY', - ], - ], - 'secondJoin' => [ - 'description' => 'Applicable query type: SLS_MULTI_QUERY.'."\n" - .'Configuration for the set join operation between the results of subquery 2 (queries[2]) and subquery 3 (queries[3]).', - 'visibility' => 'Public', - 'backendName' => 'secondJoin', - '$ref' => '#/components/schemas/AlertRuleSlsQueryJoin', - ], - 'checkAfterDataComplete' => [ - 'title' => '', - 'description' => 'Applicable query type: PROMQL_QUERY.'."\n" - .'Whether to perform alert evaluation only after data completeness is ensured.', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'checkAfterDataComplete', + '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'], + 'example' => 'PROMQL_QUERY', ], + 'secondJoin' => ['description' => 'Applicable query type: SLS_MULTI_QUERY.'."\n" + ."\n" + .'The set join operation configuration for the results of subquery 2 (queries[2]) and subquery 3 (queries[3]).', '$ref' => '#/components/schemas/AlertRuleSlsQueryJoin', 'title' => '', 'example' => ''], + 'checkAfterDataComplete' => ['title' => '', 'description' => 'Applicable query type: PROMQL_QUERY.'."\n" + ."\n" + .'Specifies whether to perform alert detection only after data is complete.', 'type' => 'boolean', 'example' => 'true'], 'relationType' => [ 'title' => '', 'description' => 'Applicable query type: CMS_BASIC_QUERY.'."\n" - .'Resource scope for the rule query, with the following allowed values:'."\n" - .'- USER: All resources under the user\'s UID.'."\n" - .'- GROUP: Application group.'."\n" - .'- INSTANCE: Specified list of instances.', - 'visibility' => 'Public', + ."\n" + .'The resource scope of the rule query. Valid values:'."\n" + .'- USER: all resources under the user UID.'."\n" + .'- GROUP: application group.'."\n" + .'- INSTANCE: specified instance list.', + 'enumValueTitles' => ['GROUP' => 'GROUP', 'INSTANCE' => 'INSTANCE', 'USER' => 'USER'], 'type' => 'string', - 'enumValueTitles' => [ - 'GROUP' => 'GROUP', - 'INSTANCE' => 'INSTANCE', - 'USER' => 'USER', - ], 'example' => 'USER', - 'backendName' => 'relationType', ], - 'groupId' => [ + 'groupId' => ['title' => '', 'description' => 'Applicable query type: CMS_BASIC_QUERY.'."\n" + ."\n" + .'The ID of the associated application group. This parameter takes effect only when relationType is set to GROUP.', 'type' => 'string', 'example' => '23423'], + 'namespace' => ['title' => '', 'description' => 'Applicable query type: CMS_BASIC_QUERY.'."\n" + ."\n" + .'The namespace of the metric.', 'type' => 'string', 'example' => 'acs_ecs_dashboard'], + 'entityFilter' => [ + 'description' => 'The resource filter used to filter target resources.', + 'type' => 'object', + 'properties' => [ + 'domain' => ['description' => 'The resource type domain.', 'type' => 'string', 'title' => '', 'example' => 'rum'], + 'type' => ['description' => 'The resource type.', 'type' => 'string', 'title' => '', 'example' => 'apm'], + 'filters' => [ + 'description' => 'The list of filter conditions used to further filter resources.', + 'type' => 'array', + 'items' => [ + 'description' => 'The filter condition object.', + 'type' => 'object', + 'properties' => [ + 'field' => ['description' => 'The field.', 'type' => 'string', 'title' => '', 'example' => 'instanceId'], + 'operator' => ['description' => 'The comparison operator.', 'type' => 'string', 'title' => '', 'example' => '='], + 'value' => ['description' => 'The matched value.', 'type' => 'string', 'title' => '', 'example' => 'wait_throw'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'title' => '', - 'description' => 'Applicable query type: CMS_BASIC_QUERY.'."\n" - .'Associated application group ID, valid only when relationType = GROUP.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '23423', - 'backendName' => 'groupId', + 'example' => '', ], - 'namespace' => [ + 'domain' => ['description' => 'The domain to which the resource belongs.', 'type' => 'string', 'title' => '', 'example' => 'rum'], + 'metricSet' => ['description' => 'The collection of monitoring metrics.', 'type' => 'string', 'title' => '', 'example' => 'cpu_usage'], + 'metric' => ['description' => 'The metric name.', 'type' => 'string', 'title' => '', 'example' => 'memory'], + 'logSet' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'windowSecs' => ['title' => '', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int64'], + 'offsetSecs' => ['title' => '', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int64'], + 'aggregate' => [ 'title' => '', - 'description' => 'Applicable query type: CMS_BASIC_QUERY.'."\n" - .'Namespace of the metric.', - 'visibility' => 'Public', 'type' => 'string', - 'example' => 'acs_ecs_dashboard', - 'backendName' => 'namespace', + 'description' => '', + 'example' => '', + 'enum' => ['AVG', 'MAX', 'MIN', 'SUM', 'LAST'], ], 'dimensions' => [ 'title' => '', - 'description' => 'Applicable query type: CMS_BASIC_QUERY.'."\n" - .'List of filtering dimensions for the resource.', - 'visibility' => 'Public', + 'description' => 'Applicable query type: CMS_BASIC_QUERY. '."\n" + ."\n" + .'The list of filter dimensions for the resource.', 'type' => 'array', 'items' => [ - 'description' => 'Basic cloud monitoring resource filtering dimensions.', - 'visibility' => 'Public', + 'description' => 'The resource filter dimension for CloudMonitor Basic.', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'Dimension value.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'i-f8zbbutcvfpx7gn457pi', - ], - 'extendType' => 'true', + 'additionalProperties' => ['description' => 'The dimension value.', 'type' => 'string', 'title' => '', 'example' => 'i-f8zbbutcvfpx7gn457pi'], + 'title' => '', + 'example' => '', ], - 'backendName' => 'dimensions', + 'example' => '', ], 'serviceIds' => [ - 'description' => 'Service ID list.', - 'visibility' => 'Public', + 'description' => 'The list of service IDs.', + 'type' => 'array', + 'items' => ['description' => 'The service ID.', 'type' => 'string', 'title' => '', 'example' => 'i-bp1234567890abcdef'], + 'title' => '', + 'example' => '', + ], + 'labelFilters' => [ + 'description' => 'The array of label filters.', 'type' => 'array', 'items' => [ - 'description' => 'Service ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'i-bp1234567890abcdef'."\n", - 'extendType' => 'true', + 'description' => 'The label filter object.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The label name.', 'type' => 'string', 'title' => '', 'example' => 'app'], + 'value' => ['description' => 'The label value.', 'type' => 'string', 'title' => '', 'example' => 'web'], + 'operator' => ['description' => 'The comparison operator that determines how to match the label value.', 'type' => 'string', 'title' => '', 'example' => '='], + ], + 'title' => '', + 'example' => '', ], - 'backendName' => 'serviceIds', + 'title' => '', + 'example' => '', ], - 'entityFilter' => [ - 'description' => '资源过滤器，用于筛选目标资源。', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'domain' => [ - 'description' => '资源类型域。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'rum', - 'backendName' => 'domain', - ], - 'type' => [ - 'description' => '资源类型。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'apm', - 'backendName' => 'type', - ], - 'filters' => [ - 'description' => '过滤条件列表，用于进一步筛选资源。', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => '过滤条件对象。', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'field' => [ - 'description' => '字段', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'instanceId', - 'backendName' => 'field', - ], - 'operator' => [ - 'description' => '比较运算符。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '=', - 'backendName' => 'operator', - ], - 'value' => [ - 'description' => '匹配的值。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'wait_throw', - 'backendName' => 'value', - ], - ], - 'extendType' => 'true', - ], - 'backendName' => 'filters', + 'entityFields' => [ + 'description' => 'The array of entity field filters.', + 'type' => 'array', + 'items' => [ + 'description' => 'The entity field filter object.', + 'type' => 'object', + 'properties' => [ + 'field' => ['description' => 'The entity field name.', 'type' => 'string', 'title' => '', 'example' => 'instanceId'], + 'value' => ['description' => 'The field value.', 'type' => 'string', 'title' => '', 'example' => 'i-abc123'], ], + 'title' => '', + 'example' => '', ], - 'backendName' => 'entityFilter', - ], - 'domain' => [ - 'description' => '资源所属的领域。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'rum', - 'backendName' => 'domain', - ], - 'metricSet' => [ - 'description' => '监控指标集合。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cpu_usage', - 'backendName' => 'metricSet', + 'title' => '', + 'example' => '', ], - 'metric' => [ - 'description' => '指标名。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'memory', - 'backendName' => 'metric', + 'markTags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'key' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'value' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', + ], + 'AlertRuleRcaConfig' => [ + 'type' => 'object', + 'properties' => [ + 'enableRca' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'digitalEmployeeName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'AlertRuleSend' => [ - 'description' => 'Alert Delivery Configuration Object.', - 'visibility' => 'Public', + 'description' => 'The alert delivery configuration object.', 'type' => 'object', 'properties' => [ - 'notification' => [ - 'description' => 'Alert Notification Configuration.', - 'visibility' => 'Public', - 'backendName' => 'notification', - '$ref' => '#/components/schemas/AlertRuleNotification', - ], - 'action' => [ - 'description' => 'Alert Action Integration Configuration.', - 'visibility' => 'Public', - 'backendName' => 'action', - '$ref' => '#/components/schemas/AlertRuleAction', - ], - 'sendToArms' => [ + 'notification' => ['description' => 'The alert notification configuration.', '$ref' => '#/components/schemas/AlertRuleNotification', 'title' => '', 'example' => ''], + 'action' => ['description' => 'The integrated alert action configuration.', '$ref' => '#/components/schemas/AlertRuleAction', 'title' => '', 'example' => ''], + 'sendToArms' => ['title' => '是否将告警事件投递至ARMS告警管理', 'description' => 'Specifies whether to deliver alert events to Alert Management of Application Real-Time Monitoring Service (ARMS).', 'type' => 'boolean', 'example' => 'true'], + 'notifyStrategies' => [ + 'type' => 'array', + 'items' => ['description' => 'The notification policy.', 'type' => 'string', 'title' => '', 'example' => '["trigger", "recovery"]'], + 'description' => 'The list of notification policies. Each policy defines the notification method or policy name to use for a specific alert state, such as trigger or recovery.', 'title' => '', - 'description' => 'Whether to deliver alert events to ARMS Alert Management.', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'sendToArms', + 'example' => '', ], + 'rcaConfig' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/AlertRuleRcaConfig'], ], + 'title' => '', + 'example' => '', ], 'AlertRuleSlsQueryJoin' => [ - 'description' => 'SLS Query Connection Configuration.', + 'description' => 'The SLS query join configuration.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'conditions' => [ - 'description' => 'List of connection conditions.', + 'description' => 'The list of join conditions.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ - 'title' => '', - 'description' => 'Set operation condition.', + 'title' => '集合操作条件', + 'description' => 'The condition for the collection operation.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'oper' => [ - 'title' => '', - 'description' => 'Comparison operator; valid values: <, >, ==, !=, <=, >=.', - 'visibility' => 'Public', - 'type' => 'string', - 'deprecated' => false, - 'hasServerDefaultValue' => false, - 'example' => '==', - 'pattern' => '', - 'readOnly' => false, - 'backendName' => 'oper', - 'sensitive' => false, - 'extMonitorInfo' => false, - 'descriptionEn' => 'join operator', - 'default' => '', + 'title' => '集合联接条件操作符', 'description' => 'The comparison operator. Valid values are <, >, ==, !=, <=, and >=.', 'visibility' => 'Public', 'type' => 'string', 'deprecated' => false, 'hasServerDefaultValue' => false, 'pattern' => '', 'readOnly' => false, 'backendName' => 'oper', 'sensitive' => false, + 'extMonitorInfo' => false, 'descriptionEn' => 'join operator', 'default' => '', 'example' => '==', ], 'secondField' => [ - 'title' => '', - 'description' => 'Right-hand operand of the condition, formatted as $<query_idx>.<result_set_field_name>.', - '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' => '', + 'title' => '条件的右操作参数', 'description' => 'The right operand of the condition. The format is $\\<query\\_idx>.\\<field\\_name\\_in\\_result\\_set>.', 'visibility' => 'Public', 'type' => 'string', 'deprecated' => false, 'hasServerDefaultValue' => false, 'pattern' => '', 'readOnly' => false, 'backendName' => 'secondField', 'sensitive' => false, + 'extMonitorInfo' => false, 'descriptionEn' => 'right parameter of join condition', 'default' => '', 'example' => '$0.__topic__', ], 'firstField' => [ - 'title' => '', - 'description' => 'Left-hand operand of the condition, formatted as $<query_idx>.<result_set_field_name>.', - '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' => '', + 'title' => '条件的左操作参数', 'description' => 'The left operand of the condition. The format is $\\<query\\_idx>.\\<field\\_name\\_in\\_result\\_set>.', 'visibility' => 'Public', 'type' => 'string', 'deprecated' => false, 'hasServerDefaultValue' => false, 'pattern' => '', 'readOnly' => false, 'backendName' => 'firstField', 'sensitive' => false, + 'extMonitorInfo' => false, 'descriptionEn' => 'left parameter of join condition', 'default' => '', 'example' => '$0.__topic__', ], ], 'deprecated' => false, @@ -2643,5056 +1553,4818 @@ 'descriptionEn' => 'join condition', 'extendType' => 'true', 'unordered' => false, + 'example' => '', ], 'backendName' => 'conditions', + 'title' => '', + 'example' => '', ], 'type' => [ - 'title' => '', - 'description' => 'Set operation type.'."\n" - .'CrossJoin: Cartesian product'."\n" - .'FullJoin: Full outer join'."\n" - .'InnerJoin: Inner join'."\n" - .'LeftExclude: Left anti join'."\n" - .'RightExclude: Right anti join'."\n" - .'LeftJoin: Left outer join'."\n" - .'RightJoin: Right outer join'."\n" - .'NoJoin: No merge'."\n" - .'Concat: Concatenation'."\n" + 'title' => '查询结果集合操作类型', + 'description' => 'The type of the collection operation.'."\n" + ."\n" + .'- CrossJoin: The Cartesian product.'."\n" + ."\n" + .'- FullJoin: The full join.'."\n" ."\n" - .'See also: https://help.aliyun.com/zh/sls/user-guide/set-query-statistics-statement', + .'- InnerJoin: The inner join.'."\n" + ."\n" + .'- LeftExclude: The left exclusion.'."\n" + ."\n" + .'- RightExclude: The right exclusion.'."\n" + ."\n" + .'- LeftJoin: The left join.'."\n" + ."\n" + .'- RightJoin: The right join.'."\n" + ."\n" + .'- NoJoin: No merge operation is performed.'."\n" + ."\n" + .'- Concat: Concatenation.'."\n" + ."\n" + .'For more information, see https\\://www\\.alibabacloud.com/help/en/sls/user-guide/set-operations.', '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'], + 'example' => 'CrossJoin', ], ], + 'title' => '', + 'example' => '', + ], + 'AlertRuleTemplate' => [ + 'type' => 'object', + 'properties' => [ + 'id' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'], + 'uuid' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'gmtCreate' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'], + 'gmtModified' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'], + 'userId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'templateName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'isSystem' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'], + 'alertType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'subType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'status' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'], + 'applyCount' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'], + 'ruleConfigs' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'labels' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'datasource' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'scenes' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'sourceType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'bizType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'schemaVersion' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'AlertRuleTimeSpan' => [ - 'description' => 'Time Window Configuration Object.', - 'visibility' => 'Public', + 'description' => 'The configuration object for a time segment.', 'type' => 'object', 'properties' => [ 'dayOfWeek' => [ - 'title' => '', - 'description' => 'Day of the week.', - 'visibility' => 'Public', + 'title' => '每周的星期几', + 'description' => 'The days of the week.', 'type' => 'array', 'items' => [ - 'description' => 'Day of the week.', - 'visibility' => 'Public', + 'description' => 'The day of the week.', 'type' => 'integer', 'format' => 'int32', + 'enum' => ['1', '2', '3', '4', '5', '6', '7'], + 'title' => '', 'example' => '1', + 'visibility' => 'Public', 'extendType' => 'true', - 'enum' => [ - '1', - '2', - '3', - '4', - '5', - '6', - '7', - ], ], + 'example' => '', + 'visibility' => 'Public', 'backendName' => 'dayOfWeek', ], - 'gmtOffset' => [ - 'title' => '', - 'description' => 'Default time zone is Beijing Time: +0800.', - 'visibility' => 'Public', + 'gmtOffset' => ['title' => '默认北京时间： +0800', 'description' => 'The default value is +0800 (UTC+8).', 'type' => 'string', 'example' => '+0800', 'visibility' => 'Public', 'backendName' => 'gmtOffset'], + 'startTime' => ['title' => '开始时间，格式HH:mm', 'description' => 'The start time. The format is HH:mm.', 'type' => 'string', 'example' => '09:00', 'visibility' => 'Public', 'backendName' => 'startTime'], + 'endTime' => ['title' => '结束时间，格式HH:mm', 'description' => 'The end time. The format is HH:mm.', 'type' => 'string', 'example' => '23:00', 'visibility' => 'Public', 'backendName' => 'endTime'], + ], + 'title' => '', + 'example' => '', + 'visibility' => 'Public', + ], + 'AlertRuleV2' => [ + 'description' => 'The `AlertRuleV2` object contains the complete configuration for an alert rule.', + 'type' => 'object', + 'properties' => [ + 'uuid' => ['description' => 'The unique identifier for the alert rule.', 'type' => 'string', 'title' => '', 'example' => '', 'readOnly' => true], + 'createdAt' => ['description' => 'The time the alert rule was created.', 'type' => 'string', 'title' => '', 'example' => '', 'readOnly' => true], + 'updatedAt' => ['description' => 'The time the alert rule was last updated.', 'type' => 'string', 'title' => '', 'example' => '', 'readOnly' => true], + 'status' => [ + 'description' => 'The current status of the alert rule. Examples: `RUNNING`, `STOPPED`.', 'type' => 'string', - 'example' => '+0800', - 'backendName' => 'gmtOffset', + 'title' => '', + 'example' => '', + 'readOnly' => true, + 'enum' => ['Alarm', 'Ok'], + ], + 'workspace' => ['description' => 'The ID of the workspace that contains the alert rule.', 'type' => 'string', 'title' => '', 'example' => '', 'required' => false], + 'displayName' => ['description' => 'The user-defined display name for the alert rule.', 'type' => 'string', 'title' => '', 'example' => ''], + 'contentTemplate' => ['description' => 'The template for the alert notification content.', 'type' => 'string', 'title' => '', 'example' => ''], + 'enabled' => ['description' => 'Indicates whether the alert rule is active. Set to `true` to enable the rule, or `false` to disable it.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'datasourceConfig' => ['description' => 'The configuration for the data source to be evaluated.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/DatasourceConfigUnified'], + 'queryConfig' => ['description' => 'The configuration for querying and processing data from the data source.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/QueryConfigUnified'], + 'conditionConfig' => ['description' => 'The configuration for the conditions that trigger an alert.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ConditionConfigUnified'], + 'scheduleConfig' => ['description' => 'The configuration for how often the alert rule is evaluated.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ScheduleConfigUnified'], + 'notifyConfig' => ['description' => 'The configuration for sending notifications when an alert is triggered.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/NotifyConfigUnified'], + 'actionIntegrationConfig' => ['description' => 'Configuration for action integrations, such as webhooks, that execute when an alert is triggered.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ActionIntegrationConfig'], + 'armsIntegrationConfig' => ['description' => 'The configuration for integrating the alert rule with Application Real-Time Monitoring Service (ARMS).', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ArmsIntegrationConfig'], + 'labels' => [ + 'description' => 'A set of key-value pairs that serve as labels to filter and group alert rules.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of the label.', 'type' => 'string', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], - 'startTime' => [ + 'annotations' => [ + 'description' => 'A set of key-value pairs that serve as annotations, providing additional, non-identifying information, such as a description or a runbook link.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of the annotation.', 'type' => 'string', 'title' => '', 'example' => ''], 'title' => '', - 'description' => 'Start time, in HH:mm format.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '09:00', - 'backendName' => 'startTime', + 'example' => '', ], - 'endTime' => [ + 'datasourceType' => ['description' => 'The data source type. Examples: `sls`, `prometheus`.', 'type' => 'string', 'title' => '', 'example' => ''], + 'observeResourceType' => ['description' => 'The type of resource that the alert rule monitors.', 'type' => 'string', 'title' => '', 'example' => ''], + 'observeResourceGlobalScope' => ['description' => 'Indicates whether the alert rule monitors all resources of the specified type. If `true`, the rule applies globally within the workspace.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'observeResourceList' => [ + 'description' => 'A list of specific resource IDs to monitor, used only when `observeResourceGlobalScope` is `false`.', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'type' => 'array', 'title' => '', - 'description' => 'End time, in HH:mm format.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '23:00', - 'backendName' => 'endTime', + 'example' => '', ], + 'severityLevels' => ['description' => 'The severity level of the alert. Examples: `critical`, `warning`.', 'type' => 'string', 'title' => '', 'example' => ''], + 'notifyStrategyId' => ['description' => 'The ID of the notification strategy to use for this alert rule.', 'type' => 'string', 'title' => '', 'example' => ''], + 'partitionKey' => ['description' => 'The partition key used to group alerts. Alerts with the same partition key are treated as a single incident.', 'type' => 'string', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], - 'BizTraceConfig' => [ - 'description' => '', - 'visibility' => 'Public', + 'ApmCompositeCompareConfig' => [ + 'description' => 'Defines a composite comparison condition for an alert rule.', 'type' => 'object', 'properties' => [ - 'workspace' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'aggregate' => [ + 'description' => 'The aggregation method for metric data. For example, `AVG`, `SUM`, or `MAX`.', 'type' => 'string', - 'example' => 'default-cms-xxxxxxx-cn-hangzhou', - 'backendName' => 'workspace', - ], - 'bizTraceId' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'e339260ed64c95d', - 'backendName' => 'bizTraceId', + 'example' => '', + 'required' => true, + 'enum' => ['AVG', 'SUM', 'COUNT', 'CONTINUES', 'MAX', 'MIN', 'P50', 'P75', 'P90', 'P99'], ], - 'bizTraceName' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'operator' => [ + 'description' => 'The operator for comparing the aggregated metric data against the `threshold`. For example, `GREATER_THAN` or `LESS_THAN`.', 'type' => 'string', - 'example' => 'just test', - 'backendName' => 'bizTraceName', + 'title' => '', + 'example' => '', + 'required' => true, + 'enum' => ['GT', 'GTE', 'LT', 'LTE', 'EQ', 'NE', 'YOY_UP', 'YOY_DOWN'], ], - 'bizTraceCode' => [ + 'threshold' => ['description' => 'The value to compare the aggregated metric data against. An alert is triggered when the metric data meets the condition defined by the `operator`.', 'type' => 'number', 'title' => '', 'example' => '', 'format' => 'float', 'required' => true], + 'yoyTimeUnit' => [ + 'description' => 'The time unit for the year-over-year (YoY) comparison. Use this parameter with `yoyTimeValue` to define the comparison period. Valid values are `day` and `week`.', + 'type' => 'string', 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'example' => '', + 'enum' => ['minute', 'hour', 'day', 'week', 'month'], + ], + 'yoyTimeValue' => ['description' => 'The time value for the YoY comparison. For example, if `yoyTimeUnit` is `day` and `yoyTimeValue` is `7`, the system compares current data with data from 7 days ago.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + ], + 'title' => '', + 'example' => '', + ], + 'ApmFilterConfig' => [ + 'description' => 'Defines a single condition for filtering APM data traces.', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The tag key to filter by. For example, to filter traces by region, set this parameter to `RegionId`.', 'type' => 'string', 'title' => '', 'example' => '', 'required' => true], + 'type' => [ + 'description' => 'The comparison operator used to match the tag\'s value. Valid values: `EQUAL` and `NOT_EQUAL`.', 'type' => 'string', - 'example' => 'label_env', - 'backendName' => 'bizTraceCode', + 'title' => '', + 'example' => '', + 'required' => true, + 'enum' => ['ALL', 'EQ', 'NE', 'DISABLED'], ], - 'ruleConfig' => [ + 'value' => ['description' => 'The value to compare against the tag\'s value. Used with the `key` and `type` parameters to form a complete filter condition.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'ApmMeasureConfig' => [ + 'description' => 'The configuration for querying an Application Performance Monitoring (APM) metric.', + 'type' => 'object', + 'properties' => [ + 'measureCode' => ['description' => 'The unique code that identifies the metric.', 'type' => 'string', 'title' => '', 'example' => '', 'required' => true], + 'windowSecs' => ['description' => 'The aggregation period in seconds, which determines the time granularity of data points.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32', 'required' => true], + 'groupBy' => [ + 'description' => 'An array of dimension keys used to group the results.', + 'type' => 'array', + 'items' => ['description' => 'A dimension key used for grouping.', 'type' => 'string', 'title' => '', 'example' => ''], 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '[{"entrancePid":"xxxxx@b57c44xx6e86","rpcMatcher":{"matchType":"EQUALS","pattern":"/createApp"},"characteristics":{"operation":"AND","rules":[{"target":"CUSTOM_EXTRACT","matcher":{"matchType":"CONTAINS","pattern":[]}}]}}]', - 'backendName' => 'ruleConfig', + 'example' => '', ], - 'advancedConfig' => [ + ], + 'title' => '', + 'example' => '', + ], + 'ApmThresholdConfig' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'severity' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', 'type' => 'string', - 'example' => '{"sample":{"strategy":"BY_APP"}}', - 'backendName' => 'advancedConfig', + 'description' => '', + 'example' => '', + 'required' => true, + 'enum' => ['INFO', 'WARN', 'WARNING', 'ERROR', 'CRITICAL'], ], - 'createTime' => [ + 'threshold' => ['title' => '', 'type' => 'number', 'description' => '', 'example' => '', 'format' => 'float'], + 'min' => ['title' => '', 'type' => 'number', 'description' => '', 'example' => '', 'format' => 'double'], + 'max' => ['title' => '', 'type' => 'number', 'description' => '', 'example' => '', 'format' => 'double'], + ], + 'description' => '', + 'example' => '', + ], + 'ArmsIntegrationConfig' => [ + 'description' => 'The settings for Application Real-Time Monitoring Service (ARMS) integration.', + 'type' => 'object', + 'properties' => [ + 'enabled' => ['description' => 'Whether ARMS integration is enabled.', 'type' => 'boolean', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'BizTraceConfig' => [ + 'type' => 'object', + 'properties' => [ + 'workspace' => ['title' => '工作空间。', 'description' => 'The workspace.', 'type' => 'string', 'example' => 'default-cms-xxxxxxx-cn-hangzhou'], + 'bizTraceId' => ['title' => '业务链路id', 'description' => 'The business trace ID.', 'type' => 'string', 'example' => 'e339260ed64c95d'], + 'bizTraceName' => ['title' => '业务链路名称', 'description' => 'The business trace name.', 'type' => 'string', 'example' => 'just test'], + 'bizTraceCode' => ['title' => '业务链路标识', 'description' => 'The business trace identifier.', 'type' => 'string', 'example' => 'label_env'], + 'ruleConfig' => ['title' => '配置规则列表', 'description' => 'The list of configuration rules.', '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' => 'The advanced configuration.', 'type' => 'string', 'example' => '{"sample":{"strategy":"BY_APP"}}'], + 'createTime' => ['title' => '创建时间', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-12-12 00:00:00'], + 'regionId' => ['title' => '地域id', 'description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing'], + ], + 'description' => 'The business trace configuration.', + 'title' => '', + 'example' => '', + ], + 'CloudMonitoringCompositeEscalation' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'relation' => ['title' => '', 'description' => 'Specifies the logical relationship for evaluating the conditions of the composite alert rule. Valid values: `and` and `or`.', 'type' => 'string', 'example' => ''], + 'severity' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'Specifies the severity level of the alert. For example: `Critical`, `Warning`, and `Info`.', 'type' => 'string', - 'example' => '2025-12-12 00:00:00', - 'backendName' => 'createTime', + 'enum' => ['CRITICAL', 'ERROR', 'WARNING', 'INFO'], + 'example' => '', ], - 'regionId' => [ + 'times' => ['title' => '', 'description' => 'Specifies the number of times the alert conditions must be met to trigger this escalation policy.', 'type' => 'integer', 'format' => 'int32', 'example' => ''], + 'escalations' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn-beijing', - 'backendName' => 'regionId', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/CloudMonitoringCompositeEscalationEntry', 'description' => '', 'title' => '', 'example' => ''], + 'description' => 'A single entry in the escalation policy. See the `CloudMonitoringCompositeEscalationEntry` object for details.', + 'example' => '', ], ], + 'description' => 'The `CloudMonitoringCompositeEscalation` object defines the escalation policy for a composite alert rule. It specifies the conditions that trigger an escalation.', + 'example' => '', ], - 'CmsEventForView' => [ + 'CloudMonitoringCompositeEscalationEntry' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'comparisonOperator' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'metricName' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'period' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''], + 'statistics' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'threshold' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'preCondition' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + ], 'description' => '', - 'visibility' => 'Public', + 'example' => '', + ], + 'CloudMonitoringExpressEscalation' => [ + 'title' => '', 'type' => 'object', 'properties' => [ - 'id' => [ - 'description' => '', - 'visibility' => 'Public', + 'times' => ['title' => '', 'description' => 'The number of alert occurrences required to trigger the escalation.', 'type' => 'integer', 'format' => 'int32', 'example' => ''], + 'severity' => [ + 'title' => '', + 'description' => 'The alert severity that triggers the escalation.', 'type' => 'string', - 'example' => '"event-1234567890"', - 'backendName' => 'id', + 'enum' => ['CRITICAL', 'ERROR', 'WARNING', 'INFO'], + 'example' => '', ], - 'dedupId' => [ - 'description' => '', - 'visibility' => 'Public', + 'rawExpression' => ['title' => '', 'description' => 'The expression that defines the alert condition.', 'type' => 'string', 'example' => ''], + ], + 'description' => 'Specifies the conditions for an express alert escalation.', + 'example' => '', + ], + 'CloudMonitoringPrometheusEscalation' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'severity' => [ + 'title' => '', + 'description' => 'The severity of the alert that triggers the escalation. This parameter is required.', 'type' => 'string', - 'example' => '"dedup-abc123"', - 'backendName' => 'dedupId', + 'enum' => ['CRITICAL', 'ERROR', 'WARNING', 'INFO'], + 'example' => '', ], - 'type' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"Alert"', - 'backendName' => 'type', + 'promQl' => ['title' => '', 'description' => 'The PromQL expression that defines the alert condition. This parameter is required.', 'type' => 'string', 'example' => ''], + 'times' => ['title' => '', 'description' => 'The number of consecutive times the condition must be met to trigger an escalation. This parameter is required.', 'type' => 'integer', 'format' => 'int32', 'example' => ''], + ], + 'description' => 'Specifies the escalation rule for a Prometheus alert.', + 'example' => '', + ], + 'CloudMonitoringSimpleEscalation' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'metricName' => ['title' => '', 'description' => 'The name of the metric.', 'type' => 'string', 'example' => ''], + 'period' => ['title' => '', 'description' => 'The evaluation period for the metric, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => ''], + 'escalations' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/CloudMonitoringSimpleEscalationEntry', 'description' => '', 'title' => '', 'example' => ''], + 'description' => 'An object that defines a single escalation rule.', + 'example' => '', ], - 'subtype' => [ - 'description' => '', - 'visibility' => 'Public', + ], + 'description' => 'Specifies the simple escalation policy for a Cloud Monitor alert.', + 'example' => '', + ], + 'CloudMonitoringSimpleEscalationEntry' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'comparisonOperator' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'statistics' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'threshold' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'severity' => [ + 'title' => '', 'type' => 'string', - 'example' => '"HighCPUUsage"', - 'backendName' => 'subtype', - ], - 'source' => [ + 'enum' => ['CRITICAL', 'ERROR', 'WARNING', 'INFO'], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"ECS"', - 'backendName' => 'source', + 'example' => '', ], - 'time' => [ - 'description' => '', - 'visibility' => 'Public', + 'times' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''], + 'preCondition' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + ], + 'description' => '', + 'example' => '', + ], + 'CmsEventForView' => [ + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The unique identifier for the event. The system generates this globally unique ID.', 'type' => 'string', 'title' => '', 'example' => '"event-1234567890"'], + 'dedupId' => ['description' => 'The deduplication ID. It identifies different instances of the same event, such as a repeatedly reported event.', 'type' => 'string', 'title' => '', 'example' => '"dedup-abc123"'], + 'type' => ['description' => 'The event type.', 'type' => 'string', 'title' => '', 'example' => '"Alert"'], + 'subtype' => ['description' => 'The event subtype.', 'type' => 'string', 'title' => '', 'example' => '"HighCPUUsage"'], + 'source' => ['description' => 'The name of the source system or service, such as ECS, RDS, or VPC.', 'type' => 'string', 'title' => '', 'example' => '"ECS"'], + 'time' => ['description' => 'The time when the event occurred.', 'type' => 'string', 'title' => '', 'example' => '"2025-04-05T10:30:00Z"'], + 'timestamp' => ['description' => 'The timestamp of the event occurrence.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1743846600000'], + 'subject' => ['description' => 'The subject or title of the event. It briefly describes the event.', 'type' => 'string', 'title' => '', 'example' => '"Instance cpu usage exceeds threshold"'], + 'severity' => ['description' => 'The severity level of the event.', 'type' => 'string', 'title' => '', 'example' => '"CRITICAL"'], + 'status' => ['description' => 'The current status of the event.', 'type' => 'string', 'title' => '', 'example' => 'Running'], + 'resource' => ['description' => 'Information about the resource associated with the event, such as the instance ID, IP address, and region.', '$ref' => '#/components/schemas/EventResourceForEventView', 'title' => '', 'example' => ''], + 'labels' => ['description' => 'The key-value pairs of the event labels.', 'type' => 'object', 'title' => '', 'example' => '{\'source\': \'system\'}'], + 'annotations' => ['description' => 'Additional annotations for the event. This is an unstructured description field.', 'type' => 'object', 'title' => '', 'example' => '{ "description": "High load detected on server", "operator": "auto" }'], + 'dataschema' => ['description' => 'The data schema definition, which describes the structure of the data field.', 'type' => 'string', 'title' => '', 'example' => '"https://schema.alibabacloud.com/cms/alert/v1"'], + 'datacontenttype' => ['description' => 'The content type of the data field.', 'type' => 'string', 'title' => '', 'example' => '"application/json"'], + 'data' => ['description' => 'The raw data of the event. The format depends on the event type and dataschema.', 'type' => 'any', 'title' => '', 'example' => '{ "metricName": "cpu_usage", "value": 95.2, "threshold": 80 }'], + 'receiveTime' => ['description' => 'The timestamp when the event was received and processed.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1743846610000'], + 'workspace' => ['description' => 'The ID or name of the workspace. It is used for multi-tenant or organization fencing.', 'type' => 'string', 'title' => '', 'example' => '"ws-abc123"'], + 'workspaceTags' => ['description' => 'The workspace tags. They help you manage events by tag.', 'type' => 'object', 'title' => '', 'example' => '{ "department": "finance", "project": "payment-gateway" }'], + 'sysId' => ['description' => 'The internal system event ID. It is used for internal tracking and log association.', 'type' => 'string', 'title' => '', 'example' => '"sys-event-987654321"'], + 'integrationUuid' => ['description' => 'The unique integration identifier. It is used for identity recognition in cross-system integrations.', 'type' => 'string', 'title' => '', 'example' => '"integration-xyz"'], + 'sourcetype' => ['description' => 'The type of event source. It distinguishes between sources such as monitoring systems, Simple Log Service, and application observability.', 'type' => 'string', 'title' => '', 'example' => '"CloudMonitor"'], + ], + 'description' => 'The event object. It contains the core information and context of an event.', + 'title' => '', + 'example' => '', + ], + 'ConditionConfigUnified' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'title' => '', 'type' => 'string', - 'example' => '"2025-04-05T10:30:00Z"', - 'backendName' => 'time', - ], - 'timestamp' => [ 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1743846600000', - 'backendName' => 'timestamp', - ], - 'subject' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"Instance cpu usage exceeds threshold"', - 'backendName' => 'subject', + 'example' => '', + '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' => '', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int32'], 'severity' => [ - 'description' => '', - 'visibility' => 'Public', + 'title' => '', 'type' => 'string', - 'example' => '"CRITICAL"', - 'backendName' => 'severity', - ], - 'status' => [ 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Running', - 'backendName' => 'status', + 'example' => '', + 'enum' => ['INFO', 'WARN', 'WARNING', 'ERROR', 'CRITICAL'], ], - 'resource' => [ + 'operator' => [ + 'title' => '', + 'type' => 'string', 'description' => '', - 'visibility' => 'Public', - 'backendName' => 'resource', - '$ref' => '#/components/schemas/EventResourceForEventView', + 'example' => '', + 'enum' => ['GT', 'GE', 'GTE', 'LT', 'LE', 'LTE', 'EQ', 'NE', 'IN_RANGE', 'OUT_OF_RANGE', 'PRESENT', 'NOT_PRESENT', 'YOY_UP', 'YOY_DOWN'], ], - 'labels' => [ + 'threshold' => ['title' => '', 'type' => 'number', 'description' => '', 'example' => '', 'format' => 'double'], + 'min' => ['title' => '', 'type' => 'number', 'description' => '', 'example' => '', 'format' => 'double'], + 'max' => ['title' => '', 'type' => 'number', 'description' => '', 'example' => '', 'format' => 'double'], + 'aggregate' => [ + 'title' => '', + 'type' => 'string', 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{\'source\': \'system\'}', - 'backendName' => 'labels', + 'example' => '', + 'enum' => ['AVG', 'SUM', 'COUNT', 'CONTINUES', 'MAX', 'MIN', 'P50', 'P75', 'P90', 'P99'], ], - 'annotations' => [ + 'matchField' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'matchOperator' => [ + 'title' => '', + 'type' => 'string', 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{ "description": "High load detected on server", "operator": "auto" }', - 'backendName' => 'annotations', + 'example' => '', + 'enum' => ['PRESENT', 'NOT_PRESENT', 'CONTAINS', 'EQUALS', 'REGEX'], ], - 'dataschema' => [ - 'description' => '', - 'visibility' => 'Public', + 'matchValue' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'countOperator' => [ + 'title' => '', 'type' => 'string', - 'example' => '"https://schema.alibabacloud.com/cms/alert/v1"', - 'backendName' => 'dataschema', - ], - 'datacontenttype' => [ 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"application/json"', - 'backendName' => 'datacontenttype', + 'example' => '', + 'enum' => ['GTE', 'GT', 'EQ', 'LTE', 'LT'], ], - 'data' => [ + 'countThreshold' => ['title' => '', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int64'], + 'thresholdList' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ApmThresholdConfig'], 'description' => '', - 'visibility' => 'Public', - 'type' => 'any', - 'example' => '{ "metricName": "cpu_usage", "value": 95.2, "threshold": 80 }', - 'backendName' => 'data', + 'example' => '', ], - 'receiveTime' => [ + 'compareList' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ApmCompositeCompareConfig'], 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1743846610000', - 'backendName' => 'receiveTime', + 'example' => '', ], - 'workspace' => [ - 'description' => '', - 'visibility' => 'Public', + 'relation' => [ + 'title' => '', 'type' => 'string', - 'example' => '"ws-abc123"', - 'backendName' => 'workspace', - ], - 'workspaceTags' => [ 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{ "department": "finance", "project": "payment-gateway" }', - 'backendName' => 'workspaceTags', + 'example' => '', + 'enum' => ['OR', 'AND'], ], - 'sysId' => [ - 'description' => '', - 'visibility' => 'Public', + 'escalationType' => [ + 'title' => '', 'type' => 'string', - 'example' => '"sys-event-987654321"', - 'backendName' => 'sysId', - ], - 'integrationUuid' => [ 'description' => '', - 'visibility' => 'Public', + 'example' => '', + 'enum' => ['simple', 'composite', 'express', 'prometheus'], + ], + 'simpleEscalation' => ['title' => '', 'description' => '', 'example' => '', '$ref' => '#/components/schemas/CloudMonitoringSimpleEscalation'], + 'compositeEscalation' => ['title' => '', 'description' => '', 'example' => '', '$ref' => '#/components/schemas/CloudMonitoringCompositeEscalation'], + 'expressEscalation' => ['title' => '', 'description' => '', 'example' => '', '$ref' => '#/components/schemas/CloudMonitoringExpressEscalation'], + 'prometheus' => ['title' => '', 'description' => '', 'example' => '', '$ref' => '#/components/schemas/CloudMonitoringPrometheusEscalation'], + 'noDataPolicy' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'legacyType' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'yoyTimeUnit' => [ + 'title' => '', 'type' => 'string', - 'example' => '"integration-xyz"', - 'backendName' => 'integrationUuid', + 'description' => '', + 'example' => '', + 'enum' => ['minute', 'hour', 'day', 'week', 'month'], ], - 'sourcetype' => [ + 'yoyTimeValue' => ['title' => '', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int32'], + 'triggers' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/MetricSetMultiTrigger', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"CloudMonitor"', - 'backendName' => 'sourcetype', + 'example' => '', ], + 'enableSeveritySuppression' => ['title' => '', 'type' => 'boolean', 'description' => '', 'example' => ''], + 'legacyRaw' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], ], + 'description' => '', + 'example' => '', ], 'ContactForIncidentView' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'contactId' => [ - 'description' => '', - 'visibility' => 'Public', + 'contactId' => ['description' => 'The contact ID.', 'type' => 'string', 'title' => '', 'example' => '"contact-123456"'], + 'name' => ['description' => 'The contact name.', 'type' => 'string', 'title' => '', 'example' => '"张三"'], + ], + 'description' => 'The contact object.', + 'title' => '', + 'example' => '', + ], + 'CustomExtractionStrategy' => [ + 'type' => 'object', + 'properties' => [ + 'strategyName' => ['description' => 'Policy Name', 'type' => 'string', 'title' => '', 'example' => 'test1'], + 'strategyType' => ['description' => 'Policy type. Supports "Episodic", "Summary", and "Fact".', 'type' => 'string', 'title' => '', 'example' => 'Fact'], + 'extractionPrompt' => ['description' => 'Extraction prompt', 'type' => 'string', 'title' => '', 'example' => 'test'], + 'updatePrompt' => ['description' => 'Update prompt', 'type' => 'string', 'title' => '', 'example' => 'test'], + 'description' => ['description' => 'Description', 'type' => 'string', 'title' => '', 'example' => 'test'], + ], + 'description' => 'Custom extraction policy', + 'title' => '', + 'example' => '', + ], + 'DatasourceConfigUnified' => [ + 'description' => 'Specifies the configuration for a unified data source.', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => 'The type of the data source.', 'type' => 'string', - 'example' => '"contact-123456"', - 'backendName' => 'contactId', + 'title' => '', + 'example' => '', + 'required' => true, + 'enum' => ['PROMETHEUS', 'UMODEL', 'APM', 'CLOUD_MONITORING', 'UNKNOWN'], ], - 'name' => [ - 'description' => '', - 'visibility' => 'Public', + 'instanceId' => ['description' => 'The unique instance ID.', 'type' => 'string', 'title' => '', 'example' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'title' => '', 'example' => ''], + 'productCategory' => ['description' => 'The product category of the data source.', 'type' => 'string', 'title' => '', 'example' => ''], + 'legacyType' => ['description' => 'The legacy type of the data source, used for backward compatibility.', 'type' => 'string', 'title' => '', 'example' => ''], + 'legacyRaw' => ['description' => 'The raw string value of the legacy configuration, used for backward compatibility.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'DatasourceTypeFilter' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'eq' => ['title' => '', 'description' => 'Specifies the data source type for an exact match.', 'type' => 'string', 'example' => ''], + ], + 'description' => 'A filter for the data source type.', + 'example' => '', + ], + 'DirectNotifyChannel' => [ + 'description' => 'Defines the configuration for a direct notification channel.', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => 'The notification channel type. For example, `sms` or `email`.', 'type' => 'string', + 'title' => '', + 'example' => '', + 'required' => true, + 'enum' => ['CONTACT', 'GROUP', 'DINGTALK', 'FEISHU', 'SLACK', 'WEIXIN', 'WEBHOOK'], + ], + 'identifiers' => [ + 'description' => 'An array of recipient identifiers. The format of each identifier depends on the `type`. For example, if `type` is `email`, the identifiers are email addresses.', + 'type' => 'array', + 'items' => ['description' => 'A recipient identifier, such as a phone number or an email address.', 'type' => 'string', 'title' => '', 'example' => ''], + 'required' => true, + 'title' => '', 'example' => '', - 'backendName' => 'name', ], ], + 'title' => '', + 'example' => '', + ], + 'DisplayNameFilter' => [ + 'description' => 'Filters resources by their display name.', + 'type' => 'object', + 'properties' => [ + 'contains' => ['description' => 'Returns only resources whose display name contains the specified string. The match is case-sensitive.', 'type' => 'string', 'title' => '', 'example' => ''], + 'notContains' => ['description' => 'Returns only resources whose display name does not contain the specified string. The match is case-sensitive.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', ], 'EffectTimeRange' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'dayInWeek' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '[1, 2, 3]', - 'extendType' => 'true', - ], - 'backendName' => 'dayInWeek', - ], - 'startTimeInMinute' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '360', - 'backendName' => 'startTimeInMinute', - ], - 'endTimeInMinute' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1080', - 'backendName' => 'endTimeInMinute', - ], - 'timeZone' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"Asia/Shanghai"', - 'backendName' => 'timeZone', + 'items' => ['description' => 'The values 0 to 6 indicate Sunday to Saturday.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '[1, 2, 3]'], + 'description' => 'The values 0 to 6 indicate Sunday to Saturday.', + 'title' => '', + 'example' => '', ], + 'startTimeInMinute' => ['description' => 'The start time in minutes.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '360'], + 'endTimeInMinute' => ['description' => 'The end time in minutes.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1080'], + 'timeZone' => ['description' => 'The time zone.', 'type' => 'string', 'title' => '', 'example' => '"Asia/Shanghai"'], + ], + 'description' => 'The configuration of the effective time range.', + 'title' => '', + 'example' => '', + ], + 'EnabledFilter' => [ + 'description' => 'A filter for querying resources by their enabled state.', + 'type' => 'object', + 'properties' => [ + 'eq' => ['description' => 'The value to filter by. Set to `true` to return only enabled resources. Set to `false` to return only disabled resources.', 'type' => 'boolean', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], 'EntityDiscoverRule' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The entity discovery rule model.', 'type' => 'object', 'properties' => [ + 'resourceGroupId' => ['title' => '资源组ID。', 'description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-acfm2m7atreujs1'], 'ipMatchRule' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'array', + 'title' => 'IP 匹配规则', + 'description' => 'A collection of IP address matching rules.', + 'type' => 'object', 'items' => [ - 'title' => '', - 'description' => '', + 'title' => 'IP匹配规则。', + 'description' => 'IP匹配规则。', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'ipFieldKey' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'hostIp', - 'backendName' => 'ipFieldKey', - ], - 'ipCIDR' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '192.168.0.1/10', - 'backendName' => 'ipCIDR', - ], + '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', ], - 'backendName' => 'ipMatchRule', - ], - 'instanceIds' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'i-bp1gj8wyq4fxk28k6iy2', - 'extendType' => 'true', - ], - 'backendName' => 'instanceIds', - ], - 'fieldRules' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'op' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'in', - 'backendName' => 'op', - ], - 'fieldKey' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'instanceId', - 'backendName' => 'fieldKey', - ], - 'fieldValues' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'i-bp1gj8wyq4fxk28k6iy2', - 'extendType' => 'true', - ], - 'backendName' => 'fieldValues', - ], - ], - 'extendType' => 'true', + 'example' => '', + 'properties' => [ + 'ipFieldKey' => ['title' => 'IP 的属性 Key', 'type' => 'string', 'description' => '', 'example' => ''], + 'ipCIDR' => ['title' => 'IP 的网段 CIDR', 'type' => 'string', 'description' => '', 'example' => ''], ], - 'backendName' => 'fieldRules', ], - 'annotations' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'tags' => [ + 'title' => '通过Tag进行服务发现。', + 'description' => 'The tag-based service discovery rules.', 'type' => 'array', 'items' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'title' => '使用Tag的发现信息。', + 'description' => 'The details of a tag-based discovery rule.', 'type' => 'object', 'properties' => [ - 'op' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'in', - 'backendName' => 'op', - ], - 'tagKey' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'instanceId', - 'backendName' => 'tagKey', - ], + 'tagKey' => ['title' => 'Tag的Key。', 'description' => 'The key of the tag.', 'type' => 'string', 'example' => 'project'], + 'op' => ['title' => '操作。', 'description' => 'The operation.', 'type' => 'string', 'example' => 'in'], 'tagValues' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'title' => 'Tag的值集合。', + 'description' => 'A collection of tag values.', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'i-bp1gj8wyq4fxk28k6iy2'."\n", - 'extendType' => 'true', - ], - 'backendName' => 'tagValues', + 'items' => ['title' => 'Tag的值。', 'description' => 'A tag value.', 'type' => 'string', 'example' => 'demo'], + 'example' => '', ], ], - 'extendType' => 'true', + 'example' => '', ], - 'backendName' => 'annotations', + 'example' => '', ], - 'resourceGroupId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'rg-acfm2m7atreujs1', - 'backendName' => 'resourceGroupId', + 'instanceIds' => [ + 'title' => '实例ID集合。', + 'description' => 'A collection of instance IDs.', + 'type' => 'array', + 'items' => ['title' => '实例ID。', 'description' => 'An instance ID.', 'type' => 'string', 'example' => 'i-bp1gj8wyq4fxk28k6iy2'], + 'example' => '', ], 'entityTypes' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'title' => '实体类型集合。', + 'description' => 'A collection of entity types.', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'acs.ecs.instance', - 'extendType' => 'true', - ], - 'backendName' => 'entityTypes', + 'items' => ['title' => '实体类型。', 'description' => 'An entity type.', 'type' => 'string', 'example' => 'acs.ecs.instance'], + 'example' => '', ], 'regionIds' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'title' => '地域ID集合。', + 'description' => 'A collection of region IDs.', + 'type' => 'array', + 'items' => ['title' => '地域ID。', 'description' => 'A region ID.', 'type' => 'string', 'example' => 'cn-shanghai'], + 'example' => '', + ], + 'labels' => [ + 'title' => '标签匹配集合。', + 'description' => 'A collection of label matching rules.', 'type' => 'array', 'items' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn-shanghai', - 'extendType' => 'true', + 'title' => '标签详情。', + 'description' => 'The label details.', + 'type' => 'object', + 'properties' => [ + 'tagKey' => ['title' => '标签的Key。', 'description' => 'The key of the label.', 'type' => 'string', 'example' => 'project'], + 'op' => ['title' => '操作。', 'description' => 'The operation.', 'type' => 'string', 'example' => 'in'], + 'tagValues' => [ + 'title' => '标签的值集合。', + 'description' => 'A collection of label values.', + 'type' => 'array', + 'items' => ['title' => '标签的值。', 'description' => 'A label value.', 'type' => 'string', 'example' => 'demo'], + 'example' => '', + ], + ], + 'example' => '', ], - 'backendName' => 'regionIds', + 'example' => '', ], - 'tags' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'annotations' => [ + 'title' => '注解匹配集合。', + 'description' => 'A collection of annotation matching rules.', 'type' => 'array', 'items' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'title' => '注解详情。', + 'description' => 'The annotation details.', 'type' => 'object', 'properties' => [ - 'op' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'in', - 'backendName' => 'op', - ], - 'tagKey' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'project', - 'backendName' => 'tagKey', - ], + 'tagKey' => ['title' => '注解的Key。', 'description' => 'The key of the annotation.', 'type' => 'string', 'example' => 'instanceId'], + 'op' => ['title' => '操作。', 'description' => 'The operation.', 'type' => 'string', 'example' => 'in'], 'tagValues' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'title' => '注解的值集合。', + 'description' => 'A collection of annotation values.', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'demo', - 'extendType' => 'true', - ], - 'backendName' => 'tagValues', + 'items' => ['title' => '注解的值。', 'description' => 'An annotation value.', 'type' => 'string', 'example' => 'i-bp1gj8wyq4fxk28k6iy2'."\n"], + 'example' => '', ], ], - 'extendType' => 'true', + 'example' => '', ], - 'backendName' => 'tags', + 'example' => '', ], - 'labels' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'fieldRules' => [ + 'title' => '属性匹配规则。', + 'description' => 'The property matching rules.', 'type' => 'array', 'items' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'title' => '属性详情。', + 'description' => 'The property details.', 'type' => 'object', 'properties' => [ - 'op' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'in', - 'backendName' => 'op', - ], - 'tagKey' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'project', - 'backendName' => 'tagKey', - ], - 'tagValues' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'fieldKey' => ['title' => '属性的Key。', 'description' => 'The key of the property.', 'type' => 'string', 'example' => 'instanceId'], + 'op' => ['title' => '操作。', 'description' => 'The operation.', 'type' => 'string', 'example' => 'in'], + 'fieldValues' => [ + 'title' => '属性的值集合。', + 'description' => 'A collection of property values.', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'demo', - 'extendType' => 'true', - ], - 'backendName' => 'tagValues', + 'items' => ['title' => '属性的值。', 'description' => 'A property value.', 'type' => 'string', 'example' => 'i-bp1gj8wyq4fxk28k6iy2'], + 'example' => '', ], ], - 'extendType' => 'true', + 'example' => '', ], - 'backendName' => 'labels', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], 'EntityGroupBase' => [ - 'title' => '', - 'description' => '', + 'title' => '实体的基础结构。', + 'description' => 'The base structure for an entity.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'workspace' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'default-cms-1654218***343050-cn-hangzhou', - 'backendName' => 'workspace', - ], - 'regionId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn-heyuan', - 'backendName' => 'regionId', - ], + 'workspace' => ['title' => '工作空间。', 'description' => 'The workspace.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'workspace', 'example' => 'default-cms-1654218***343050-cn-hangzhou'], + 'regionId' => ['title' => '地域ID。', 'description' => 'The region ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'regionId', 'example' => 'cn-heyuan'], 'entityQueries' => [ - 'title' => '', - 'description' => '', + 'title' => '实体查询规则集合。', + 'description' => 'A collection of entity query rules.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ - 'title' => '', - 'description' => '', + 'title' => '实体查询规则。', + 'description' => 'An entity query rule.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'entityType' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'acs.ecs.instance', - 'backendName' => 'entityType', - ], - 'spl' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '.entity with(type=\'acs.ecs.instance\') | where region_id in (\'cn-beijing\')', - 'backendName' => 'spl', - ], + 'entityType' => ['title' => '实体类型。', 'description' => 'The entity type.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'entityType', 'example' => 'acs.ecs.instance'], + 'spl' => ['title' => 'SPL查询语句。', 'description' => 'The Structured Process Language (SPL) search statement.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'spl', 'example' => '.entity with(type=\'acs.ecs.instance\') | where region_id in (\'cn-beijing\')'], ], 'extendType' => 'true', + 'example' => '', ], 'backendName' => 'entityQueries', - ], - 'description' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', 'example' => '', - 'backendName' => 'description', - ], - 'entityGroupId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'eg-1234567890', - 'backendName' => 'entityGroupId', ], - 'entityRules' => [ - 'title' => '', + 'description' => ['title' => '实体描述。', 'description' => 'The entity description.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'example' => 'ECS 实例'], + 'entityGroupId' => ['title' => '实体ID。', 'description' => 'The entity ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'entityGroupId', 'example' => 'eg-1234567890'], + 'entityRules' => ['title' => '用于实体发现的规则。', 'description' => 'The rule for entity discovery.', 'visibility' => 'Public', 'backendName' => 'entityRules', '$ref' => '#/components/schemas/EntityDiscoverRule', 'example' => ''], + 'entityGroupName' => ['title' => '实体名称。', 'description' => 'The entity name.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'entityGroupName', 'example' => 'ECS 全部实体'], + 'userId' => ['title' => '用户ID。', 'description' => 'The user ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'userId', 'example' => '1654218***343050'], + ], + 'example' => '', + ], + 'Evaluator' => [ + 'type' => 'object', + 'properties' => [ + 'name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'resultName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'resultType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'config' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], + 'filters' => [ + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', - 'visibility' => 'Public', - 'backendName' => 'entityRules', - '$ref' => '#/components/schemas/EntityDiscoverRule', - ], - 'entityGroupName' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', 'example' => '', - 'backendName' => 'entityGroupName', ], - 'userId' => [ - 'title' => '', + 'variableMapping' => [ + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1654218***343050', - 'backendName' => 'userId', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'EventResourceForEventView' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'entity' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'domain' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"ECS"', - 'backendName' => 'domain', - ], - 'entityType' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"Instance"', - 'backendName' => 'entity_type', - ], - 'entityId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"i-bp123456"', - 'backendName' => 'entity_id', - ], - 'prop' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{ "name": "web-server-01", "ip": "10.0.0.1" }', - 'backendName' => 'prop', - ], + 'domain' => ['description' => 'The product domain to which the resource belongs.', 'type' => 'string', 'title' => '', 'example' => '"ECS"'], + 'entityType' => ['description' => 'The specific type of the resource.', 'type' => 'string', 'title' => '', 'example' => '"Instance"'], + 'entityId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => '"i-bp123456"'], + 'prop' => ['description' => 'Extra properties of the resource.', 'type' => 'object', 'title' => '', 'example' => '{ "name": "web-server-01", "ip": "10.0.0.1" }'], ], - 'backendName' => 'entity', - ], - 'tags' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{ "env": "prod", "project": "payment-gateway" }', - 'backendName' => 'tags', + 'description' => 'The resource entity.', + 'title' => '', + 'example' => '', ], + 'tags' => ['description' => 'The tags.', 'type' => 'object', 'title' => '', 'example' => '{ "env": "prod", "project": "payment-gateway" }'], ], + 'description' => 'The resource display object.', + 'title' => '', + 'example' => '', ], 'EventResourceForIncidentView' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'tags' => [ + 'tags' => ['description' => 'The tags.', 'type' => 'string', 'title' => '', 'example' => '[{\\"value\\":\\"测试\\",\\"key\\":\\"环境\\"}]'], + 'probs' => ['description' => 'The string that describes the properties of the resource.', 'type' => 'string', 'title' => '', 'example' => '"{"name":"web-server-01","ip":"10.0.0.1"}"'], + 'entityType' => ['description' => 'The entity type.', 'type' => 'string', 'title' => '', 'example' => '"Instance"'], + 'entityId' => ['description' => 'The entity ID.', 'type' => 'string', 'title' => '', 'example' => 'default'], + 'domain' => ['description' => 'The domain of the resource type.', 'type' => 'string', 'title' => '', 'example' => 'rum'], + ], + 'description' => 'The resource associated with the event.', + 'title' => '', + 'example' => '', + ], + 'ExperimentConfig' => [ + 'type' => 'object', + 'properties' => [ + 'label' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'modelName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'modelProvider' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'modelParameters' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ModelParameters'], + 'endpointConnectorId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'promptTemplate' => [ + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/PromptTemplateItem'], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', + 'title' => '', 'example' => '', - 'backendName' => 'tags', - ], - 'probs' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"{"name":"web-server-01","ip":"10.0.0.1"}"', - 'backendName' => 'prons', ], - 'entityType' => [ + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ExperimentPlanData' => [ + 'type' => 'object', + 'properties' => [ + 'planId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'planName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'status' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'datasetId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'experimentCount' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'], + 'createdAt' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'], + 'updatedAt' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ExperimentRecord' => [ + 'type' => 'object', + 'properties' => [ + 'planId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'experimentName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'status' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'totalTasks' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'], + 'failedTasks' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'], + 'completedTasks' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'], + 'progress' => ['type' => 'number', 'description' => '', 'title' => '', 'example' => '', 'format' => 'float'], + 'executedAt' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'], + 'completedAt' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'], + 'datasetId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'planName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'recordId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'experimentConfig' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ExperimentConfig'], + 'dataSourceType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'modelName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'errorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'datasetProject' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'evaluators' => [ + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/Evaluator'], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"Instance"', - 'backendName' => 'entityType', + 'title' => '', + 'example' => '', ], - 'entityId' => [ + 'input' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], + 'selectedItemIds' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'default', - 'backendName' => 'entityId', + 'title' => '', + 'example' => '', ], - 'domain' => [ - 'description' => '', - 'visibility' => 'Public', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Filter' => [ + 'description' => 'The fields in this filter are combined with a logical AND.', + 'type' => 'object', + 'properties' => [ + 'uuid' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/UuidFilter'], + 'displayName' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/DisplayNameFilter'], + 'labels' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/LabelsFilter'], + 'status' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/StatusFilter'], + 'enabled' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/EnabledFilter'], + ], + 'title' => '', + 'example' => '', + ], + 'FilterCondition' => [ + 'title' => '过滤条件', + 'description' => 'A field/op/value triplet for event filtering.', + 'type' => 'object', + 'properties' => [ + 'field' => ['title' => '字段名', 'description' => 'The name of the field to filter on.', 'type' => 'string', 'example' => ''], + 'op' => [ + 'title' => '操作符', + 'description' => 'The comparison operator, such as `equals` or `startsWith`.', 'type' => 'string', - 'example' => 'rum', - 'backendName' => 'domain', + 'example' => '', + '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' => '比较值', 'description' => 'The value to match for the specified field and operator.', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], 'FilterSetting' => [ - 'description' => '', + 'description' => 'The filter configuration.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'expression' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1 and 2 or 3', - 'backendName' => 'expression', - ], + 'expression' => ['title' => '表达式', 'description' => 'The expression.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'expression', 'example' => '1 and 2 or 3'], 'conditions' => [ - 'title' => '', - 'description' => '', + 'title' => '订阅条件', + 'description' => 'The subscription conditions.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'A single condition.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - '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', - ], + 'op' => ['title' => '比较符', 'description' => 'The comparison operator.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'op', 'example' => 'EQ'], + 'field' => ['title' => '字段', 'description' => 'The field.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'field', 'example' => 'severity'], + 'value' => ['title' => '值', 'description' => 'The value.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'value', 'example' => 'CRITICAL'], ], 'extendType' => 'true', + 'title' => '', + 'example' => '', ], 'maxItems' => 10, 'backendName' => 'conditions', + 'example' => '', ], - 'relation' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'AND', - 'backendName' => 'relation', - ], + 'relation' => ['title' => '条件间关系', 'description' => 'The relationship between conditions.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'relation', 'example' => 'AND'], ], + 'title' => '', + 'example' => '', ], 'IncidentContactStruct' => [ - 'description' => 'Event Contact Structure.', - 'visibility' => 'Public', + 'description' => 'The event contact structure.', 'type' => 'object', 'properties' => [ - 'contactId' => [ - 'description' => 'Contact ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '627415', - 'backendName' => 'contactId', - ], + 'contactId' => ['description' => 'The contact ID.', 'type' => 'string', 'title' => '', 'example' => '627415', 'visibility' => 'Public', 'backendName' => 'contactId'], 'channel' => [ - 'description' => 'Channel list.', - 'visibility' => 'Public', + 'description' => 'The channel list.', 'type' => 'array', - 'items' => [ - 'description' => 'Channel name.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ecs', - 'extendType' => 'true', - ], - 'backendName' => 'channel', - ], - 'contactType' => [ - 'description' => 'Contact type.', + 'items' => ['description' => 'The channel name.', 'type' => 'string', 'title' => '', 'example' => 'ecs', 'visibility' => 'Public', 'extendType' => 'true'], + 'title' => '', + 'example' => '', 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'GROUP', - 'backendName' => 'contactType', + 'backendName' => 'channel', ], + 'contactType' => ['description' => 'The contact type.', 'type' => 'string', 'title' => '', 'example' => 'GROUP', 'visibility' => 'Public', 'backendName' => 'contactType'], ], + 'title' => '', + 'example' => '', + 'visibility' => 'Public', ], 'IncidentEscalationPolicyForModify' => [ 'title' => 'A short description of struct', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The entity to view.', 'type' => 'object', 'properties' => [ - 'description' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'workspace api monitor create test', - 'backendName' => 'description', - ], - 'enable' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'enabled', - ], - 'name' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '"Critical-Alert-Escalation"', - 'backendName' => 'name', - ], + 'description' => ['title' => '描述', 'description' => 'The description.', 'type' => 'string', 'example' => 'workspace api monitor create test'], + 'enable' => ['title' => '是否启用', 'description' => 'Indicates whether the policy is enabled.', 'type' => 'boolean', 'example' => 'false'], + 'name' => ['title' => '名称', 'description' => 'The name.', 'type' => 'string', 'required' => true, 'example' => '"Critical-Alert-Escalation"'], 'escalationStageList' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/IncidentEscalationStageForView', - ], - 'backendName' => 'escalationStageList', + 'items' => ['description' => 'The list of escalation stages. This list defines multiple progressive escalation steps. Each stage contains trigger conditions and notification targets.', '$ref' => '#/components/schemas/IncidentEscalationStageForView', 'title' => '', 'example' => ''], + 'description' => 'The list of escalation stages. This list defines multiple progressive escalation steps. Each stage contains trigger conditions and notification targets.', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], 'IncidentEscalationPolicyForView' => [ 'title' => 'A short description of struct', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The entity for viewing.', 'type' => 'object', 'properties' => [ - 'createTime' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58Z', - 'backendName' => 'createTime', - ], - 'description' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'workspace api monitor update test', - 'backendName' => 'description', - ], - 'enable' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'enabled', - ], - 'name' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '"Critical-Alert-Escalation"', - 'backendName' => 'name', - ], - 'updateTime' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-04-15T02:02:50Z', - 'backendName' => 'updateTime', - ], - 'userId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"user-abc123"', - 'backendName' => 'userId', - ], - 'workspace' => [ - 'title' => 'workspace', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"ws-xyz789"', - 'backendName' => 'workspace', - ], - 'ownerType' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"USER"', - 'backendName' => 'ownerType', - ], - 'source' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"MANUAL"', - 'backendName' => 'source', - ], - 'syncFromType' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"ARMS"', - 'backendName' => 'syncFromType', - ], - 'uuid' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"a1b2c3d4-e5f6-7890-1234-567890abcdef"', - 'backendName' => 'uuid', - ], - 'regionId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"cn-hangzhou"', - 'backendName' => 'regionId', - ], + 'createTime' => ['title' => '创建时间', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-03-11T08:21:58Z'], + 'description' => ['title' => '描述', 'description' => 'The description.', 'type' => 'string', 'example' => 'workspace api monitor update test'], + 'enable' => ['title' => '是否启用', 'description' => 'Indicates whether the policy is enabled.', 'type' => 'boolean', 'example' => 'true'], + 'name' => ['title' => '名称', 'description' => 'The name.', 'type' => 'string', 'required' => true, 'example' => '"Critical-Alert-Escalation"'], + 'updateTime' => ['title' => '更新时间', 'description' => 'The update time.', 'type' => 'string', 'example' => '2025-04-15T02:02:50Z'], + 'userId' => ['title' => '用户id', 'description' => 'The user ID.', 'type' => 'string', 'example' => '"user-abc123"'], + 'workspace' => ['title' => 'workspace', 'description' => 'The workspace.', 'type' => 'string', 'example' => '"ws-xyz789"'], + 'ownerType' => ['description' => 'The owner type.'."\n" + ."\n" + .'- **USER**: User. This is the default value.'."\n" + ."\n" + .'- **APP**: Application.', 'type' => 'string', 'title' => '', 'example' => '"USER"'], + 'source' => ['description' => 'The source.', 'type' => 'string', 'title' => '', 'example' => '"MANUAL"'], + 'syncFromType' => ['description' => 'The source type of the synchronization policy.', 'type' => 'string', 'title' => '', 'example' => '"ARMS"'], + 'uuid' => ['description' => 'The globally unique identifier.', 'type' => 'string', 'title' => '', 'example' => '"a1b2c3d4-e5f6-7890-1234-567890abcdef"'], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'title' => '', 'example' => '"cn-hangzhou"'], 'escalationStageList' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/IncidentEscalationStageForView', - ], - 'backendName' => 'escalationStageList', + 'items' => ['description' => 'The list of escalation stages.', '$ref' => '#/components/schemas/IncidentEscalationStageForView', 'title' => '', 'example' => ''], + 'description' => 'The list of escalation stages.', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], 'IncidentEscalationStageForView' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'cycleNotifyInterval' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'backendName' => 'cycleNotifyInterval', - ], - 'cycleNotifyCount' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'backendName' => 'cycleNotifyCount', - ], - 'triggerDelay' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - 'backendName' => 'triggerDelay', - ], - 'effectTimeRange' => [ - 'description' => '', - 'visibility' => 'Public', - 'backendName' => 'effectTimeRange', - '$ref' => '#/components/schemas/EffectTimeRange', - ], - 'targetIncidentState' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"Open"', - 'backendName' => 'targetIncidentState', - ], - 'index' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - 'backendName' => 'index', - ], + 'cycleNotifyInterval' => ['description' => 'The loop notification interval.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '5'], + 'cycleNotifyCount' => ['description' => 'The number of loop notifications.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3'], + 'triggerDelay' => ['description' => 'The trigger delay time.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '30'], + 'effectTimeRange' => ['description' => 'The effective time range.', '$ref' => '#/components/schemas/EffectTimeRange', 'title' => '', 'example' => ''], + 'targetIncidentState' => ['description' => 'The target event state.', 'type' => 'string', 'title' => '', 'example' => '"Open"'], + 'index' => ['description' => 'The stage index.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '1'], 'notifyChannels' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/NotifyChannel', - ], - 'backendName' => 'notifyChannels', + 'items' => ['description' => 'The notification channel.', '$ref' => '#/components/schemas/NotifyChannel', 'title' => '', 'example' => ''], + 'description' => 'The list of notification channels.', + 'title' => '', + 'example' => '', ], ], + 'description' => 'The escalation stage object.', + 'title' => '', + 'example' => '', ], 'IncidentEscalationStageStruct' => [ - 'description' => 'Event Escalation Phase Structure.', + 'description' => 'The event escalation stage structure.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'stageIndex' => [ - 'description' => 'Phase index.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'index', - ], - 'cycleNotifyTime' => [ - 'description' => 'Recurring notification interval.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '300', - 'backendName' => 'cycleNotifyTime', - ], + 'stageIndex' => ['description' => 'The stage index.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'index', 'title' => '', 'example' => '1'], + 'cycleNotifyTime' => ['description' => 'The notification interval.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'cycleNotifyTime', 'title' => '', 'example' => '300'], 'contact' => [ - 'description' => 'Contact list.', + 'description' => 'The list of contacts.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'Event Contact Structure.', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/IncidentContactStruct', - ], + 'items' => ['description' => 'The event contact struct.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/IncidentContactStruct', 'title' => '', 'example' => ''], 'backendName' => 'contactList', + 'title' => '', + 'example' => '', ], - 'name' => [ - 'description' => 'Name.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Operations team.'."\n", - 'backendName' => 'name', - ], - 'description' => [ - 'description' => 'Description.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Primary owner responsible for handling production environment alerts.'."\n", - 'backendName' => 'description', - ], - 'timeZone' => [ - 'description' => 'Time zone.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Asia/Shanghai', - 'backendName' => 'timeZone', - ], - 'effectTime' => [ - 'description' => 'Effective time period.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-04-05T00:00:00Z', - 'backendName' => 'effectTime', - ], - 'waitToNextStageTime' => [ - 'description' => 'Time to wait before proceeding to the next phase.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '600', - 'backendName' => 'waitToNextStageTime', - ], - 'cycleNotifyCount' => [ - 'description' => 'Number of recurring notification attempts.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'backendName' => 'cycleNotifyCount', - ], + 'name' => ['description' => 'The name.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'title' => '', 'example' => '运维团队'], + 'description' => ['description' => 'The description.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'title' => '', 'example' => '负责处理生产环境告警的主负责人'], + 'timeZone' => ['description' => 'The time zone.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'timeZone', 'title' => '', 'example' => 'Asia/Shanghai'], + 'effectTime' => ['description' => 'The effective time.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'effectTime', 'title' => '', 'example' => '2025-04-05T00:00:00Z'], + 'waitToNextStageTime' => ['description' => 'The waiting time before the next stage begins.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'waitToNextStageTime', 'title' => '', 'example' => '600'], + 'cycleNotifyCount' => ['description' => 'The number of notifications sent per cycle.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'cycleNotifyCount', 'title' => '', 'example' => '3'], ], + 'title' => '', + 'example' => '', ], 'IncidentEscalationStruct' => [ - 'description' => 'Event Escalation Structure.', + 'description' => 'The event escalation structure.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'incidentEscalationId' => [ - 'description' => 'Event Escalation ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '52631388567', - 'backendName' => 'uuid', - ], - 'workspace' => [ - 'description' => 'Workspace.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'workspace-test', - 'backendName' => 'workspace', - ], - 'modifyTime' => [ - 'description' => 'Modification time.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2025-03-11T08:21:58Z', - 'backendName' => 'gmtModified', - ], + 'incidentEscalationId' => ['description' => 'The ID of the event escalation.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'uuid', 'title' => '', 'example' => '52631388567'], + 'workspace' => ['description' => 'The workspace.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'workspace', 'title' => '', 'example' => 'workspace-test'], + 'modifyTime' => ['description' => 'The time when the event escalation was last modified.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'gmtModified', 'title' => '', 'example' => '2025-03-11T08:21:58Z'], 'stage' => [ - 'description' => 'Phase.', + 'description' => 'The stages.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'Event Escalation Phase Structure.', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/IncidentEscalationStageStruct', - ], + 'items' => ['description' => 'The event escalation stage struct.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/IncidentEscalationStageStruct', 'title' => '', 'example' => ''], 'backendName' => 'stageList', + 'title' => '', + 'example' => '', ], - 'createTime' => [ - 'description' => 'Creation time.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2025-03-11T08:21:58Z', - 'backendName' => 'gmtCreate', - ], - 'regionId' => [ - 'description' => 'Region ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn-hangzhou', - 'backendName' => 'regionId', - ], - 'name' => [ - 'description' => 'Name.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Production Environment Alert Escalation Policy.'."\n", - 'backendName' => 'name', - ], - 'description' => [ - 'description' => 'Description.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'When an alert is not acknowledged, notify the operations team, on-duty manager, and CTO sequentially.'."\n", - 'backendName' => 'description', - ], + 'createTime' => ['description' => 'The time when the event escalation was created.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'gmtCreate', 'title' => '', 'example' => '2025-03-11T08:21:58Z'], + 'regionId' => ['description' => 'The region ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'regionId', 'title' => '', 'example' => 'cn-hangzhou'], + 'name' => ['description' => 'The name.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'title' => '', 'example' => '生产环境告警升级策略'], + 'description' => ['description' => 'The description.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'title' => '', 'example' => '当告警未响应时，依次通知运维团队、值班经理、CTO'], ], + 'title' => '', + 'example' => '', ], 'IncidentEventForView' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'incidentUuid' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"a1b2c3d4-e5f6-7890-1234-567890abcdef"', - 'backendName' => 'incidentUuid', - ], - 'userId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"user-abc123"', - 'backendName' => 'userId', - ], - 'time' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1743876000000', - 'backendName' => 'time', - ], - 'incidentEventUuid' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"x1y2z3a4-b5c6-d7e8-f9g0-h1i2j3k4l5m6"', - 'backendName' => 'incidentEventUuid', - ], - 'title' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'title', - ], - 'workspace' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"ws-xyz789"', - 'backendName' => 'workspace', - ], - 'dimension' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{ "env": "prod", "module": "payment" }', - 'backendName' => 'dimension', - ], - 'labels' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{ "project": "payment-gateway", "owner": "ops-team" }', - 'backendName' => 'labels', - ], - 'groupBy' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{ "resourceId": "i-bp123456", "severity": "Critical" }', - 'backendName' => 'groupBy', - ], - 'eventResource' => [ - 'description' => '', - 'visibility' => 'Public', - 'backendName' => 'eventResource', - '$ref' => '#/components/schemas/EventResourceForIncidentView', - ], - 'content' => [ - 'description' => '', - 'visibility' => 'Public', - 'backendName' => 'content', - '$ref' => '#/components/schemas/CmsEventForView', - ], - 'severity' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"Critical"', - 'backendName' => 'severity', - ], - 'count' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'backendName' => 'count', - ], - 'severityCountMap' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{ "Critical": 2, "High": 1 }', - 'backendName' => 'severityCountMap', - ], - 'lastTime' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1743876000000', - 'backendName' => 'lastTime', - ], - 'recoverTime' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1743876600000', - 'backendName' => 'recoverTime', - ], - 'autoRecoverTime' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1743876600000', - 'backendName' => 'autoRecoverTime', - ], - 'state' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'state', - ], + 'incidentUuid' => ['description' => 'The unique ID of the incident to which the event belongs.', 'type' => 'string', 'title' => '', 'example' => '"a1b2c3d4-e5f6-7890-1234-567890abcdef"'], + 'userId' => ['description' => 'The ID of the user who created or triggered the event.', 'type' => 'string', 'title' => '', 'example' => '"user-abc123"'], + 'time' => ['description' => 'The UNIX timestamp when the event occurred.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1743876000000'], + 'incidentEventUuid' => ['description' => 'The unique ID of the event.', 'type' => 'string', 'title' => '', 'example' => '"x1y2z3a4-b5c6-d7e8-f9g0-h1i2j3k4l5m6"'], + 'title' => ['description' => 'The title of the event.', 'type' => 'string', 'title' => '', 'example' => '"ECS 实例 i-bp123456 CPU 使用率超过 90%"'], + 'workspace' => ['description' => 'The name of the workspace.', 'type' => 'string', 'title' => '', 'example' => '"ws-xyz789"'], + 'dimension' => ['description' => 'The dimension information of the event.', 'type' => 'object', 'title' => '', 'example' => '{ "env": "prod", "module": "payment" }'], + 'labels' => ['description' => 'The key-value pairs of custom tags.', 'type' => 'object', 'title' => '', 'example' => '{ "project": "payment-gateway", "owner": "ops-team" }'], + 'groupBy' => ['description' => 'The criteria for grouping.', 'type' => 'object', 'title' => '', 'example' => '{ "resourceId": "i-bp123456", "severity": "Critical" }'], + 'eventResource' => ['description' => 'The information about the associated resource.', '$ref' => '#/components/schemas/EventResourceForIncidentView', 'title' => '', 'example' => ''], + 'content' => ['description' => 'The details of the event.', '$ref' => '#/components/schemas/CmsEventForView', 'title' => '', 'example' => ''], + 'severity' => ['description' => 'The severity level of the event.', 'type' => 'string', 'title' => '', 'example' => '"Critical"'], + 'count' => ['description' => 'The number of times the event was triggered.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3'], + 'severityCountMap' => ['description' => 'The statistics on the number of events for each severity level.', 'type' => 'object', 'title' => '', 'example' => '{ "Critical": 2, "High": 1 }'], + 'lastTime' => ['description' => 'The UNIX timestamp of the last occurrence.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1743876000000'], + 'recoverTime' => ['description' => 'The UNIX timestamp of the recovery.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1743876600000'], + 'autoRecoverTime' => ['description' => 'The UNIX timestamp of the automatic recovery.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1743876600000'], + 'state' => ['description' => 'The current status code of the event.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'searchIndex' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '["ECS", "CPU", "high"]', - 'extendType' => 'true', - ], - 'backendName' => 'searchIndex', - ], - 'textIndex' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', + 'items' => ['description' => 'The search index field.', 'type' => 'string', 'title' => '', 'example' => '["ECS", "CPU", "high"]'], + 'description' => 'The list of search index fields.', + 'title' => '', 'example' => '', - 'backendName' => 'textIndex', ], + 'textIndex' => ['description' => 'The text index field.', 'type' => 'string', 'title' => '', 'example' => '"ECS 实例 CPU 使用率过高"'], ], + 'description' => 'The event object.', + 'title' => '', + 'example' => '', ], 'IncidentEventStruct' => [ - 'description' => 'Event structure.', + 'description' => 'The structure of an incident event.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'lastTime' => [ - 'description' => 'Last time.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1741234567890', - 'backendName' => 'lastTime', - ], - 'recoverTime' => [ - 'description' => 'Manual recovery time.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1741234567890', - 'backendName' => 'recoverTime', - ], - 'autoRecoverTime' => [ - 'description' => 'Automatic recovery time.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1741234567890', - 'backendName' => 'autoRecoverTime', - ], + 'lastTime' => ['description' => 'The time of the last occurrence.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'lastTime', 'title' => '', 'example' => '1741234567890'], + 'recoverTime' => ['description' => 'The time of manual recovery.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'recoverTime', 'title' => '', 'example' => '1741234567890'], + 'autoRecoverTime' => ['description' => 'The time of automatic recovery.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'autoRecoverTime', 'title' => '', 'example' => '1741234567890'], 'resource' => [ - 'description' => 'Describes the resource information associated with the event.', + 'description' => 'The resource associated with the event.', 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'map', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'map', - ], + 'additionalProperties' => ['description' => 'A map.', 'visibility' => 'Public', 'type' => 'string', 'title' => '', 'example' => 'map'], 'backendName' => 'resource', + 'title' => '', + 'example' => '', ], - 'count' => [ - 'description' => 'Count.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - 'backendName' => 'count', - ], + 'count' => ['description' => 'The total count.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'count', 'title' => '', 'example' => '6'], 'groupBy' => [ - 'description' => 'Used for grouping dimensions.', + 'description' => 'The dimension for grouping.', 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'map', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'map', - ], + 'additionalProperties' => ['description' => 'A map.', 'visibility' => 'Public', 'type' => 'string', 'title' => '', 'example' => 'map'], 'backendName' => 'groupBy', + 'title' => '', + 'example' => '', ], - 'title' => [ - 'description' => 'Title.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'User service CPU usage is too high.'."\n", - 'backendName' => 'title', - ], - 'userId' => [ - 'description' => 'User ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'user-12345', - 'backendName' => 'userId', - ], - 'content' => [ - 'description' => 'Content.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Detected that the CPU usage of the user-service instance i-abc123 has reached 95%, triggering an alert.'."\n", - 'backendName' => 'content', - ], - 'time' => [ - 'description' => 'Time.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58Z', - 'backendName' => 'time', - ], - 'incidentId' => [ - 'description' => 'Incident Id.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'incident-001', - 'backendName' => 'incidentId', - ], - 'incidentEventId' => [ - 'description' => 'Incident Event Id.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'event-001', - 'backendName' => 'incidentEventUuid', - ], + 'title' => ['description' => 'The title.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'title', 'title' => '', 'example' => '用户服务 CPU 使用率过高'], + 'userId' => ['description' => 'The user ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'userId', 'title' => '', 'example' => 'user-12345'], + 'content' => ['description' => 'The content.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'content', 'title' => '', 'example' => '检测到 user-service 实例 i-abc123 的 CPU 使用率达到 95%，已触发告警。'], + 'time' => ['description' => 'The time.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'time', 'title' => '', 'example' => '2025-03-11T08:21:58Z'], + 'incidentId' => ['description' => 'The incident ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'incidentId', 'title' => '', 'example' => 'incident-001'], + 'incidentEventId' => ['description' => 'The incident event ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'incidentEventUuid', 'title' => '', 'example' => 'event-001'], 'dimension' => [ - 'description' => 'Dimension.', + 'description' => 'The dimension.', 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'map', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'map', - ], + 'additionalProperties' => ['description' => 'A map.', 'visibility' => 'Public', 'type' => 'string', 'title' => '', 'example' => 'map'], 'backendName' => 'dimension', + 'title' => '', + 'example' => '', ], - 'status' => [ - 'description' => 'Status.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'Running', - 'backendName' => 'status', - ], + 'status' => ['description' => 'The status.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'status', 'title' => '', 'example' => 'Running'], ], + 'title' => '', + 'example' => '', ], 'IncidentForView' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'content' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'content', - ], - 'incidentId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"incident-abc123"', - 'backendName' => 'incidentUuid', - ], - 'plan' => [ - 'description' => '', - 'visibility' => 'Public', - 'backendName' => 'plan', - '$ref' => '#/components/schemas/IncidentResponsePlanForView', - ], - 'severity' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"Critical"', - 'backendName' => 'severity', - ], - 'time' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1743876000000', - 'backendName' => 'time', - ], - 'title' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'title', - ], - 'userId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"user-abc123"', - 'backendName' => 'userId', - ], - 'workspace' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"ws-xyz789"', - 'backendName' => 'workspace', - ], - 'groupUuid' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"group-123456"', - 'backendName' => 'groupUuid', - ], - 'state' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"Open"', - 'backendName' => 'state', - ], - 'notifyStrategyUuid' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"notify-strategy-789"', - 'backendName' => 'notifyStrategyUuid', - ], - 'subscriptionUuid' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"subscription-abc"', - 'backendName' => 'subscriptionUuid', - ], - 'operator' => [ - 'description' => '', - 'visibility' => 'Public', - 'backendName' => 'operator', - '$ref' => '#/components/schemas/ContactForIncidentView', - ], - 'notifyStrategyName' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'notifyStrategyName', - ], - 'subscriptionName' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"P1-Alert-Notification"', - 'backendName' => 'subscriptionName', - ], + 'content' => ['description' => 'The details of the incident.', 'type' => 'string', 'title' => '', 'example' => '"{"description":"ECS实例CPU过高","impact":"支付服务延迟"}"'], + 'incidentId' => ['description' => 'The unique identifier of the incident.', 'type' => 'string', 'title' => '', 'example' => '"incident-abc123"'], + 'plan' => ['description' => 'The response plan.', '$ref' => '#/components/schemas/IncidentResponsePlanForView', 'title' => '', 'example' => ''], + 'severity' => ['description' => 'The severity level of the incident.', 'type' => 'string', 'title' => '', 'example' => '"Critical"'], + 'time' => ['description' => 'The timestamp when the incident was created.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1743876000000'], + 'title' => ['description' => 'The title of the incident.', 'type' => 'string', 'title' => '', 'example' => '"支付服务不可用"'], + 'userId' => ['description' => 'The ID of the user who created the incident.', 'type' => 'string', 'title' => '', 'example' => '"user-abc123"'], + 'workspace' => ['description' => 'The name of the workspace.', 'type' => 'string', 'title' => '', 'example' => '"ws-xyz789"'], + 'groupUuid' => ['description' => 'The group identifier.', 'type' => 'string', 'title' => '', 'example' => '"group-123456"'], + 'state' => ['description' => 'The current state of the incident.', 'type' => 'string', 'title' => '', 'example' => '"Open"'], + 'notifyStrategyUuid' => ['description' => 'The UUID of the associated notification policy, which is used to trigger notifications.', 'type' => 'string', 'title' => '', 'example' => '"notify-strategy-789"'], + 'subscriptionUuid' => ['description' => 'The UUID of the subscription policy.', 'type' => 'string', 'title' => '', 'example' => '"subscription-abc"'], + 'operator' => ['description' => 'The information about the operator.', '$ref' => '#/components/schemas/ContactForIncidentView', 'title' => '', 'example' => ''], + 'notifyStrategyName' => ['description' => 'The name of the notification policy.', 'type' => 'string', 'title' => '', 'example' => '{ "contactId": "contact-123", "name": "张三" }'], + 'subscriptionName' => ['description' => 'The name of the subscription policy.', 'type' => 'string', 'title' => '', 'example' => '"P1-Alert-Notification"'], 'escalations' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/IncidentEscalationPolicyForView', - ], - 'backendName' => 'escalations', + 'items' => ['description' => 'The escalation policy.', '$ref' => '#/components/schemas/IncidentEscalationPolicyForView', 'title' => '', 'example' => ''], + 'description' => 'The list of escalation policies.', + 'title' => '', + 'example' => '', ], 'owners' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/ContactForIncidentView', - ], - 'backendName' => 'owners', + 'items' => ['description' => 'The owner.', '$ref' => '#/components/schemas/ContactForIncidentView', 'title' => '', 'example' => ''], + 'description' => 'The list of owners.', + 'title' => '', + 'example' => '', ], 'participants' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/ContactForIncidentView', - ], - 'backendName' => 'participants', + 'items' => ['description' => 'The participant.', '$ref' => '#/components/schemas/ContactForIncidentView', 'title' => '', 'example' => ''], + 'description' => 'The list of participants.', + 'title' => '', + 'example' => '', ], 'groupingKeys' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{ "resourceId": "i-bp123456", "severity": "Critical" }', - ], - 'backendName' => 'groupingKeys', + 'additionalProperties' => ['description' => 'The key-value pairs for grouping.', 'type' => 'string', 'title' => '', 'example' => '{ "resourceId": "i-bp123456", "severity": "Critical" }'], + 'description' => 'The key-value pairs for grouping.', + 'title' => '', + 'example' => '', ], 'relatedResources' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/EventResourceForIncidentView', - ], - 'backendName' => 'relatedResources', - ], - 'solution' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', + 'items' => ['description' => 'The associated resource.', '$ref' => '#/components/schemas/EventResourceForIncidentView', 'title' => '', 'example' => ''], + 'description' => 'The list of associated resources.', + 'title' => '', 'example' => '', - 'backendName' => 'solution', - ], - 'rootCauseCategory' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"Network"', - 'backendName' => 'rootCauseCategory', ], + 'solution' => ['description' => 'The description of the solution.', 'type' => 'string', 'title' => '', 'example' => '"重启ECS实例后恢复正常"'], + 'rootCauseCategory' => ['description' => 'The root cause category.', 'type' => 'string', 'title' => '', 'example' => '"Network"'], ], + 'description' => 'The incident object.', + 'title' => '', + 'example' => '', ], 'IncidentMemberStruct' => [ - 'description' => 'Event Member Structure.', + 'description' => 'The structure of an event member.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'acknowledge' => [ - 'description' => 'Acknowledgement Information Structure.', + 'description' => 'The structure of the confirmation information.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'breakLevel' => [ - 'description' => 'Acknowledgement level.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2', - 'backendName' => 'breakLevel', - ], - 'verifyTime' => [ - 'description' => 'Verification time.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1741234567890', - 'backendName' => 'verifyTime', - ], + 'breakLevel' => ['description' => 'The confirmation level.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'breakLevel', 'title' => '', 'example' => '2'], + 'verifyTime' => ['description' => 'The verification time.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'verifyTime', 'title' => '', 'example' => '1741234567890'], ], 'backendName' => 'acknowledge', + 'title' => '', + 'example' => '', ], - 'incidentMemberId' => [ - 'description' => 'Event Member ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'member-001', - 'backendName' => 'incidentItemToken', - ], - 'contactId' => [ - 'description' => 'Contact ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'user-12345', - 'backendName' => 'contactId', - ], + 'incidentMemberId' => ['description' => 'The ID of the event member.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'incidentItemToken', 'title' => '', 'example' => 'member-001'], + 'contactId' => ['description' => 'The ID of the contact.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'contactId', 'title' => '', 'example' => 'user-12345'], 'escalation' => [ - 'description' => 'Escalation phase information.', + 'description' => 'Information about the escalation stage.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'stageIndex' => [ - 'description' => 'Escalation phase index.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1', - 'backendName' => 'stageIndex', - ], - 'incidentEscalationId' => [ - 'description' => 'Event Escalation ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'escalation-001', - 'backendName' => 'escalationId', - ], - 'name' => [ - 'description' => 'Name.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Phase one.'."\n", - 'backendName' => 'name', - ], - 'description' => [ - 'description' => 'Description.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Notify the operations team.'."\n", - 'backendName' => 'description', - ], - 'title' => [ - 'description' => 'Title.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Alert escalated to the operations team.'."\n", - 'backendName' => 'title', - ], + 'stageIndex' => ['description' => 'The index of the escalation stage.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'stageIndex', 'title' => '', 'example' => '1'], + 'incidentEscalationId' => ['description' => 'The ID of the event escalation.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'escalationId', 'title' => '', 'example' => 'escalation-001'], + 'name' => ['description' => 'The name.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'title' => '', 'example' => '第一阶段'], + 'description' => ['description' => 'The description.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'title' => '', 'example' => '通知运维团队'], + 'title' => ['description' => 'The title.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'title', 'title' => '', 'example' => '告警升级至运维团队'], ], 'backendName' => 'escalation', + 'title' => '', + 'example' => '', ], 'scheduleGroup' => [ - 'description' => 'Schedule group.', + 'description' => 'The scheduling group.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'contactId' => [ - 'description' => 'Contact ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'group-001', - 'backendName' => 'contactId', - ], - 'name' => [ - 'description' => 'Name.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Night shift duty team.'."\n", - 'backendName' => 'name', - ], + 'contactId' => ['description' => 'The ID of the contact.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'contactId', 'title' => '', 'example' => 'group-001'], + 'name' => ['description' => 'The name.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'title' => '', 'example' => '夜间值班组'], ], 'backendName' => 'schedule', + 'title' => '', + 'example' => '', ], - 'time' => [ - 'description' => 'Time.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2025-10-08 10:18:58', - 'backendName' => 'time', - ], - 'incidentId' => [ - 'description' => 'Incident ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'incident-001', - 'backendName' => 'incidentUuid', - ], - 'userId' => [ - 'description' => 'User ID.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4123456', - 'backendName' => 'userId', - ], + 'time' => ['description' => 'The time.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'time', 'title' => '', 'example' => '2025-10-08 10:18:58'], + 'incidentId' => ['description' => 'The ID of the event.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'incidentUuid', 'title' => '', 'example' => 'incident-001'], + 'userId' => ['description' => 'The user ID.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'userId', 'title' => '', 'example' => '4123456'], 'contacts' => [ - 'description' => 'Contact list.', + 'description' => 'A list of contacts.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ - 'description' => 'Contact details.', + 'description' => 'The details of a contact.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'contactMask' => [ - 'description' => 'Contact ID (masked).', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'user-12345', - 'backendName' => 'contactMask', - ], - 'channel' => [ - 'description' => 'Channel.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'dingtalk', - 'backendName' => 'channel', - ], + 'contactMask' => ['description' => 'The masked ID of the contact.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'contactMask', 'title' => '', 'example' => 'user-12345'], + 'channel' => ['description' => 'The channel.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'channel', 'title' => '', 'example' => 'dingtalk'], ], 'extendType' => 'true', + 'title' => '', + 'example' => '', ], 'backendName' => 'contacts', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], 'IncidentNoteStruct' => [ - 'description' => 'Event record structure.', + 'description' => 'The structure of the event record.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'format' => [ - 'description' => 'Content format.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'markdown', - 'backendName' => 'format', - ], - 'noteId' => [ - 'description' => 'Note ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'note-001', - 'backendName' => 'noteId', - ], - 'time' => [ - 'description' => 'Time.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1741234567890', - 'backendName' => 'time', - ], - 'incidentId' => [ - 'description' => 'Incident ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'incident-001', - 'backendName' => 'incidentUuid', - ], - 'type' => [ - 'description' => 'Type.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'apm', - 'backendName' => 'type', - ], - 'content' => [ - 'description' => 'Content.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'The operations team has been contacted and is currently investigating the issue.'."\n", - 'backendName' => 'content', - ], + 'format' => ['description' => 'The content format.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'format', 'title' => '', 'example' => 'markdown'], + 'noteId' => ['description' => 'The record ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'noteId', 'title' => '', 'example' => 'note-001'], + 'time' => ['description' => 'The time.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'time', 'title' => '', 'example' => '1741234567890'], + 'incidentId' => ['description' => 'The event ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'incidentUuid', 'title' => '', 'example' => 'incident-001'], + 'type' => ['description' => 'The type.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'type', 'title' => '', 'example' => 'apm'], + 'content' => ['description' => 'The content.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'content', 'title' => '', 'example' => '已联系运维团队，正在排查问题。'], 'operator' => [ - 'description' => 'Operator.', + 'description' => 'The operator.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'contactId' => [ - 'description' => 'Contact ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'user-12345', - 'backendName' => 'contactId', - ], - 'contact' => [ - 'description' => 'Contact.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{\\"mobile_phone_num\\":\\"153xxxx8040\\",\\"mobile_country_code\\":\\"86\\",\\"email\\":\\"flightxxg@dida.com\\"}', - 'backendName' => 'contact', - ], - 'name' => [ - 'description' => 'Name.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Zhang San.'."\n", - 'backendName' => 'name', - ], - 'userId' => [ - 'description' => 'User ID.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4123456', - 'backendName' => 'userId', - ], + 'contactId' => ['description' => 'The contact ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'contactId', 'title' => '', 'example' => 'user-12345'], + 'contact' => ['description' => 'The contact.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'contact', 'title' => '', 'example' => '{\\"mobile_phone_num\\":\\"153xxxx8040\\",\\"mobile_country_code\\":\\"86\\",\\"email\\":\\"flightxxg@dida.com\\"}'], + 'name' => ['description' => 'The name.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'title' => '', 'example' => '张三'], + 'userId' => ['description' => 'The user ID.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'userId', 'title' => '', 'example' => '4123456'], ], 'backendName' => 'opera', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], 'IncidentPlanCorporationStruct' => [ - 'description' => 'Event contingency collaboration structure.', - 'visibility' => 'Public', + 'description' => 'The incident plan collaboration structure.', 'type' => 'object', 'properties' => [ - 'channel' => [ - 'description' => 'Channel name.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ecs', - 'backendName' => 'channel', - ], - 'robotId' => [ - 'description' => 'Robot ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'robotId-cs-api-test', - 'backendName' => 'robotId', - ], + 'channel' => ['description' => 'The channel name.', 'type' => 'string', 'title' => '', 'example' => 'ecs', 'visibility' => 'Public', 'backendName' => 'channel'], + 'robotId' => ['description' => 'The unique ID of the robot.', 'type' => 'string', 'title' => '', 'example' => 'robotId-cs-api-test', 'visibility' => 'Public', 'backendName' => 'robotId'], ], + 'title' => '', + 'example' => '', + 'visibility' => 'Public', ], 'IncidentPlanFieldPath' => [ - 'description' => 'A structure used to define field mapping paths in an event contingency plan.', - 'visibility' => 'Public', + 'description' => 'A struct that defines the field mapping path for an incident plan.', 'type' => 'object', 'properties' => [ - 'fieldAlias' => [ - 'description' => 'Field alias.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Service name.'."\n", - 'backendName' => 'alias', - ], + 'fieldAlias' => ['description' => 'The field alias.', 'type' => 'string', 'title' => '', 'example' => '服务名称', 'visibility' => 'Public', 'backendName' => 'alias'], 'fieldPath' => [ - 'description' => 'List of field paths.', - 'visibility' => 'Public', + 'description' => 'A list of field paths.', 'type' => 'array', - 'items' => [ - 'description' => 'Field path.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'service.name', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The field path.', 'type' => 'string', 'title' => '', 'example' => 'service.name', 'visibility' => 'Public', 'extendType' => 'true'], + 'title' => '', + 'example' => '', + 'visibility' => 'Public', 'backendName' => 'name', ], ], + 'title' => '', + 'example' => '', + 'visibility' => 'Public', ], 'IncidentPlanStruct' => [ - 'description' => 'Event contingency plan structure.', + 'description' => 'The incident plan struct.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'escalationId' => [ - 'description' => 'List of escalation policy IDs.', + 'description' => 'A list of escalation policy IDs.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'Escalation policy ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'escalation-001', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The escalation policy ID.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'escalation-001'], 'backendName' => 'escalationId', + 'title' => '', + 'example' => '', ], - 'gmtModified' => [ - 'description' => 'Last modification time.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1741234567890', - 'backendName' => 'gmtModified', - ], - 'workspace' => [ - 'description' => 'Workspace name.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'workspace-test', - 'backendName' => 'workspace', - ], + 'gmtModified' => ['description' => 'The time when the plan was last modified.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'gmtModified', 'title' => '', 'example' => '1741234567890'], + 'workspace' => ['description' => 'The name of the workspace.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'workspace', 'title' => '', 'example' => 'workspace-test'], 'resourceFiled' => [ - 'description' => 'List of resource field mapping paths.', + 'description' => 'A list of resource field mapping paths.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'Resource field mapping path.', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/IncidentPlanFieldPath', - ], + 'items' => ['description' => 'The resource field mapping path.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/IncidentPlanFieldPath', 'title' => '', 'example' => ''], 'backendName' => 'resourceField', + 'title' => '', + 'example' => '', ], 'corporation' => [ - 'description' => 'List of teams or roles involved in collaboration.', + 'description' => 'A list of collaborating teams or roles.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'Event contingency plan structure.', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/IncidentPlanCorporationStruct', - ], + 'items' => ['description' => 'The incident plan struct.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/IncidentPlanCorporationStruct', 'title' => '', 'example' => ''], 'backendName' => 'corporation', + 'title' => '', + 'example' => '', ], - 'description' => [ - 'description' => 'Contingency plan description.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Emergency response plan for excessively high database connection count.'."\n", - 'backendName' => 'description', - ], - 'autoRecoverSeconds' => [ - 'description' => 'Automatic recovery wait time.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3600', - 'backendName' => 'autoRecoverSeconds', - ], + 'description' => ['description' => 'The description of the plan.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'title' => '', 'example' => '针对数据库连接数过高的应急处理方案'], + 'autoRecoverSeconds' => ['description' => 'The wait time for automatic recovery.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'autoRecoverSeconds', 'title' => '', 'example' => '3600'], 'groupBy' => [ - 'description' => 'Grouping field path.', + 'description' => 'The grouping field path.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'Structure for field mapping paths in the event contingency plan.', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/IncidentPlanFieldPath', - ], + 'items' => ['description' => 'The struct for the field mapping path in the incident plan.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/IncidentPlanFieldPath', 'title' => '', 'example' => ''], 'backendName' => 'groupBy', + 'title' => '', + 'example' => '', ], - 'gmtCreate' => [ - 'description' => 'Creation time.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1741234567890', - 'backendName' => 'gmtCreate', - ], - 'userId' => [ - 'description' => 'User ID.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'uesr-12345', - 'backendName' => 'userId', - ], - 'closeExpire' => [ - 'description' => 'Event closure timeout.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '86400000', - 'backendName' => 'closeExpire', - ], - 'name' => [ - 'description' => 'Contingency plan name.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Database connection count alert contingency plan.'."\n", - 'backendName' => 'name', - ], - 'incidentPlanId' => [ - 'description' => 'Event contingency plan ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'plan-001', - 'backendName' => 'uuid', - ], - 'status' => [ - 'description' => 'Status.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Running', - 'backendName' => 'status', - ], + 'gmtCreate' => ['description' => 'The time when the plan was created.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'gmtCreate', 'title' => '', 'example' => '1741234567890'], + 'userId' => ['description' => 'The user ID.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'userId', 'title' => '', 'example' => 'uesr-12345'], + 'closeExpire' => ['description' => 'The timeout period for closing an event.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'closeExpire', 'title' => '', 'example' => '86400000'], + 'name' => ['description' => 'The name of the plan.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'title' => '', 'example' => '数据库连接数告警预案'], + 'incidentPlanId' => ['description' => 'The incident plan ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'uuid', 'title' => '', 'example' => 'plan-001'], + 'status' => ['description' => 'The status.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'status', 'title' => '', 'example' => 'Running'], ], + 'title' => '', + 'example' => '', ], 'IncidentResourceDetail' => [ - 'description' => 'A structure used to describe the details of resources associated with an event.', - 'visibility' => 'Public', + 'description' => 'A struct that describes the details of a resource linked to an event.', 'type' => 'object', 'properties' => [ - 'resourceId' => [ - 'description' => 'Resource ID object.', - 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{ "type": "ecs", "id": "i-bp1234567890abcdef" }', - 'backendName' => 'resourceId', - ], - 'extraId' => [ - 'description' => 'Additional resource identifier.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'app-prod-web-01', - 'backendName' => 'extraId', - ], - 'type' => [ - 'description' => 'Resource type, indicating which cloud product the resource belongs to.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ecs', - 'backendName' => 'type', - ], + 'resourceId' => ['description' => 'The resource ID object.', 'type' => 'object', 'title' => '', 'example' => '{ "type": "ecs", "id": "i-bp1234567890abcdef" }', 'visibility' => 'Public', 'backendName' => 'resourceId'], + 'extraId' => ['description' => 'An additional resource identifier.', 'type' => 'string', 'title' => '', 'example' => 'app-prod-web-01', 'visibility' => 'Public', 'backendName' => 'extraId'], + 'type' => ['description' => 'The resource type. This indicates the cloud product to which the resource belongs.', 'type' => 'string', 'title' => '', 'example' => 'ecs', 'visibility' => 'Public', 'backendName' => 'type'], ], + 'title' => '', + 'example' => '', + 'visibility' => 'Public', ], 'IncidentResourceStruct' => [ - 'description' => 'A structure used to describe resources associated with an event.', + 'description' => 'A struct that describes the linked instance of an event.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'resource' => [ - 'description' => 'Event resource details object.', - 'visibility' => 'Public', - 'backendName' => 'resource', - '$ref' => '#/components/schemas/IncidentResourceDetail', - ], - 'description' => [ - 'description' => 'Description information.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Production environment web server.'."\n", - 'backendName' => 'description', - ], - 'incidentResourceId' => [ - 'description' => 'The unique ID of this resource in the event.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'res-001', - 'backendName' => 'incidentItemToken', - ], - 'source' => [ - 'description' => 'Source.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cloudmonitor', - 'backendName' => 'source', - ], - 'time' => [ - 'description' => 'Time.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1741234567890', - 'backendName' => 'time', - ], - 'incidentId' => [ - 'description' => 'Incident ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'incident-001', - 'backendName' => 'incidentUuid', - ], - 'userId' => [ - 'description' => 'User ID.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'user-12345', - 'backendName' => 'userId', - ], + 'resource' => ['description' => 'The details object for the event resource.', 'visibility' => 'Public', 'backendName' => 'resource', '$ref' => '#/components/schemas/IncidentResourceDetail', 'title' => '', 'example' => ''], + 'description' => ['description' => 'The description.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'title' => '', 'example' => '生产环境 Web 服务器'], + 'incidentResourceId' => ['description' => 'The unique ID of the resource in the event.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'incidentItemToken', 'title' => '', 'example' => 'res-001'], + 'source' => ['description' => 'The source.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'source', 'title' => '', 'example' => 'cloudmonitor'], + 'time' => ['description' => 'The timestamp.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'time', 'title' => '', 'example' => '1741234567890'], + 'incidentId' => ['description' => 'The event ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'incidentUuid', 'title' => '', 'example' => 'incident-001'], + 'userId' => ['description' => 'The user ID.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'userId', 'title' => '', 'example' => 'user-12345'], ], + 'title' => '', + 'example' => '', ], - 'IncidentResponsePlanForView' => [ - 'description' => '', - 'visibility' => 'Public', + 'IncidentResponsePlanForModify' => [ + 'title' => 'Incident 响应计划修改入参', + 'description' => 'The payload to create or update an incident management response plan. The fields are the same as in `IncidentResponsePlanForView`, excluding read-only fields such as `createTime`, `updateTime`, and `workspace`.', 'type' => 'object', 'properties' => [ - 'type' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"Standard"', - 'backendName' => 'type', - ], - 'source' => [ + 'uuid' => ['title' => '响应计划 uuid', 'description' => 'Required for update operations. Optional for create operations; if omitted, the backend generates one. `NotifyStrategy` also uses this UUID.', 'type' => 'string', 'example' => ''], + 'name' => ['title' => '名称', 'type' => 'string', 'description' => '', 'example' => ''], + 'description' => ['title' => '描述', 'type' => 'string', 'description' => '', 'example' => ''], + 'enabled' => ['title' => '是否启用', 'type' => 'boolean', 'description' => '', 'example' => ''], + 'type' => ['title' => '类型', 'type' => 'string', 'description' => '', 'example' => ''], + 'source' => ['title' => '来源', 'type' => 'string', 'description' => '', 'example' => ''], + 'mode' => ['title' => '生命周期模式', 'type' => 'string', 'description' => '', 'example' => ''], + 'syncFromType' => ['title' => '同步来源类型', 'type' => 'string', 'description' => '', 'example' => ''], + 'autoRecoverSeconds' => ['title' => '无事件自动恢复时间（秒）', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int64'], + 'escalationId' => [ + 'title' => '升级规划 ID 列表', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"MANUAL"', - 'backendName' => 'source', + 'example' => '', ], + 'repeatNotifySetting' => ['title' => '重复通知配置', 'description' => '', 'example' => '', '$ref' => '#/components/schemas/RepeatNotifySetting'], + 'pushingSetting' => ['title' => '推送设置', 'description' => '', 'example' => '', '$ref' => '#/components/schemas/PushingSetting'], + ], + 'example' => '', + ], + 'IncidentResponsePlanForSNSModify' => [ + 'title' => 'SNS 内嵌的响应计划入参', + 'description' => 'The input parameters for the `responsePlan` sub-entity of the `SubscriptionAndNotifyStrategy` aggregation API. The following read-only backend fields are not exposed: `uuid`, `name`, `type`, `source`, `mode`, `syncFromType`, and `enabled`.'."\n" + ."\n" + .'- The `uuid` is the same as the `snsUuid` of `notifyStrategy`.'."\n" + ."\n" + .'- The `type` is set to `NOTIFY_STRATEGY_DEFINED`, and the `source` is set to `CUSTOM`.'."\n" + ."\n" + .'- The `mode` is set to `BundleStrategy`, and the `syncFromType` is set to `OBS`.', + 'type' => 'object', + 'properties' => [ 'escalationId' => [ - 'description' => '', - 'visibility' => 'Public', + 'title' => '升级规划 id 列表', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"escalation-123"', - 'extendType' => 'true', - ], - 'backendName' => 'escalationId', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => 'The IDs of the escalation policies.', + 'example' => '', ], 'repeatNotifySetting' => [ - 'description' => '', - 'visibility' => 'Public', - 'backendName' => 'repeatNotifySetting', - '$ref' => '#/components/schemas/RepeatNotifySetting', - ], - 'mode' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"Manual"', - 'backendName' => 'mode', - ], - 'autoRecoverSeconds' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '300', - 'backendName' => 'autoRecoverSeconds', - ], - 'syncFromType' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"ARMS"', - 'backendName' => 'syncFromType', + 'title' => '重复通知配置', + 'type' => 'object', + 'properties' => [ + 'endIncidentState' => ['description' => 'The incident state that stops repeat notifications.', 'type' => 'string', 'title' => '', 'example' => ''], + 'repeatInterval' => ['description' => 'The repeat interval for notifications, in seconds.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + ], + 'description' => 'The repeat notification setting.', + 'example' => '', ], + 'autoRecoverSeconds' => ['title' => '自动恢复秒数（无事件持续时长）', 'description' => 'The auto recovery time, in seconds. After this period, the incident is automatically resolved.', 'type' => 'integer', 'example' => '', 'format' => 'int64'], 'pushingSetting' => [ - 'description' => '', - 'visibility' => 'Public', - 'backendName' => 'pushingSetting', - '$ref' => '#/components/schemas/PushingSetting', - ], - 'name' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"P1-Critical-Response-Plan"', - 'backendName' => 'name', - ], - 'uuid' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"a1b2c3d4-e5f6-7890-1234-567890abcdef"', - 'backendName' => 'uuid', - ], - 'workspace' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"ws-xyz789"', - 'backendName' => 'workspace', - ], - 'description' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', + 'title' => '推送设置', + 'type' => 'object', + 'properties' => [ + 'templateUuid' => ['description' => 'The UUID of the notification template.', 'type' => 'string', 'title' => '', 'example' => ''], + 'alertActionIds' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => 'The IDs of the alert actions.', + 'title' => '', + 'example' => '', + ], + 'restoreActionIds' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => 'The IDs of the restore actions.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The push setting for notifications.', 'example' => '', - 'backendName' => 'description', ], - 'enabled' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'enabled', + ], + 'example' => '', + ], + 'IncidentResponsePlanForSNSView' => [ + 'title' => 'SNS 内嵌的响应计划查看视图', + 'type' => 'object', + 'properties' => [ + 'uuid' => ['title' => 'uuid（D8：= notifyStrategyUuid = SNS uuid）', 'description' => 'The unique ID of the incident response plan.', 'type' => 'string', 'example' => ''], + 'name' => ['description' => 'The name of the incident response plan.', 'type' => 'string', 'title' => '', 'example' => ''], + 'enable' => ['description' => 'Indicates if the incident response plan is enabled. Valid values: `true` and `false`.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'syncFromType' => ['description' => 'The synchronization source type.', 'type' => 'string', 'title' => '', 'example' => ''], + 'mode' => ['description' => 'The mode of the incident response plan. Valid values: `AUTO` and `MANUAL`.', 'type' => 'string', 'title' => '', 'example' => ''], + 'type' => ['title' => '响应计划类型（SNS 内必为 NOTIFY_STRATEGY_DEFINED）', 'description' => 'The type of the incident response plan.', 'type' => 'string', 'example' => ''], + 'source' => ['title' => '来源（SNS 内必为 CUSTOM）', 'description' => 'The source of the incident.', 'type' => 'string', 'example' => ''], + 'escalationId' => [ + 'title' => '升级规划 id 列表', + 'type' => 'array', + 'items' => ['description' => 'The ID of the escalation policy.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'The IDs of the escalation policies.', + 'example' => '', ], - 'createTime' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"2025-04-05T10:30:00Z"', - 'backendName' => 'createTime', + 'repeatNotifySetting' => [ + 'type' => 'object', + 'properties' => [ + 'endIncidentState' => ['description' => 'The incident state at which repeated notifications stop. For example, `resolved`.', 'type' => 'string', 'title' => '', 'example' => ''], + 'repeatInterval' => ['description' => 'The interval, in seconds, for repeated notifications.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + ], + 'description' => 'The settings for repeated notifications.', + 'title' => '', + 'example' => '', ], - 'updateTime' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"2025-04-06T09:15:00Z"', - 'backendName' => 'updateTime', + 'autoRecoverSeconds' => ['description' => 'The duration, in seconds, after which an incident without new alerts is automatically resolved.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int64'], + 'pushingSetting' => [ + 'type' => 'object', + 'properties' => [ + 'templateUuid' => ['description' => 'The ID of the notification template.', 'type' => 'string', 'title' => '', 'example' => ''], + 'alertActionIds' => [ + 'type' => 'array', + 'items' => ['description' => 'The ID of the action to run when an alert is triggered.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'The IDs of actions to run when an alert is triggered.', + 'title' => '', + 'example' => '', + ], + 'restoreActionIds' => [ + 'type' => 'array', + 'items' => ['description' => 'The ID of the action to run when the incident is resolved.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'The IDs of actions to run when the incident is resolved.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The settings for sending notifications.', + 'title' => '', + 'example' => '', ], + 'createTime' => ['description' => 'The time when the incident response plan was created, in UTC and in the `YYYY-MM-DDThh:mm:ssZ` format.', 'type' => 'string', 'title' => '', 'example' => ''], + 'updateTime' => ['description' => 'The time when the incident response plan was last updated, in UTC and in the `YYYY-MM-DDThh:mm:ssZ` format.', 'type' => 'string', 'title' => '', 'example' => ''], ], + 'description' => 'The details of the incident response plan.', + 'example' => '', + ], + 'IncidentResponsePlanForView' => [ + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'The type of the response plan.', 'type' => 'string', 'title' => '', 'example' => '"Standard"'], + 'source' => ['description' => 'The source.', 'type' => 'string', 'title' => '', 'example' => '"MANUAL"'], + 'escalationId' => [ + 'type' => 'array', + 'items' => ['description' => 'The ID of the escalation policy.', 'type' => 'string', 'title' => '', 'example' => '"escalation-123"'], + 'description' => 'A list of the IDs of associated escalation policies.', + 'title' => '', + 'example' => '', + ], + 'repeatNotifySetting' => ['description' => 'The settings for repeated notifications.', '$ref' => '#/components/schemas/RepeatNotifySetting', 'title' => '', 'example' => ''], + 'mode' => ['description' => 'The response pattern.', 'type' => 'string', 'title' => '', 'example' => '"Manual"'], + 'autoRecoverSeconds' => ['description' => 'The automatic recovery time.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '300'], + 'syncFromType' => ['description' => 'The source type of the synchronization policy.', 'type' => 'string', 'title' => '', 'example' => '"ARMS"'], + 'pushingSetting' => ['description' => 'The push notification settings.', '$ref' => '#/components/schemas/PushingSetting', 'title' => '', 'example' => ''], + 'name' => ['description' => 'The name of the response plan.', 'type' => 'string', 'title' => '', 'example' => '"P1-Critical-Response-Plan"'], + 'uuid' => ['description' => 'The globally unique identifier.', 'type' => 'string', 'title' => '', 'example' => '"a1b2c3d4-e5f6-7890-1234-567890abcdef"'], + 'workspace' => ['description' => 'The workspace.', 'type' => 'string', 'title' => '', 'example' => '"ws-xyz789"'], + 'description' => ['description' => 'The description of the response plan.', 'type' => 'string', 'title' => '', 'example' => '"针对支付服务不可用的紧急响应流程"'], + 'enabled' => ['description' => 'Indicates whether the response plan is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'createTime' => ['description' => 'The time when the plan was created.', 'type' => 'string', 'title' => '', 'example' => '"2025-04-05T10:30:00Z"'], + 'updateTime' => ['description' => 'The time when the plan was last updated.', 'type' => 'string', 'title' => '', 'example' => '"2025-04-06T09:15:00Z"'], + ], + 'description' => 'The response plan object.', + 'title' => '', + 'example' => '', ], 'IncidentStruct' => [ - 'description' => 'A core structure representing a complete incident.', + 'description' => 'The core struct that represents a complete event.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'severity' => [ - 'description' => 'Incident severity level.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'P1', - 'backendName' => 'severity', - ], + 'severity' => ['description' => 'The severity level of the event.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'severity', 'title' => '', 'example' => 'P1'], 'escalations' => [ - 'description' => 'List of escalation policies.', + 'description' => 'The list of escalation policies.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'Incident escalation structure.', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/IncidentEscalationStruct', - ], + 'items' => ['description' => 'The event escalation struct.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/IncidentEscalationStruct', 'title' => '', 'example' => ''], 'backendName' => 'escalations', + 'title' => '', + 'example' => '', ], - 'resource' => [ - 'description' => 'Associated resource details.', - 'visibility' => 'Public', - 'backendName' => 'resource', - '$ref' => '#/components/schemas/IncidentResourceDetail', - ], - 'incidentPlan' => [ - 'description' => 'Associated incident contingency plan.', - 'visibility' => 'Public', - 'backendName' => 'plan', - '$ref' => '#/components/schemas/IncidentPlanStruct', - ], - 'time' => [ - 'description' => 'Time.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1741234567890', - 'backendName' => 'time', - ], - 'incidentId' => [ - 'description' => 'Incident ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'incident-001', - 'backendName' => 'incidentUuid', - ], - 'title' => [ - 'description' => 'Title.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Excessively high database connection count.'."\n", - 'backendName' => 'title', - ], - 'userId' => [ - 'description' => 'User ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'user-12345', - 'backendName' => 'userId', - ], - 'content' => [ - 'description' => 'Content.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Detected that the connection count of RDS instance rds-bp1234567890abcdef has reached 1000, triggering an alert.'."\n", - 'backendName' => 'content', - ], - 'status' => [ - 'description' => 'Status.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'OPEN', - 'backendName' => 'status', - ], + 'resource' => ['description' => 'The details of the associated resource.', 'visibility' => 'Public', 'backendName' => 'resource', '$ref' => '#/components/schemas/IncidentResourceDetail', 'title' => '', 'example' => ''], + 'incidentPlan' => ['description' => 'The associated incident plan.', 'visibility' => 'Public', 'backendName' => 'plan', '$ref' => '#/components/schemas/IncidentPlanStruct', 'title' => '', 'example' => ''], + 'time' => ['description' => 'The timestamp.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'time', 'title' => '', 'example' => '1741234567890'], + 'incidentId' => ['description' => 'The unique ID of the event.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'incidentUuid', 'title' => '', 'example' => 'incident-001'], + 'title' => ['description' => 'The title of the event.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'title', 'title' => '', 'example' => '数据库连接数过高'], + 'userId' => ['description' => 'The user ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'userId', 'title' => '', 'example' => 'user-12345'], + 'content' => ['description' => 'The content of the event.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'content', 'title' => '', 'example' => '检测到 RDS 实例 rds-bp1234567890abcdef 的连接数达到 1000，已触发告警。'], + 'status' => ['description' => 'The current status.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'status', 'title' => '', 'example' => 'OPEN'], ], + 'title' => '', + 'example' => '', ], 'IncidentTimeline' => [ - 'description' => 'A structure used to record timeline nodes during incident handling.', + 'description' => 'A struct that represents a timeline node in the event handling process.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'childType' => [ - 'description' => 'Subtype.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'comment', - 'backendName' => 'childType', - ], - 'incidentTimelineId' => [ - 'description' => 'Timeline node unique ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'timeline-001', - 'backendName' => 'incidentItemToken', - ], - 'timelineId' => [ - 'description' => 'Parent timeline ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'timeline-main-001', - 'backendName' => 'timelineUuid', - ], - 'time' => [ - 'description' => 'Time.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1741234567890', - 'backendName' => 'time', - ], - 'incidentId' => [ - 'description' => 'Incident ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'incident-001', - 'backendName' => 'incidentUuid', - ], - 'title' => [ - 'description' => 'Title.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'The operations team has been contacted.'."\n", - 'backendName' => 'title', - ], - 'type' => [ - 'description' => 'Type.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ACTION', - 'backendName' => 'type', - ], - 'userId' => [ - 'description' => 'User ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'user-12345', - 'backendName' => 'userId', - ], - 'content' => [ - 'description' => 'Content.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'The operations team has been notified to investigate.'."\n", - 'backendName' => 'content', - ], + 'childType' => ['description' => 'The child type.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'childType', 'title' => '', 'example' => 'comment'], + 'incidentTimelineId' => ['description' => 'The unique ID of the timeline node.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'incidentItemToken', 'title' => '', 'example' => 'timeline-001'], + 'timelineId' => ['description' => 'The ID of the timeline.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'timelineUuid', 'title' => '', 'example' => 'timeline-main-001'], + 'time' => ['description' => 'The timestamp.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'time', 'title' => '', 'example' => '1741234567890'], + 'incidentId' => ['description' => 'The ID of the event.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'incidentUuid', 'title' => '', 'example' => 'incident-001'], + 'title' => ['description' => 'The timeline title.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'title', 'title' => '', 'example' => '已联系运维团队'], + 'type' => ['description' => 'The type.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'type', 'title' => '', 'example' => 'ACTION'], + 'userId' => ['description' => 'The user ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'userId', 'title' => '', 'example' => 'user-12345'], + 'content' => ['description' => 'The content.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'content', 'title' => '', 'example' => '已通知运维团队进行排查'], ], + 'title' => '', + 'example' => '', ], 'IncidentTimelineForView' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'incidentUuid' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"a1b2c3d4-e5f6-7890-1234-567890abcdef"', - 'backendName' => 'incidentUuid', - ], - 'userId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"user-abc123"', - 'backendName' => 'userId', - ], - 'time' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1743876000000', - 'backendName' => 'time', - ], - 'timelineUuid' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"x1y2z3a4-b5c6-d7e8-f9g0-h1i2j3k4l5m6"', - 'backendName' => 'timelineUuid', - ], - 'type' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"Comment"', - 'backendName' => 'type', + 'incidentUuid' => ['description' => 'The unique identifier of the incident.', 'type' => 'string', 'title' => '', 'example' => '"a1b2c3d4-e5f6-7890-1234-567890abcdef"'], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'title' => '', 'example' => '"user-abc123"'], + 'time' => ['description' => 'The UNIX timestamp when the timeline event occurred.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1743876000000'], + 'timelineUuid' => ['description' => 'The unique identifier of the timeline record.', 'type' => 'string', 'title' => '', 'example' => '"x1y2z3a4-b5c6-d7e8-f9g0-h1i2j3k4l5m6"'], + 'type' => ['description' => 'The type of the timeline event.', 'type' => 'string', 'title' => '', 'example' => '"Comment"'], + 'changeType' => ['description' => 'The type of status change.', 'type' => 'string', 'title' => '', 'example' => '"Open -> In Progress"'], + 'title' => ['description' => 'The title of the timeline event.', 'type' => 'string', 'title' => '', 'example' => '"故障已升级至值班主管"'], + 'content' => ['description' => 'The content of the timeline event.', 'type' => 'any', 'title' => '', 'example' => '"{"action":"restart","resourceId":"i-bp123456"}"'], + 'workspace' => ['description' => 'The workspace.', 'type' => 'string', 'title' => '', 'example' => '"ws-xyz789"'], + 'operator' => ['description' => 'Information about the operator.', '$ref' => '#/components/schemas/ContactForIncidentView', 'title' => '', 'example' => ''], + ], + 'description' => 'The incident timeline object.', + 'title' => '', + 'example' => '', + ], + 'IndexJsonKey' => [ + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'The field type.', 'type' => 'string', 'title' => '', 'example' => 'text'], + 'chn' => ['description' => 'Specifies whether the field contains Chinese characters.'."\n" + ."\n" + .'- `true`: The field contains Chinese characters.'."\n" + ."\n" + .'- `false`: The field does not contain Chinese characters.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + ], + 'description' => 'The configuration for a json key.', + 'title' => '', + 'example' => '', + ], + 'IndexKey' => [ + 'type' => 'object', + 'properties' => [ + 'chn' => ['description' => 'Indicates whether the value contains Chinese characters.'."\n" + ."\n" + .'- `true`: Contains Chinese characters.'."\n" + ."\n" + .'- `false`: Does not contain Chinese characters.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'type' => ['description' => 'Specifies the field type.', 'type' => 'string', 'title' => '', 'example' => 'text'], + 'embedding' => ['description' => 'Specifies the model name.', 'type' => 'string', 'title' => '', 'example' => 'text-embedding-v4'], + 'jsonKeys' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'The name of the json key.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/IndexJsonKey'], + 'description' => 'Describes the json keys.', + 'title' => '', + 'example' => '', ], - 'changeType' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"Open -> In Progress"', - 'backendName' => 'changeType', + ], + 'description' => 'Describes the table structure.', + 'title' => '', + 'example' => '', + ], + 'LabelMatcher' => [ + 'description' => 'A `LabelMatcher` defines a query that selects resources by exactly matching a label\'s `key` and `value`.', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The label key to match.', 'type' => 'string', 'title' => '', 'example' => ''], + 'value' => ['description' => 'The label value to match.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'LabelsFilter' => [ + 'description' => 'A `LabelsFilter` defines a query for selecting objects based on their labels. It allows you to construct complex selection logic by combining multiple label matchers. The filter has two optional fields, `anyOf` and `allOf`. If both are specified, an object is selected only if it satisfies the conditions in both fields.', + 'type' => 'object', + 'properties' => [ + 'anyOf' => [ + 'description' => 'An array of `LabelMatcher` requirements. An object is selected if it satisfies at least one of the requirements in this list (a logical OR). If provided, the list cannot be empty.', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/LabelMatcher'], + 'title' => '', + 'example' => '', ], - 'title' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', + 'allOf' => [ + 'description' => 'An array of `LabelMatcher` requirements. An object is selected only if it satisfies all of the requirements in this list (a logical AND). If provided, the list cannot be empty.', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/LabelMatcher'], + 'title' => '', 'example' => '', - 'backendName' => 'title', ], - 'content' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'any', - 'example' => '"{"action":"restart","resourceId":"i-bp123456"}"', - 'backendName' => 'content', + ], + 'title' => '', + 'example' => '', + ], + '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' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"ws-xyz789"', - 'backendName' => 'workspace', + 'annotation' => [ + 'description' => 'annotation类型的Key列表', + 'type' => 'array', + 'items' => ['description' => 'Key名称', 'type' => 'string', 'example' => 'message'], + 'example' => '["message","current_value"]', ], - 'operator' => [ - 'description' => '', - 'visibility' => 'Public', - 'backendName' => 'operator', - '$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' => 'Silencing policy object.', + 'description' => 'The silence policy object.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'effective' => [ - 'title' => '', - 'description' => 'Crontab expression.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '* * 14-18 ? * *', - 'backendName' => 'effective', - ], - 'description' => [ - 'title' => '', - 'description' => 'Description.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'workspace test', - 'backendName' => 'description', - ], - 'filterSetting' => [ - 'description' => 'Filtering conditions.', - 'visibility' => 'Public', - 'backendName' => 'filterSetting', - '$ref' => '#/components/schemas/FilterSetting', - ], - 'maintainWindowName' => [ - 'title' => '', - 'description' => 'Name.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'test strategy', - 'backendName' => 'maintainWindowName', - ], - 'startTime' => [ - 'title' => '', - 'description' => 'Effective start time.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-04-11 07:55:00', - 'backendName' => 'startTime', - ], + 'effective' => ['title' => 'Crontab 表达式', 'description' => 'The Crontab expression.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'effective', 'example' => '* * 14-18 ? * *'], + 'description' => ['title' => '创建时间', 'description' => 'The description.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'example' => 'workspace test'], + 'filterSetting' => ['description' => 'The filter conditions.', 'visibility' => 'Public', 'backendName' => 'filterSetting', '$ref' => '#/components/schemas/FilterSetting', 'title' => '', 'example' => ''], + 'maintainWindowName' => ['title' => '名称', 'description' => 'The name.', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'backendName' => 'maintainWindowName', 'example' => 'test strategy'], + 'startTime' => ['title' => '生效开始时间', 'description' => 'The time when the policy starts to take effect.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'startTime', 'example' => '2025-04-11 07:55:00'], 'effectTimeRange' => [ - 'description' => 'Effective time range.', + 'description' => 'The effective time range.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'startTimeInMinute' => [ - 'title' => '', - 'description' => 'Start time (in minutes).', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '1438', - 'minimum' => '0', - 'example' => '60', - 'backendName' => 'startTimeInMinute', - ], - 'timeZone' => [ - 'title' => '', - 'description' => 'Time zone.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '+08:00', - 'backendName' => 'timeZone', - ], + 'startTimeInMinute' => ['title' => '开始时间(分钟数)', 'description' => 'The start time in minutes.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1438', 'minimum' => '0', 'backendName' => 'startTimeInMinute', 'example' => '60'], + 'timeZone' => ['title' => '时区', 'description' => 'The time zone.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'timeZone', 'example' => '+08:00'], 'dayInWeek' => [ - 'title' => '', - 'description' => 'Effective days (Monday to Sunday).', + 'title' => '生效天(周一到周日)', + 'description' => 'The days of the week when the policy is effective (Monday to Sunday).', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '0–6 represents Sunday to Saturday.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The values 0 to 6 represent Sunday to Saturday.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'extendType' => 'true', 'title' => '', 'example' => '0'], 'backendName' => 'dayInWeek', + 'example' => '', ], - 'endTimeInMinute' => [ - 'title' => '', - 'description' => 'End time (in minutes).', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '1439', - 'minimum' => '0', - 'example' => '60', - 'backendName' => 'endTimeInMinute', - ], + 'endTimeInMinute' => ['title' => '结束时间(分钟数)', 'description' => 'The end time in minutes.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1439', 'minimum' => '0', 'backendName' => 'endTimeInMinute', 'example' => '60'], ], 'backendName' => 'effectTimeRange', - ], - 'endTime' => [ 'title' => '', - 'description' => 'Effective end time.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-09-05 09:30:40', - 'backendName' => 'endTime', + 'example' => '', ], + 'endTime' => ['title' => '生效结束时间', 'description' => 'The time when the policy stops taking effect.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'endTime', 'example' => '2024-09-05 09:30:40'], ], + 'example' => '', ], 'MaintainWindowForView' => [ 'title' => 'A short description of struct', - 'description' => 'Silencing policy object.', + 'description' => 'The alert silencing policy object.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - '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' => 'Description.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test', - 'backendName' => 'description', - ], - 'filterSetting' => [ - 'description' => 'Filtering conditions.', - 'visibility' => 'Public', - 'backendName' => 'filterSetting', - '$ref' => '#/components/schemas/FilterSetting', - ], - 'maintainWindowName' => [ - 'title' => '', - 'description' => 'Name.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'Test policy.'."\n", - 'backendName' => 'maintainWindowName', - ], - 'updateTime' => [ - 'title' => '', - 'description' => 'Update time.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-05-07T02:19:05Z', - 'backendName' => 'updateTime', - ], + 'workspace' => ['title' => 'workspace', 'description' => 'The workspace.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'workspace', 'example' => 'workspace-test'], + 'maintainWindowId' => ['title' => 'UUID', 'description' => 'The UUID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'maintainWindowId', 'example' => '123-12-312-31-23123'], + 'description' => ['title' => '描述', 'description' => 'The description.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'example' => 'test'], + 'filterSetting' => ['description' => 'The filter conditions.', 'visibility' => 'Public', 'backendName' => 'filterSetting', '$ref' => '#/components/schemas/FilterSetting', 'title' => '', 'example' => ''], + 'maintainWindowName' => ['title' => '名称', 'description' => 'The name.', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'backendName' => 'maintainWindowName', 'example' => '测试策略'], + 'updateTime' => ['title' => '更新时间', 'description' => 'The last time the resource was updated.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'updateTime', 'example' => '2025-05-07T02:19:05Z'], 'effectTimeRange' => [ - 'description' => 'Effective time range.', + 'description' => 'The effective time range.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'startTimeInMinute' => [ - 'title' => '', - 'description' => 'Start time (in minutes).', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '1438', - 'minimum' => '0', - 'example' => '60', - 'backendName' => 'startTimeInMinute', - ], - 'timeZone' => [ - 'title' => '', - 'description' => 'Time Zone.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '+08:00', - 'backendName' => 'timeZone', - ], + 'startTimeInMinute' => ['title' => '开始时间(分钟数)', 'description' => 'The start time in minutes.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1438', 'minimum' => '0', 'backendName' => 'startTimeInMinute', 'example' => '60'], + 'timeZone' => ['title' => '时区', 'description' => 'The time zone.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'timeZone', 'example' => '+08:00'], 'dayInWeek' => [ - 'title' => '', - 'description' => 'Effective days (Monday to Sunday).', + 'title' => '生效天(周一到周日)', + 'description' => 'The days of the week when the policy is effective.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '0–6 denotes Sunday to Saturday.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The values 0 to 6 represent Sunday to Saturday.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'extendType' => 'true', 'title' => '', 'example' => '3'], 'backendName' => 'dayInWeek', + 'example' => '', ], - 'endTimeInMinute' => [ - 'title' => '', - 'description' => 'End time (in minutes).', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '1439', - 'minimum' => '0', - 'example' => '360', - 'backendName' => 'endTimeInMinute', - ], + 'endTimeInMinute' => ['title' => '结束时间(分钟数)', 'description' => 'The end time in minutes.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1439', 'minimum' => '0', 'backendName' => 'endTimeInMinute', 'example' => '360'], ], 'backendName' => 'effectTimeRange', - ], - 'userId' => [ - 'title' => '', - 'description' => 'User ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '12312312***', - 'backendName' => 'userId', - ], - 'effective' => [ 'title' => '', - 'description' => 'Crontab expression.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '* * 14-18 ? * *', - 'backendName' => 'effective', - ], - 'createTime' => [ - 'title' => '', - 'description' => 'Creation time.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58Z', - 'backendName' => 'createTime', - ], - 'enable' => [ - 'title' => '', - 'description' => 'Whether enabled.', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'enabled', + 'example' => '', ], - 'startTime' => [ + 'userId' => ['title' => '用户id', 'description' => 'The user ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'userId', 'example' => '12312312***'], + 'effective' => ['title' => 'Crontab 表达式', 'description' => 'The crontab expression.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'effective', 'example' => '* * 14-18 ? * *'], + 'createTime' => ['title' => '创建时间', 'description' => 'The time when the policy was created.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'createTime', 'example' => '2025-03-11T08:21:58Z'], + 'enable' => ['title' => '是否启用', 'description' => 'Indicates whether the policy is enabled.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'enabled', 'example' => 'true'], + 'startTime' => ['title' => '生效开始时间', 'description' => 'The start time of the effective period.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'startTime', 'example' => '2024-11-26 10:02:01'], + 'endTime' => ['title' => '生效结束时间', 'description' => 'The end time of the effective period.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'endTime', 'example' => '2024-11-26 12:02:01'], + ], + 'example' => '', + ], + 'ManageAlertRulesResult' => [ + 'description' => 'The result of managing alert rules.', + 'type' => 'object', + 'properties' => [ + 'alertRule' => ['description' => 'The details of the created or updated alert rule.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/AlertRuleV2'], + 'deletedCount' => ['description' => 'The number of deleted alert rules.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + 'deletedUuidList' => [ + 'description' => 'A list of UUIDs of deleted alert rules.', + 'type' => 'array', + 'items' => ['description' => 'The UUID of a deleted alert rule.', 'type' => 'string', 'title' => '', 'example' => ''], 'title' => '', - 'description' => 'Effective start time.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-11-26 10:02:01', - 'backendName' => 'startTime', + 'example' => '', ], - 'endTime' => [ + 'updatedCount' => ['description' => 'The number of updated alert rules.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + 'updatedUuidList' => [ 'title' => '', - 'description' => 'Effective end time.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-11-26 12:02:01', - 'backendName' => 'endTime', + 'type' => 'array', + 'items' => ['description' => 'The UUID of an updated alert rule.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'A list of UUIDs of updated alert rules.', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'MergeContact' => [ - 'description' => '', - 'visibility' => 'Public', + 'ManageAlertRulesUnifiedActionInput' => [ + 'title' => '', 'type' => 'object', 'properties' => [ - 'gmtModified' => [ - 'description' => '', - 'visibility' => 'Public', + 'action' => [ + 'title' => '', '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' => [ + 'required' => true, + 'enum' => ['CREATE', 'UPDATE', 'PATCH', 'BATCH_DELETE', 'BATCH_ENABLE', 'BATCH_DISABLE', 'DELETE', 'ENABLE', 'DISABLE'], + ], + 'uuid' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'workspace' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'displayName' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'contentTemplate' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'enabled' => ['title' => '', 'type' => 'boolean', 'description' => '', 'example' => ''], + 'datasourceConfig' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/DatasourceConfigUnified'], + 'queryConfig' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/QueryConfigUnified'], + 'conditionConfig' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ConditionConfigUnified'], + 'scheduleConfig' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ScheduleConfigUnified'], + 'notifyConfig' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/NotifyConfigUnified'], + 'actionIntegrationConfig' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ActionIntegrationConfig'], + 'armsIntegrationConfig' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ArmsIntegrationConfig'], + 'observeResourceInstanceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'observeResourceType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'labels' => [ + 'title' => '', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'zh-CN', - 'backendName' => 'lang', + 'example' => '', ], - 'source' => [ + 'annotations' => [ + 'title' => '', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'dingtalk', - 'backendName' => 'source', + 'example' => '', ], - 'extend' => [ + 'uuidList' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', 'example' => '', - 'backendName' => 'extend', ], ], + 'description' => '', + 'example' => '', + ], + 'MergeContact' => [ + 'description' => 'The struct for a merged contact object.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'gmtModified' => ['description' => 'The time when the contact was last modified.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'gmtModified', 'title' => '', 'example' => '2025-03-11T08:21:58.789Z'], + 'name' => ['description' => 'The name of the contact.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'title' => '', 'example' => '张三'], + 'gmtCreate' => ['description' => 'The time when the contact was created.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'gmtCreate', 'title' => '', 'example' => '2025-03-11T08:21:58.789Z'], + 'identifier' => ['description' => 'The unique identifier of the contact.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'identifier', 'title' => '', 'example' => 'user-12345'], + 'phoneCode' => ['description' => 'The country code for the mobile phone number.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'phoneCode', 'title' => '', 'example' => '86'], + 'phone' => ['description' => 'The mobile phone number.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'phone', 'sensitive' => true, 'title' => '', 'example' => '13800138000'], + 'phoneVerify' => ['description' => 'Specifies whether the mobile phone number is authenticated.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'phoneVerify', 'title' => '', 'example' => 'true'], + 'email' => ['description' => 'The email address.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'email', 'sensitive' => true, 'title' => '', 'example' => 'zhangsan@company.com'], + 'emailVerify' => ['description' => 'Specifies whether the email address is authenticated.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'emailVerify', 'title' => '', 'example' => 'true'], + 'lang' => ['description' => 'The language preference.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'lang', 'title' => '', 'example' => 'zh-CN'], + 'source' => ['description' => 'The source system of the contact.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'source', 'title' => '', 'example' => 'dingtalk'], + 'extend' => ['description' => 'An extension field used to store additional information.', 'visibility' => 'Public', 'type' => 'object', 'backendName' => 'extend', 'title' => '', 'example' => '{ "department": "运维部", "role": "工程师" }'], + ], + 'title' => '', + 'example' => '', ], 'MergeContactGroup' => [ - 'description' => '', + 'description' => 'A struct for a merged contact group object.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - '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', - ], + 'name' => ['description' => 'The name of the contact group.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'title' => '', 'example' => '运维团队'], + 'gmtModified' => ['description' => 'The time when the contact group was last modified.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'gmtCreate', 'title' => '', 'example' => '2025-03-11T08:21:58.789Z'], + 'identifier' => ['description' => 'The unique identifier of the contact group.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'identifier', 'title' => '', 'example' => 'group-12345'], + 'gmtCreate' => ['description' => 'The time when the contact group was created.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'plan', 'title' => '', 'example' => '2025-03-11T08:21:58.789Z'], 'contacts' => [ - 'description' => '', + 'description' => 'A list of unique identifiers for the members in the group.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'user-12345', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The unique identifier of a member in the group.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'user-12345'], 'backendName' => 'contacts', + 'title' => '', + 'example' => '', ], + 'extend' => ['description' => 'An extension field that stores additional information.', 'visibility' => 'Public', 'type' => 'object', 'backendName' => 'extend', 'title' => '', 'example' => '{ "department": "运维部", "role": "工程师" }'], + 'source' => ['description' => 'The source system of the contact group.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'source', 'title' => '', 'example' => 'dingtalk'], + ], + 'title' => '', + 'example' => '', + ], + 'MergeOncallSchedule' => [ + 'type' => 'object', + 'properties' => [ + 'gmtModified' => ['description' => 'The UTC time when the on-call schedule was last modified.', 'type' => 'string', 'title' => '', 'example' => ''], + 'name' => ['description' => 'The name of the on-call schedule.', 'type' => 'string', 'title' => '', 'example' => ''], + 'gmtCreate' => ['description' => 'The UTC time when the on-call schedule was created.', 'type' => 'string', 'title' => '', 'example' => ''], + 'identifier' => ['description' => 'The unique identifier of the on-call schedule.', 'type' => 'string', 'title' => '', 'example' => ''], + 'source' => ['description' => 'The creation source of the on-call schedule.', 'type' => 'string', 'title' => '', 'example' => ''], + 'detail' => ['description' => 'Details of the on-call schedule.', 'type' => 'object', 'title' => '', 'example' => ''], + 'workspace' => ['description' => 'The workspace that the on-call schedule belongs to.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'description' => 'Details of the merged on-call schedule.', + 'title' => '', + 'example' => '', + ], + 'MergeRobot' => [ + 'description' => 'The struct for the merge object of a bot.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the bot.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'title' => '', 'example' => '运维告警机器人'], + 'webhook' => ['description' => 'The webhook address.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'webhook', 'title' => '', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=abc123'], + 'type' => ['description' => 'The type of the bot.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'type', 'title' => '', 'example' => 'dingtalk'], + 'createTime' => ['description' => 'The time when the bot was created.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'gmtCreate', 'title' => '', 'example' => '2025-03-11T08:21:58.789Z'], + 'gmtModified' => ['description' => 'The time when the bot was last modified.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'gmtModified', 'title' => '', 'example' => '2025-03-11T08:21:58.789Z'], + 'identifier' => ['description' => 'The unique identifier of the bot.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'identifier', 'title' => '', 'example' => 'robot-12345'], + 'lang' => ['description' => 'The language preference.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'lang', 'title' => '', 'example' => 'zh-CN'], 'extend' => [ - 'description' => '', + 'description' => 'The extension fields.', 'visibility' => 'Public', 'type' => 'object', - 'example' => '', + 'properties' => [ + 'dailyNoc' => ['description' => 'Specifies whether to enable the daily on-duty report.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'dailyNoc', 'title' => '', 'example' => 'true'], + 'dingSignKey' => ['description' => 'The signature key for DingTalk.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'dingSignKey', 'title' => '', 'example' => 'abc123'], + 'enableOutgoing' => ['description' => 'Specifies whether to enable outbound requests.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'enableOutgoing', 'title' => '', 'example' => 'false'], + 'cardTemplate' => ['description' => 'The card template.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'cardTemplate', 'title' => '', 'example' => 'incident-card-template'], + 'dailyNocTime' => ['description' => 'The time for the daily on-duty report.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'dailyNocTime', 'title' => '', 'example' => '09:00'], + 'token' => ['description' => 'The authentication token.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'token', 'sensitive' => true, 'title' => '', 'example' => 'token-abc123'], + ], 'backendName' => 'extend', + 'title' => '', + 'example' => '', ], - 'source' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'dingtalk', - 'backendName' => 'source', - ], + 'source' => ['description' => 'The source system of the bot.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'source', 'title' => '', 'example' => 'dingtalk'], ], + 'title' => '', + 'example' => '', ], - 'MergeRobot' => [ - 'description' => '', + 'MergeWebhook' => [ + 'description' => 'The struct of the merged webhook object.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '', - 'visibility' => 'Public', + 'gmtCreate' => ['description' => 'The creation time.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'gmtCreate', 'title' => '', 'example' => '2025-03-11T08:21:58.789Z'], + 'name' => ['description' => 'The name of the webhook.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'title' => '', 'example' => '运维告警通知'], + 'gmtModified' => ['description' => 'The last modification time.', 'visibility' => 'Public', 'type' => 'object', 'backendName' => 'gmtModified', 'title' => '', 'example' => '2025-03-11T08:21:58.789Z'], + 'identifier' => ['description' => 'The unique identifier of the webhook.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'identifier', 'title' => '', 'example' => 'webhook-12345'], + 'webhook' => ['description' => 'The webhook URL used to send requests.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'webhook', 'title' => '', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=abc123'], + 'type' => ['description' => 'The type of the webhook. It indicates the destination platform.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'type', 'title' => '', 'example' => 'dingtalk'], + 'headers' => ['description' => 'The request header.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'headers', 'title' => '', 'example' => '{"Authorization": "Bearer abc123"}'], + 'method' => ['description' => 'The HTTP request method.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'method', 'title' => '', 'example' => 'POST'], + 'contentType' => ['description' => 'The content type.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'contentType', 'title' => '', 'example' => 'application/json'], + 'lang' => ['description' => 'The language preference.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'lang', 'title' => '', 'example' => 'zh-CN'], + 'extend' => ['description' => 'An extension field used to store additional configurations.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'extend', 'title' => '', 'example' => '{"timeout": 3000}'], + 'source' => ['description' => 'The source system of the webhook.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'source', 'title' => '', 'example' => 'dingtalk'], + ], + 'title' => '', + 'example' => '', + ], + 'MetricSetMultiTrigger' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'severity' => [ + 'title' => '', 'type' => 'string', + 'enum' => ['INFO', 'WARN', 'WARNING', 'ERROR', 'CRITICAL'], + 'description' => '', 'example' => '', - 'backendName' => 'name', ], - 'webhook' => [ - 'description' => '', - 'visibility' => 'Public', + 'durationSecs' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''], + 'expressionType' => [ + 'title' => '', 'type' => 'string', - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=abc123', - 'backendName' => 'webhook', - ], - 'type' => [ + 'enum' => ['SIMPLE', 'COMPOSITE'], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'dingtalk', - 'backendName' => 'type', + 'example' => '', ], - 'createTime' => [ - 'description' => '', - 'visibility' => 'Public', + 'queryName' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'operator' => [ + 'title' => '', 'type' => 'string', - 'example' => '2025-03-11T08:21:58.789Z', - 'backendName' => 'gmtCreate', - ], - 'gmtModified' => [ + 'enum' => ['GT', 'GE', 'GTE', 'LT', 'LE', 'LTE', 'EQ', 'NE', 'IN_RANGE', 'OUT_OF_RANGE', 'PRESENT', 'NOT_PRESENT', 'YOY_UP', 'YOY_DOWN'], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58.789Z', - 'backendName' => 'gmtModified', + 'example' => '', ], - 'identifier' => [ - 'description' => '', - 'visibility' => 'Public', + 'threshold' => ['title' => '', 'type' => 'number', 'format' => 'double', 'description' => '', 'example' => ''], + 'min' => ['title' => '', 'type' => 'number', 'format' => 'double', 'description' => '', 'example' => ''], + 'max' => ['title' => '', 'type' => 'number', 'format' => 'double', 'description' => '', 'example' => ''], + 'logicOperator' => [ + 'title' => '', 'type' => 'string', - 'example' => 'robot-12345', - 'backendName' => 'identifier', - ], - 'lang' => [ + 'enum' => ['AND', 'OR', 'UNLESS'], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'zh-CN', - 'backendName' => 'lang', + 'example' => '', ], - 'extend' => [ + 'conditions' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/MetricSetTriggerSimpleExpression', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - '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', + 'example' => '', ], - 'source' => [ + ], + 'description' => '', + 'example' => '', + ], + 'MetricSetNamedQueryEntry' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'name' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'metricSet' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'metric' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'labelFilters' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/UmodelLabelFilter', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'dingtalk', - 'backendName' => 'source', + 'example' => '', ], ], - ], - 'MergeWebhook' => [ 'description' => '', - 'visibility' => 'Public', + 'example' => '', + ], + 'MetricSetTriggerCompositeExpression' => [ + 'title' => '', 'type' => 'object', 'properties' => [ - 'gmtCreate' => [ - 'description' => '', - 'visibility' => 'Public', + 'expressionType' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'logicOperator' => [ + 'title' => '', 'type' => 'string', - 'example' => '2025-03-11T08:21:58.789Z', - 'backendName' => 'gmtCreate', - ], - 'name' => [ + 'enum' => ['AND', 'OR', 'UNLESS'], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', 'example' => '', - 'backendName' => 'name', ], - 'gmtModified' => [ + 'conditions' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/MetricSetTriggerSimpleExpression', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'example' => '2025-03-11T08:21:58.789Z', - 'backendName' => 'gmtModified', + 'example' => '', ], - 'identifier' => [ - 'description' => '', - 'visibility' => 'Public', + ], + 'description' => '', + 'example' => '', + ], + 'MetricSetTriggerSimpleExpression' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'expressionType' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'queryName' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'operator' => [ + 'title' => '', 'type' => 'string', - 'example' => 'webhook-12345', - 'backendName' => 'identifier', - ], - 'webhook' => [ + 'enum' => ['GT', 'GE', 'GTE', 'LT', 'LE', 'LTE', 'EQ', 'NE', 'IN_RANGE', 'OUT_OF_RANGE', 'PRESENT', 'NOT_PRESENT', 'YOY_UP', 'YOY_DOWN'], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=abc123', - 'backendName' => 'webhook', + 'example' => '', ], - 'type' => [ + 'threshold' => ['title' => '', 'type' => 'number', 'format' => 'double', 'description' => '', 'example' => ''], + 'min' => ['title' => '', 'type' => 'number', 'format' => 'double', 'description' => '', 'example' => ''], + 'max' => ['title' => '', 'type' => 'number', 'format' => 'double', 'description' => '', 'example' => ''], + ], + 'description' => '', + 'example' => '', + ], + 'ModelParameters' => [ + 'type' => 'object', + 'properties' => [ + 'temperature' => ['type' => 'number', 'description' => '', 'title' => '', 'example' => '', 'format' => 'float'], + 'maxTokens' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'], + 'topP' => ['type' => 'number', 'description' => '', 'title' => '', 'example' => '', 'format' => 'float'], + 'topK' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'], + 'frequencyPenalty' => ['type' => 'number', 'description' => '', 'title' => '', 'example' => '', 'format' => 'float'], + 'presencePenalty' => ['type' => 'number', 'description' => '', 'title' => '', 'example' => '', 'format' => 'float'], + 'stopSequences' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'dingtalk', - 'backendName' => 'type', + 'title' => '', + 'example' => '', ], - 'headers' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{"Authorization": "Bearer abc123"}', - 'backendName' => 'headers', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'NotifyChannel' => [ + 'type' => 'object', + 'properties' => [ + 'channelType' => ['description' => 'The type of the notification channel.', 'type' => 'string', 'title' => '', 'example' => '"DingTalk"'], + 'receivers' => [ + 'type' => 'array', + 'items' => ['description' => 'A receiver.', 'type' => 'string', 'title' => '', 'example' => '[]'], + 'description' => 'The list of receivers.', + 'title' => '', + 'example' => '', ], - 'method' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'POST', - 'backendName' => 'method', + 'enabledSubChannels' => [ + 'type' => 'array', + 'items' => ['description' => 'A channel.', 'type' => 'string', 'title' => '', 'example' => '[]'], + 'description' => 'The list of enabled sub-channels.', + 'title' => '', + 'example' => '', ], - 'contentType' => [ - 'description' => '', - 'visibility' => 'Public', + ], + 'description' => 'The notification channel configuration object.', + 'title' => '', + 'example' => '', + ], + 'NotifyConfigUnified' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'title' => '', 'type' => 'string', - 'example' => 'application/json', - 'backendName' => 'contentType', + 'description' => '', + 'example' => '', + 'required' => true, + 'enum' => ['DIRECT_NOTIFY', 'NOTIFY_POLICY'], ], - 'lang' => [ + 'channels' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/DirectNotifyChannel'], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'zh-CN', - 'backendName' => 'lang', + 'required' => true, + 'example' => '', ], - 'extend' => [ + 'silenceTimeSecs' => ['title' => '', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int32'], + 'activeDays' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{"timeout": 3000}', - 'backendName' => 'extend', + 'example' => '', ], - 'source' => [ + 'activeStartTime' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'activeEndTime' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'utcOffset' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'notifyStrategies' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'dingtalk', - 'backendName' => 'source', + 'example' => '', ], ], - ], - 'NotifyChannel' => [ 'description' => '', - 'visibility' => 'Public', + 'example' => '', + ], + 'NotifyRouteForSubscription' => [ 'type' => 'object', 'properties' => [ - 'channelType' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"DingTalk"', - 'backendName' => 'channelType', - ], - 'receivers' => [ - 'description' => '', - 'visibility' => 'Public', + 'channels' => [ 'type' => 'array', 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '[]', - 'extendType' => 'true', + 'type' => 'object', + 'properties' => [ + 'channelType' => ['description' => 'The channel type. For example, `Email`, `SMS`, or `Webhook`.', 'type' => 'string', 'title' => '', 'example' => ''], + 'receivers' => [ + 'type' => 'array', + 'items' => ['description' => 'A single receiver. For example, an email address or a phone number.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'A list of notification receivers. The receiver format depends on the `channelType`.', + 'title' => '', + 'example' => '', + ], + 'enabledSubChannels' => [ + 'type' => 'array', + 'items' => ['description' => 'A single enabled sub-channel.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'A list of enabled sub-channels. Applicable to channels that support finer-grained topics or categories.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The configuration for a notification channel.', + 'title' => '', + 'example' => '', ], - 'backendName' => 'receivers', + 'description' => 'An array of objects, each defining a notification channel.', + 'title' => '', + 'example' => '', ], - 'enabledSubChannels' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '[]', - 'extendType' => 'true', + 'effectTimeRange' => [ + 'type' => 'object', + 'properties' => [ + 'timeZone' => ['description' => 'The time zone for the effect time range, specified in the IANA Time Zone Database format. For example, `UTC` or `Asia/Shanghai`.', 'type' => 'string', 'title' => '', 'example' => ''], + 'dayInWeek' => [ + 'type' => 'array', + 'items' => ['description' => 'A day of the week. Valid values are from 1 (Monday) to 7 (Sunday).', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + 'description' => 'The active days of the week, specified as an array of integers.', + 'title' => '', + 'example' => '', + ], + 'startTimeInMinute' => ['description' => 'The start of the active period, in minutes from 00:00. The value ranges from 0 to 1439.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + 'endTimeInMinute' => ['description' => 'The end of the active period, in minutes from 00:00. The value ranges from 0 to 1439.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], ], - 'backendName' => 'enabledSubChannels', + 'description' => 'The active period for the notification rule.', + 'title' => '', + 'example' => '', ], ], + 'description' => 'Defines the notification routing rules for a subscription.', + 'title' => '', + 'example' => '', ], 'NotifyStrategyForModify' => [ 'title' => 'A short description of struct', - 'description' => 'Entity for viewing.', - 'visibility' => 'Public', + 'description' => 'The entity.', 'type' => 'object', 'properties' => [ + 'description' => ['title' => '描述', 'description' => 'The description.', 'type' => 'string', 'example' => 'test'], + 'groupingSetting' => [ + 'title' => '合并设置', + 'description' => 'The grouping settings.', + 'type' => 'object', + 'properties' => [ + 'groupingKeys' => [ + 'title' => '合并keys', + 'description' => 'The keys used for merging.', + 'type' => 'array', + 'items' => ['description' => 'The grouping field.', 'type' => 'string', 'title' => '', 'example' => 'severity'], + 'example' => '', + ], + 'periodMin' => ['title' => '检查周期分钟数', 'description' => 'The check period in minutes.', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'silenceSec' => ['title' => '沉默秒数', 'description' => 'The silence period in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '300'], + 'times' => ['title' => '触发次数', 'description' => 'The number of triggers.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], + 'required' => true, + 'example' => '', + ], + 'ignoreRestoredNotification' => ['title' => '恢复是否通知', 'description' => 'Specifies whether to send a notification upon recovery.', 'type' => 'boolean', 'example' => 'false'], + 'notifyStrategyName' => ['title' => '名称', 'description' => 'The name.', 'type' => 'string', 'required' => true, 'example' => '策略名称'], 'routes' => [ - 'title' => '', - 'description' => 'Notification channel routing configuration.', - 'visibility' => 'Public', + 'title' => '通知渠道路由设置', + 'description' => 'The routing settings for the notification channel.', 'type' => 'array', 'items' => [ - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'channels' => [ - 'title' => '', - 'description' => 'Notification channel.', - 'visibility' => 'Public', + 'title' => '通知渠道', + 'description' => 'The notification channel.', 'type' => 'array', 'items' => [ - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ + 'channelType' => [ + 'title' => '渠道类型', + 'description' => 'The channel type.', + 'type' => 'string', + 'required' => true, + 'enum' => ['DING', 'WEIXIN', 'FEISHU', 'SLACK', 'TEAMS', 'CONTACT', 'GROUP', 'DUTY', 'DING_COOL_APP'], + 'example' => 'CONTACT', + ], 'enabledSubChannels' => [ - 'title' => '', - 'description' => 'Enabled notification types.', - 'visibility' => 'Public', + 'title' => '启用通知类型', + 'description' => 'The enabled notification types.', 'type' => 'array', - 'items' => [ - 'description' => 'Notification channel.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'SMS', - 'extendType' => 'true', - ], - 'backendName' => 'enabledSubChannels', + 'items' => ['description' => 'The notification channel.', 'type' => 'string', 'title' => '', 'example' => 'SMS'], + 'example' => '', ], 'receivers' => [ - 'title' => '', - 'description' => 'Channel recipient.', - 'visibility' => 'Public', + 'title' => '渠道接收方', + 'description' => 'The channel receivers.', 'type' => 'array', - 'items' => [ - 'description' => 'Designated recipient.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'contactId', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The specified recipient.', 'type' => 'string', 'title' => '', 'example' => 'contactId'], 'required' => true, - 'backendName' => 'receivers', - ], - 'channelType' => [ - 'title' => '', - 'description' => 'Channel type.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'CONTACT', - 'backendName' => 'channelType', - 'enum' => [ - 'DING', - 'WEIXIN', - 'FEISHU', - 'SLACK', - 'TEAMS', - 'CONTACT', - 'GROUP', - 'DUTY', - ], + 'example' => '', ], ], - 'extendType' => 'true', + 'description' => 'The notification channel.', + 'title' => '', + 'example' => '', ], - 'backendName' => 'channels', - ], - 'filterSetting' => [ - 'description' => 'Routing conditions.', - 'visibility' => 'Public', - 'backendName' => 'filterSetting', - '$ref' => '#/components/schemas/FilterSetting', + 'example' => '', ], 'effectTimeRange' => [ - 'title' => '', - 'description' => 'Valid time range.', - 'visibility' => 'Public', + 'title' => '字段', + 'description' => 'The effective time range.', 'type' => 'object', 'properties' => [ - 'startTimeInMinute' => [ - 'title' => '', - 'description' => 'Start time (in minutes).', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '1438', - 'minimum' => '0', - 'example' => '60', - 'backendName' => 'startTimeInMinute', - ], - 'timeZone' => [ - 'title' => '', - 'description' => 'Time Zone.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '+08:00', - 'backendName' => 'timeZone', - ], 'dayInWeek' => [ - 'title' => '', - 'description' => 'Effective days (Monday to Sunday).', - 'visibility' => 'Public', + 'title' => '生效天(周一到周日)', + 'description' => 'The days of the week when the policy is active. Monday to Sunday.', 'type' => 'array', - 'items' => [ - 'description' => '1–7 represents Monday to Sunday.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'extendType' => 'true', - ], - 'backendName' => 'dayInWeek', - ], - 'endTimeInMinute' => [ - 'title' => '', - 'description' => 'End time (in minutes).', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '1439', - 'minimum' => '0', - 'example' => '30', - 'backendName' => 'endTimeInMinute', + 'items' => ['description' => 'A value from 1 to 7. 1 indicates Monday and 7 indicates Sunday.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'example' => '', ], + 'endTimeInMinute' => ['title' => '结束时间(分钟数)', 'description' => 'The end time in minutes.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1439', 'minimum' => '0', 'example' => '30'], + 'startTimeInMinute' => ['title' => '开始时间(分钟数)', 'description' => 'The start time in minutes.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1438', 'minimum' => '0', 'example' => '60'], + 'timeZone' => ['title' => '时区', 'description' => 'The time zone.', 'type' => 'string', 'example' => '+08:00'], ], - 'backendName' => 'effectTimeRange', + 'example' => '', ], + 'filterSetting' => ['description' => 'The routing conditions.', '$ref' => '#/components/schemas/FilterSetting', 'title' => '', 'example' => ''], 'severities' => [ - 'description' => 'Severity level list.', - 'visibility' => 'Public', + 'description' => 'The list of severity levels.', 'type' => 'array', - 'items' => [ - 'description' => 'Severity levels: CRITICAL, WARNING, INFO.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'INFO', - 'extendType' => 'true', - ], - 'backendName' => 'severities', + 'items' => ['description' => 'The severity level. Valid values: CRITICAL, WARNING, and INFO.', 'type' => 'string', 'title' => '', 'example' => 'INFO'], + 'title' => '', + 'example' => '', ], + 'digitalEmployeeName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'enableRca' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], - 'extendType' => 'true', + 'description' => 'The routing settings for the notification channel.', + 'title' => '', + 'example' => '', ], 'required' => true, - 'backendName' => 'routes', + 'example' => '', + ], + 'customTemplateEntries' => [ + 'title' => '通知渠道模板', + 'description' => 'The notification channel template.', + 'type' => 'array', + 'items' => [ + 'description' => 'The template details.', + 'type' => 'object', + 'properties' => [ + 'targetType' => ['title' => '通知类型', 'description' => 'The notification type.', 'type' => 'string', 'required' => true, 'example' => 'SMS'], + 'templateUuid' => ['title' => '模板UUID', 'description' => 'The template UUID.', 'type' => 'string', 'required' => true, 'example' => '123123-12-31-231-23-12-3123'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], - 'notifyStrategyName' => [ + 'enableIncidentManagement' => ['description' => 'Specifies whether to enable incident management.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'filterSetting' => ['description' => 'The filter settings.', '$ref' => '#/components/schemas/FilterSetting', 'title' => '', 'example' => ''], + 'workspaceFilterSetting' => ['description' => 'The workspace filter settings.', '$ref' => '#/components/schemas/WorkspaceFilterSetting', 'title' => '', 'example' => ''], + 'pushingSetting' => [ + 'type' => 'object', + 'properties' => [ + 'templateUuid' => ['description' => 'The message template UUID.', 'type' => 'string', 'title' => '', 'example' => '模板 UUID'], + 'alertActionIds' => [ + 'type' => 'array', + 'items' => ['description' => 'The alert action ID.', 'type' => 'string', 'title' => '', 'example' => '["action-123", "action-456"]'], + 'description' => 'The list of alert action IDs.', + 'title' => '', + 'example' => '', + ], + 'restoreActionIds' => [ + 'type' => 'array', + 'items' => ['description' => 'The restore action ID.', 'type' => 'string', 'title' => '', 'example' => '["restore-789"]'], + 'description' => 'The list of restore action IDs.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The push settings.', 'title' => '', - 'description' => 'Name.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'Policy name.'."\n", - 'backendName' => 'name', + 'example' => '', ], - 'description' => [ + 'repeatNotifySetting' => [ + 'type' => 'object', + 'properties' => [ + 'endIncidentState' => ['description' => 'The incident state that stops the repeated notifications.', 'type' => 'string', 'title' => '', 'example' => '"Resolved"'], + 'repeatInterval' => ['description' => 'The interval for repeated notifications.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '5'], + ], + 'description' => 'The settings for repeated notifications.', 'title' => '', - 'description' => 'Description.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test', - 'backendName' => 'description', + 'example' => '', + ], + 'autoRecoverSeconds' => ['description' => 'The auto-recovery time in seconds.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '300'], + 'escalationId' => [ + 'type' => 'array', + 'items' => ['description' => 'The escalation policy ID.', 'type' => 'string', 'title' => '', 'example' => '["escalation-123", "escalation-456"]'], + 'description' => 'The list of escalation policy IDs.', + 'title' => '', + 'example' => '', ], + ], + 'example' => '', + ], + 'NotifyStrategyForSNSModify' => [ + 'title' => '', + 'description' => 'The notifyStrategy sub-entity input parameters used for the SubscriptionAndNotifyStrategy aggregate operation.'."\n" + .'Differences from the legacy NotifyStrategyForModify:'."\n" + .'- Removed filterSetting / workspaceFilterSetting (now carried by sns.subscription).'."\n" + .'- Removed pushingSetting / repeatNotifySetting / autoRecoverSeconds / escalationId (now carried by sns.responsePlan).'."\n" + .'- Does not expose uuid / mode / syncFromType / incidentResponsePlanId / enabled (forcibly overwritten by the backend).', + 'type' => 'object', + 'properties' => [ + 'description' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], 'groupingSetting' => [ 'title' => '', - 'description' => 'Grouping settings.', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'groupingKeys' => [ 'title' => '', - 'description' => 'Grouping keys.', - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'Grouping fields.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'severity', - 'extendType' => 'true', - ], - 'backendName' => 'groupingKeys', - ], - 'times' => [ - 'title' => '', - 'description' => 'Trigger count.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'times', - ], - 'periodMin' => [ - 'title' => '', - 'description' => 'Check interval in minutes.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'backendName' => 'periodMin', - ], - 'silenceSec' => [ - 'title' => '', - 'description' => 'Silence duration in seconds.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '300', - 'backendName' => 'silenceSec', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'example' => '', ], + 'periodMin' => ['title' => '', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int32'], + 'silenceSec' => ['title' => '', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int32'], + 'times' => ['title' => '', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int32'], ], 'required' => true, - 'backendName' => 'groupingSetting', + 'description' => '', + 'example' => '', ], - 'customTemplateEntries' => [ + 'ignoreRestoredNotification' => ['title' => '', 'type' => 'boolean', 'description' => '', 'example' => ''], + 'enableIncidentManagement' => ['title' => '', 'type' => 'boolean', 'description' => '', 'example' => ''], + 'routes' => [ 'title' => '', - 'description' => 'Notification channel template.', - 'visibility' => 'Public', 'type' => 'array', 'items' => [ - 'description' => 'Template details.', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'templateUuid' => [ + 'channels' => [ 'title' => '', - 'description' => 'Template UUID.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '123123-12-31-231-23-12-3123', - 'backendName' => 'templateUuid', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'channelType' => [ + 'title' => '', + 'type' => 'string', + 'description' => '', + 'example' => '', + 'required' => true, + 'enum' => ['DING', 'WEIXIN', 'FEISHU', 'SLACK', 'TEAMS', 'CONTACT', 'GROUP', 'DUTY', 'DING_COOL_APP'], + ], + 'enabledSubChannels' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'example' => '', + ], + 'receivers' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'required' => true, + 'description' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'example' => '', ], - 'targetType' => [ + 'effectTimeRange' => [ 'title' => '', - 'description' => 'Notification type.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'SMS', - 'backendName' => 'targetType', + 'type' => 'object', + 'properties' => [ + 'dayInWeek' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'], + 'description' => '', + 'example' => '', + ], + 'endTimeInMinute' => ['title' => '', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int32'], + 'startTimeInMinute' => ['title' => '', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int32'], + 'timeZone' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + ], + 'description' => '', + 'example' => '', ], + 'filterSetting' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'conditions' => [ + 'title' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'field' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'op' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'value' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'maxItems' => 10, + 'description' => '', + 'example' => '', + ], + 'expression' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'relation' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + ], + 'description' => '', + 'example' => '', + ], + 'severities' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'example' => '', + ], + 'digitalEmployeeName' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'enableRca' => ['title' => '', 'type' => 'boolean', 'description' => '', 'example' => ''], ], - 'extendType' => 'true', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'backendName' => 'customTemplateEntries', + 'required' => true, + 'description' => '', + 'example' => '', ], - 'ignoreRestoredNotification' => [ + 'customTemplateEntries' => [ 'title' => '', - 'description' => 'Whether to notify on recovery.', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'ignoreRestoredNotification', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'targetType' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => '', 'required' => false], + 'templateUuid' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => '', 'required' => false], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'example' => '', ], ], + 'example' => '', ], - 'NotifyStrategyForView' => [ - 'title' => 'A short description of struct', - 'description' => 'Entity for viewing.', - 'visibility' => 'Public', + 'NotifyStrategyForSNSView' => [ + 'title' => 'SNS 内嵌的通知策略查看视图', + 'description' => 'The value of the `SubscriptionAndNotifyStrategyForView.notifyStrategy` sub-field.', 'type' => 'object', 'properties' => [ + 'notifyStrategyId' => ['title' => 'uuid（= SNS uuid，D8）', 'description' => 'The ID of the notification strategy.', 'type' => 'string', 'example' => ''], + 'notifyStrategyName' => ['title' => '名称', 'description' => 'The name of the notification strategy.', 'type' => 'string', 'example' => ''], + 'description' => ['title' => '描述', 'description' => 'The description of the notification strategy.', 'type' => 'string', 'example' => ''], + 'enable' => ['title' => '是否启用', 'description' => 'Specifies whether to enable the notification strategy. Valid values: true, false.', 'type' => 'boolean', 'example' => ''], + 'userId' => ['title' => '用户id', 'description' => 'The user ID.', 'type' => 'string', 'example' => ''], + 'workspace' => ['title' => 'workspace', 'description' => 'The workspace to which the notification strategy belongs.', 'type' => 'string', 'example' => ''], + 'syncFromType' => ['title' => '同步来源（SNS 新建必为 OBS）', 'description' => 'The source from which the strategy is synchronized.', 'type' => 'string', 'example' => ''], + 'mode' => ['title' => '生命周期模式（SNS 内必为 BundleStrategy）', 'description' => 'The mode of the notification strategy.', 'type' => 'string', 'example' => ''], + 'enableIncidentManagement' => ['title' => '是否启用事件管理', 'description' => 'Specifies whether to enable incident management. Valid values: true, false.', 'type' => 'boolean', 'example' => ''], + 'ignoreRestoredNotification' => ['title' => '恢复是否通知', 'description' => 'Specifies whether to ignore notifications for restored alerts. Valid values: true, false.', 'type' => 'boolean', 'example' => ''], + 'incidentResponsePlanId' => ['title' => '关联响应计划 uuid（= notifyStrategyId）', 'description' => 'The ID of the incident response plan.', 'type' => 'string', 'example' => ''], + 'groupingSetting' => [ + 'title' => '合并设置', + 'type' => 'object', + 'properties' => [ + 'groupingKeys' => [ + 'title' => '合并keys', + 'type' => 'array', + 'items' => ['description' => 'A grouping key. For example, \'alertname\'.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'The keys for grouping alerts.', + 'example' => '', + ], + 'periodMin' => ['title' => '检查周期分钟数', 'description' => 'The time window in minutes for grouping alerts.', 'type' => 'integer', 'example' => '', 'format' => 'int32'], + 'silenceSec' => ['title' => '沉默秒数', 'description' => 'The silence period in seconds after a notification is sent for a group.', 'type' => 'integer', 'example' => '', 'format' => 'int32'], + 'times' => ['title' => '触发次数', 'description' => 'The number of times to send notifications for a group.', 'type' => 'integer', 'example' => '', 'format' => 'int32'], + ], + 'description' => 'The settings for alert grouping.', + 'example' => '', + ], 'routes' => [ - 'title' => '', - 'description' => 'Notification channel routing configuration.', - 'visibility' => 'Public', + 'title' => '通知渠道路由设置', 'type' => 'array', 'items' => [ - 'description' => 'Routing object.', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'channels' => [ - 'title' => '', - 'description' => 'Notification channel.', - 'visibility' => 'Public', + 'title' => '通知渠道', 'type' => 'array', 'items' => [ - 'description' => 'Notification channel.', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ + 'channelType' => [ + 'title' => '渠道类型', + 'description' => 'The type of the notification channel, such as \'sms\' or \'email\'.', + 'type' => 'string', + 'example' => '', + 'enum' => ['DING', 'WEIXIN', 'FEISHU', 'SLACK', 'TEAMS', 'CONTACT', 'GROUP', 'DUTY', 'DING_COOL_APP'], + ], 'enabledSubChannels' => [ - 'title' => '', - 'description' => 'Enabled notification types.', - 'visibility' => 'Public', + 'title' => '启用通知类型', 'type' => 'array', - 'items' => [ - 'description' => 'Channel.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'SMS', - 'extendType' => 'true', - ], - 'backendName' => 'enabledSubChannels', + 'items' => ['description' => 'An enabled sub-channel.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'The enabled sub-channels.', + 'example' => '', ], 'receivers' => [ - 'title' => '', - 'description' => 'Channel recipient.', - 'visibility' => 'Public', + 'title' => '渠道接收方', 'type' => 'array', - 'items' => [ - 'description' => 'Recipient.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'user1', - 'extendType' => 'true', - ], - 'required' => true, - 'backendName' => 'receivers', + 'items' => ['description' => 'A receiver, which can be a user ID or a contact group ID.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'The list of receivers for the channel.', + 'example' => '', ], + ], + 'description' => 'The configuration for a single notification channel.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The notification channels for the route.', + 'example' => '', + ], + 'effectTimeRange' => [ + 'title' => '生效时段', + 'type' => 'object', + 'properties' => [ + 'dayInWeek' => [ + 'title' => '生效天(周一到周日)', + 'type' => 'array', + 'items' => ['description' => 'A day of the week, where 1 represents Monday and 7 represents Sunday.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + 'description' => 'The days of the week when the route is active.', + 'example' => '', + ], + 'endTimeInMinute' => ['title' => '结束时间(分钟数)', 'description' => 'The end time of the active period, specified in minutes from 00:00.', 'type' => 'integer', 'example' => '', 'format' => 'int32', 'maximum' => '1439', 'minimum' => '0'], + 'startTimeInMinute' => ['title' => '开始时间(分钟数)', 'description' => 'The start time of the active period, specified in minutes from 00:00.', 'type' => 'integer', 'example' => '', 'format' => 'int32', 'maximum' => '1438', 'minimum' => '0'], + 'timeZone' => ['title' => '时区', 'description' => 'The time zone for the active period. For example, \'Asia/Shanghai\'.', 'type' => 'string', 'example' => ''], + ], + 'description' => 'The time range during which the notification route is active.', + 'example' => '', + ], + 'filterSetting' => ['title' => '路由级 filter', 'description' => 'The filter settings for the route.', 'example' => '', '$ref' => '#/components/schemas/FilterSetting'], + 'severities' => [ + 'title' => '等级过滤', + 'type' => 'array', + 'items' => ['description' => 'An alert severity level, such as \'P1\' or \'Critical\'.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'The alert severities that trigger this route.', + 'example' => '', + ], + 'digitalEmployeeName' => ['title' => '数字员工名', 'description' => 'The name of the digital employee assigned to this route.', 'type' => 'string', 'example' => ''], + 'enableRca' => ['title' => '是否启用 RCA', 'description' => 'Specifies whether to enable root cause analysis (RCA) for alerts that match this route. Valid values: true, false.', 'type' => 'boolean', 'example' => ''], + ], + 'description' => 'The configuration for a single notification route.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The list of notification routes.', + 'example' => '', + ], + 'customTemplateEntries' => [ + 'title' => '通知渠道模板', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'targetType' => ['title' => '通知类型', 'description' => 'The target type for the custom template.', 'type' => 'string', 'example' => ''], + 'templateUuid' => ['title' => '模板UUID', 'description' => 'The unique identifier (UUID) of the template.', 'type' => 'string', 'example' => ''], + ], + 'description' => 'The settings for a custom template entry.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The list of custom templates.', + 'example' => '', + ], + 'createTime' => ['title' => '创建时间', 'description' => 'The creation time of the notification strategy.', 'type' => 'string', 'example' => ''], + 'updateTime' => ['title' => '更新时间', 'description' => 'The last update time of the notification strategy.', 'type' => 'string', 'example' => ''], + ], + 'example' => '', + ], + 'NotifyStrategyForView' => [ + 'title' => 'A short description of struct', + 'description' => 'An entity used for viewing.', + 'type' => 'object', + 'properties' => [ + 'createTime' => ['title' => '创建时间', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-03-11T08:21:58Z'], + 'description' => ['title' => '描述', 'description' => 'The description.', 'type' => 'string', 'example' => 'test'], + 'enable' => ['title' => '是否启用', 'description' => 'Indicates whether the policy is enabled.', 'type' => 'boolean', 'example' => 'false'], + 'groupingSetting' => [ + 'title' => '合并设置', + 'description' => 'The merge settings.', + 'type' => 'object', + 'properties' => [ + 'groupingKeys' => [ + 'title' => '合并keys', + 'description' => 'The merge keys.', + 'type' => 'array', + 'items' => ['description' => 'The merge key.', 'type' => 'string', 'title' => '', 'example' => 'severity'], + 'example' => '', + ], + 'periodMin' => ['title' => '检查周期分钟数', 'description' => 'The check period in minutes.', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'silenceSec' => ['title' => '沉默秒数', 'description' => 'The silence period in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '300'], + 'times' => ['title' => '触发次数', 'description' => 'The number of triggers.', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + ], + 'required' => true, + 'example' => '', + ], + 'ignoreRestoredNotification' => ['title' => '恢复是否通知', 'description' => 'Indicates whether to send a notification upon recovery.', 'type' => 'boolean', 'example' => 'true'], + 'notifyStrategyName' => ['title' => '名称', 'description' => 'The name.', 'type' => 'string', 'required' => true, 'example' => '测试策略'], + 'routes' => [ + 'title' => '通知渠道路由设置', + 'description' => 'The routing settings for notification channels.', + 'type' => 'array', + 'items' => [ + 'description' => 'The routing object.', + 'type' => 'object', + 'properties' => [ + 'channels' => [ + 'title' => '通知渠道', + 'description' => 'The notification channels.', + 'type' => 'array', + 'items' => [ + 'description' => 'The notification channel.', + 'type' => 'object', + 'properties' => [ 'channelType' => [ - 'title' => '', - 'description' => 'Channel type.', - 'visibility' => 'Public', + 'title' => '渠道类型', + 'description' => 'The channel type.', 'type' => 'string', 'required' => true, + 'enum' => ['DING', 'WEIXIN', 'FEISHU', 'SLACK', 'TEAMS', 'CONTACT', 'GROUP', 'DUTY', 'DING_COOL_APP'], 'example' => 'CONTACT', - 'backendName' => 'channelType', - 'enum' => [ - 'DING', - 'WEIXIN', - 'FEISHU', - 'SLACK', - 'TEAMS', - 'CONTACT', - 'GROUP', - 'DUTY', - ], + ], + 'enabledSubChannels' => [ + 'title' => '启用通知类型', + 'description' => 'The enabled notification types.', + 'type' => 'array', + 'items' => ['description' => 'The channel.', 'type' => 'string', 'title' => '', 'example' => 'SMS'], + 'example' => '', + ], + 'receivers' => [ + 'title' => '渠道接收方', + 'description' => 'The channel receivers.', + 'type' => 'array', + 'items' => ['description' => 'The receiver.', 'type' => 'string', 'title' => '', 'example' => 'user1'], + 'required' => true, + 'example' => '', ], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'channels', - ], - 'filterSetting' => [ - 'description' => 'Routing settings.', - 'visibility' => 'Public', - 'backendName' => 'filterSetting', - '$ref' => '#/components/schemas/FilterSetting', + 'example' => '', ], 'effectTimeRange' => [ - 'title' => '', - 'description' => 'Field.', - 'visibility' => 'Public', + 'title' => '字段', + 'description' => 'The field.', 'type' => 'object', 'properties' => [ - 'startTimeInMinute' => [ - 'title' => '', - 'description' => 'Start time (in minutes).', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '1438', - 'minimum' => '0', - 'example' => '60', - 'backendName' => 'startTimeInMinute', - ], - 'timeZone' => [ - 'title' => '', - 'description' => 'Time Zone.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '+08:00', - 'backendName' => 'timeZone', - ], 'dayInWeek' => [ - 'title' => '', - 'description' => 'Effective days (Monday to Sunday).', - 'visibility' => 'Public', + 'title' => '生效天(周一到周日)', + 'description' => 'The days of the week when the policy is effective (Monday to Sunday).', 'type' => 'array', - 'items' => [ - 'description' => '1–7 represents Monday to Sunday.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'extendType' => 'true', - ], - 'backendName' => 'dayInWeek', - ], - 'endTimeInMinute' => [ - 'title' => '', - 'description' => 'End time (in minutes).', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '1439', - 'minimum' => '0', - 'example' => '60', - 'backendName' => 'endTimeInMinute', + 'items' => ['description' => 'The day of the week. 1 indicates Monday, and 7 indicates Sunday.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'example' => '', ], + 'endTimeInMinute' => ['title' => '结束时间(分钟数)', 'description' => 'The end time in minutes.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1439', 'minimum' => '0', 'example' => '60'], + 'startTimeInMinute' => ['title' => '开始时间(分钟数)', 'description' => 'The start time in minutes.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1438', 'minimum' => '0', 'example' => '60'], + 'timeZone' => ['title' => '时区', 'description' => 'The time zone.', 'type' => 'string', 'example' => '+08:00'], ], - 'backendName' => 'effectTimeRange', + 'example' => '', ], + 'filterSetting' => ['description' => 'The routing settings.', '$ref' => '#/components/schemas/FilterSetting', 'title' => '', 'example' => ''], 'severities' => [ - 'description' => 'Severity level list.', - 'visibility' => 'Public', + 'description' => 'The list of severity levels.', 'type' => 'array', - 'items' => [ - 'description' => 'Severity levels: CRITICAL, WARNING, INFO.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'INFO', - 'extendType' => 'true', - ], - 'backendName' => 'severities', + 'items' => ['description' => 'The severity level. Valid values: CRITICAL, WARNING, and INFO.', 'type' => 'string', 'title' => '', 'example' => 'INFO'], + 'title' => '', + 'example' => '', ], + 'digitalEmployeeName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'enableRca' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], 'required' => true, - 'backendName' => 'routes', + 'example' => '', ], - 'workspace' => [ - 'title' => 'workspace', - 'description' => 'workspace', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'workspace-test', - 'backendName' => 'workspace', + 'customTemplateEntries' => [ + 'title' => '通知渠道模板', + 'description' => 'The notification channel templates.', + 'type' => 'array', + 'items' => [ + 'description' => 'The notification template configuration.', + 'type' => 'object', + 'properties' => [ + 'targetType' => ['title' => '通知类型', 'description' => 'The notification type.', 'type' => 'string', 'required' => true, 'example' => 'SMS'], + 'templateUuid' => ['title' => '模板UUID', 'description' => 'The template UUID.', 'type' => 'string', 'required' => true, 'example' => '123-12-312-312-31-23'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], - 'notifyStrategyName' => [ + 'updateTime' => ['title' => '更新时间', 'description' => 'The update time.', 'type' => 'string', 'example' => '2025-05-30T02:29:09Z'], + 'userId' => ['title' => '用户id', 'description' => 'The user ID.', 'type' => 'string', 'example' => '123123****'], + 'notifyStrategyId' => ['title' => 'UUID', 'description' => 'The UUID.', 'type' => 'string', 'example' => '12312-31-23-123-1-23123'], + 'workspace' => ['title' => 'workspace', 'description' => 'The workspace.', 'type' => 'string', 'example' => 'workspace-test'], + 'filterSetting' => ['description' => 'The filter settings.', '$ref' => '#/components/schemas/FilterSetting', 'title' => '', 'example' => ''], + 'workspaceFilterSetting' => ['description' => 'The workspace filter settings.', '$ref' => '#/components/schemas/WorkspaceFilterSetting', 'title' => '', 'example' => ''], + 'pushingSetting' => [ + 'type' => 'object', + 'properties' => [ + 'templateUuid' => ['description' => 'The template UUID.', 'type' => 'string', 'title' => '', 'example' => '"template-abc123"'], + 'alertActionIds' => [ + 'type' => 'array', + 'items' => ['description' => 'The alert action ID.', 'type' => 'string', 'title' => '', 'example' => '"action-123"'], + 'description' => 'The list of alert action IDs.', + 'title' => '', + 'example' => '', + ], + 'restoreActionIds' => [ + 'type' => 'array', + 'items' => ['description' => 'The recovery action ID.', 'type' => 'string', 'title' => '', 'example' => '"restore-789"'], + 'description' => 'The list of recovery action IDs.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The push settings.', 'title' => '', - 'description' => 'Name.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'Test policy.'."\n", - 'backendName' => 'notifyStrategyName', - ], - 'notifyStrategyId' => [ - 'title' => 'UUID', - 'description' => 'UUID', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '12312-31-23-123-1-23123', - 'backendName' => 'notifyStrategyId', + 'example' => '', ], - 'createTime' => [ + 'repeatNotifySetting' => [ + 'type' => 'object', + 'properties' => [ + 'endIncidentState' => ['description' => 'The event state at which to stop.', 'type' => 'string', 'title' => '', 'example' => '"Resolved"'], + 'repeatInterval' => ['description' => 'The interval for repeated notifications.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '5'], + ], + 'description' => 'The settings for repeated notifications.', 'title' => '', - 'description' => 'Create Time.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58Z', - 'backendName' => 'createTime', + 'example' => '', ], - 'enable' => [ + 'autoRecoverSeconds' => ['description' => 'The automatic recovery time.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '300'], + 'syncFromType' => ['description' => 'The source type of the synchronization policy.', 'type' => 'string', 'title' => '', 'example' => '"ARMS"'], + 'receiverNames' => [ + 'type' => 'array', + 'items' => ['description' => 'The receiver name.', 'type' => 'string', 'title' => '', 'example' => '"张三"'], + 'description' => 'The list of receiver names.', 'title' => '', - 'description' => 'Whether enabled.', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'enabled', + 'example' => '', ], - 'description' => [ + 'incidentEscalationPolicies' => [ + 'type' => 'array', + 'items' => ['description' => 'The escalation policy.', 'type' => 'any', 'title' => '', 'example' => '{ "name": "Critical-Escalation"}'], + 'description' => 'The list of associated escalation policies.', 'title' => '', - 'description' => 'Description.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test', - 'backendName' => 'description', + 'example' => '', ], - 'updateTime' => [ + ], + 'example' => '', + ], + 'NotifyStrategyIdFilter' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'eq' => ['title' => '', 'description' => 'The exact ID of the notification strategy to retrieve.', 'type' => 'string', 'example' => ''], + ], + 'description' => 'Filters notification strategies by ID.', + 'example' => '', + ], + 'ObserveGroup' => [ + 'type' => 'object', + 'properties' => [ + 'groupId' => ['title' => '', 'description' => 'The globally unique ID of the observability group. Format: og-<16-character hash>. Used uniformly across metrics, alerts, and consoles.', 'type' => 'string', 'example' => ''], + 'groupName' => ['title' => '', 'description' => 'The name of the observability group. Must be unique within the same workspace.', 'type' => 'string', 'example' => ''], + 'description' => ['title' => '', 'description' => 'The description of the observability group, which explains its business purpose.', 'type' => 'string', 'example' => ''], + 'resourceGroupId' => ['title' => '', 'description' => 'The Alibaba Cloud resource group ID.', 'type' => 'string', 'example' => ''], + 'aliUid' => ['title' => '', 'description' => 'The UID of the Alibaba Cloud account to which the group belongs.', 'type' => 'string', 'example' => ''], + 'regionId' => ['title' => '', 'description' => 'The region ID to which the group belongs.', 'type' => 'string', 'example' => ''], + 'createTime' => ['title' => '', 'description' => 'The creation time in UTC format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => ''], + 'modifyTime' => ['title' => '', 'description' => 'The last modification time in UTC format: yyyy-MM-ddTHH:mm:ssZ. Automatically updated when any resource attribute changes.', 'type' => 'string', 'example' => ''], + 'groupType' => ['title' => '', 'description' => 'The type of the observability group.', 'type' => 'string', 'example' => ''], + 'discoverRules' => [ 'title' => '', - 'description' => 'Update Time.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-05-30T02:29:09Z', - 'backendName' => 'updateTime', + 'description' => 'The list of entity discovery rules that define which entities the group automatically matches.', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ObserveGroupDiscoverRule'], + 'example' => '', ], - 'groupingSetting' => [ + 'extraInfo' => ['title' => '', 'description' => 'The extended information as a JSON string, which carries alert templates, alert contact groups, and suspension policies.', 'type' => 'string', 'example' => ''], + 'workspaceId' => ['title' => '', 'description' => 'The workspace ID to which the group belongs. This value is set at the workspace level and cannot be changed after creation.', 'type' => 'string', 'example' => ''], + 'sourceOrigin' => ['title' => '', 'description' => 'The data source. Valid values:'."\n" + .'- native_2_0: created natively in version 2.0.'."\n" + .'- synced_from_1_0: synchronized from a version 1.0 application group.', 'type' => 'string', 'example' => ''], + 'originGroupId' => ['title' => '', 'description' => 'The product_group.id of the version 1.0 application group. This parameter is valid only when sourceOrigin is set to synced_from_1_0.', 'type' => 'string', 'example' => ''], + 'entityCounts' => [ 'title' => '', - 'description' => 'Grouping Setting.', - 'visibility' => 'Public', + 'description' => 'The number of entities in each category. The key is the category domain (acs for cloud services, apm, or rum, which is extensible). The value is the number of entities in that category that belong to this group. Returned only when withEntityCount is set to true.', 'type' => 'object', - 'properties' => [ - 'groupingKeys' => [ - 'title' => '', - 'description' => 'Grouping Keys', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => 'Grouping Key.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'severity', - 'extendType' => 'true', - ], - 'backendName' => 'groupingKeys', - ], - 'times' => [ - 'title' => '', - 'description' => 'Trigger count.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'backendName' => 'times', - ], - 'periodMin' => [ - 'title' => '', - 'description' => 'Check interval in minutes.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'backendName' => 'periodMin', + 'additionalProperties' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'], + 'example' => '', + ], + 'health' => ['title' => '', 'description' => 'The health status of the group. Valid values:'."\n" + .'- -1: unknown (placeholder).'."\n" + .'- 1: healthy.'."\n" + .'- 0: unhealthy.', 'type' => 'integer', 'example' => '', 'format' => 'int32'], + 'favorited' => ['title' => '', 'description' => 'Indicates whether the current user has followed this group. This value is used as the filter criterion for the My Favorites feature.', 'type' => 'boolean', 'example' => ''], + 'ogEntityInfoEnabled' => ['title' => '', 'description' => 'Specifies whether og_entity_info metric output is enabled. When enabled, the data plane writes the group membership information to the target Prometheus instance.', 'type' => 'boolean', 'example' => ''], + 'ogEntityInfoPromInstances' => [ + 'title' => '', + 'description' => 'The set of Prometheus instances to which og_entity_info is written. Includes two source types: system (automatically identified by the system) and custom (user-defined).', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/ObserveGroupPromInstance', 'description' => '', 'title' => '', 'example' => ''], + 'example' => '', + ], + 'tags' => [ + 'title' => '', + 'description' => 'The resource tags (Alibaba Cloud standard tags) as an array of key-value pairs.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'tagKey' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'example' => ''], + 'tagValue' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'example' => ''], ], - 'silenceSec' => [ - 'title' => '', - 'description' => 'Silence duration in seconds.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '300', - 'backendName' => 'silenceSec', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ObserveGroupDetail' => [ + 'type' => 'object', + 'properties' => [ + 'groupId' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'groupName' => ['title' => '', 'description' => 'The name of the observability group. The name must be unique within the same workspace.', 'type' => 'string', 'example' => ''], + 'description' => ['title' => '', 'description' => 'The description of the observability group, which explains its business purpose.', 'type' => 'string', 'example' => ''], + 'resourceGroupId' => ['title' => '', 'description' => 'The Alibaba Cloud resource group ID.', 'type' => 'string', 'example' => ''], + 'aliUid' => ['title' => '', 'description' => 'The UID of the Alibaba Cloud account to which the group belongs.', 'type' => 'string', 'example' => ''], + 'regionId' => ['title' => '', 'description' => 'The region ID of the group.', 'type' => 'string', 'example' => ''], + 'groupType' => ['title' => '', 'description' => 'The type of the observability group.', 'type' => 'string', 'example' => ''], + 'createTime' => ['title' => '', 'description' => 'The time when the group was created, in UTC format (yyyy-MM-ddTHH:mm:ssZ).', 'type' => 'string', 'example' => ''], + 'modifyTime' => ['title' => '', 'description' => 'The time when the group was last modified, in UTC format (yyyy-MM-ddTHH:mm:ssZ). This value is automatically updated when any property of the resource changes.', 'type' => 'string', 'example' => ''], + 'discoverRules' => [ + 'title' => '', + 'description' => 'The list of entity discovery rules that define which entities the group automatically matches.', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ObserveGroupDiscoverRule'], + 'example' => '', + ], + 'extraInfo' => ['title' => '', 'description' => 'The extended information in JSON string format, which carries alert templates, alert contact groups, suspension policies, and other configurations.', 'type' => 'string', 'example' => ''], + 'workspaceId' => ['title' => '', 'description' => 'The workspace ID to which the group belongs. This value is set at the workspace level and cannot be changed after the group is created.', 'type' => 'string', 'example' => ''], + 'sourceOrigin' => ['title' => '', 'description' => 'The data source. Valid values:'."\n" + .'- native_2_0: created natively in version 2.0.'."\n" + .'- synced_from_1_0: synchronized from a version 1.0 application group.', 'type' => 'string', 'example' => ''], + 'originGroupId' => ['title' => '', 'description' => 'The product_group.id of the version 1.0 application group. This parameter is valid only when sourceOrigin is set to synced_from_1_0.', 'type' => 'string', 'example' => ''], + 'entitySummaries' => [ + 'title' => '', + 'description' => 'The statistics of entities in the group, categorized by entity type.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'entityDomain' => ['title' => '', 'description' => 'The entity domain.', 'type' => 'string', 'example' => ''], + 'entityType' => ['title' => '', 'description' => 'The entity type.', 'type' => 'string', 'example' => ''], + 'entityCount' => ['title' => '', 'description' => 'The number of entities.', 'type' => 'integer', 'example' => '', 'format' => 'int32'], + 'entityCategory' => ['title' => '', 'description' => 'The entity category.', 'type' => 'string', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'required' => true, - 'backendName' => 'groupingSetting', + 'example' => '', ], - 'customTemplateEntries' => [ + 'favorited' => ['title' => '', 'description' => 'Indicates whether the current user has followed the group.', 'type' => 'boolean', 'example' => ''], + 'ogEntityInfoEnabled' => ['title' => '', 'description' => 'Specifies whether to enable the og_entity_info metric output. When enabled, the data plane writes the group ownership information to the target Prometheus instance.', 'type' => 'boolean', 'example' => ''], + 'ogEntityInfoPromInstances' => [ 'title' => '', - 'description' => 'Notification channel template.', - 'visibility' => 'Public', + 'description' => 'The set of Prometheus instances to which og_entity_info is written. This includes two source types: system (automatically identified by the system) and custom (user-defined).', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/ObserveGroupPromInstance', 'description' => '', 'title' => '', 'example' => ''], + 'example' => '', + ], + 'tags' => [ + 'title' => '', + 'description' => 'The resource tags (Alibaba Cloud standard tags), represented as an array of key-value pairs.', 'type' => 'array', 'items' => [ - 'description' => 'Notification template configuration.', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'templateUuid' => [ + 'tagKey' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'example' => ''], + 'tagValue' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ObserveGroupDiscoverRule' => [ + 'type' => 'object', + 'properties' => [ + 'ruleId' => ['title' => '', 'description' => 'The stable rule ID used as an anchor for editing, deleting, and enabling or disabling operations. Format: dr-<16-character hash>.', 'type' => 'string', 'example' => ''], + 'ruleType' => ['title' => '', 'description' => 'The matching method. Valid values: byTag, byResourceGroup, byInstanceName, byManual, and bySpl.', 'type' => 'string', 'example' => ''], + 'scope' => ['title' => '', 'description' => 'The applicable scope. Valid values: all (all entity types, exclusive) and entity (specified entity types).', 'type' => 'string', 'example' => ''], + 'enabled' => ['title' => '', 'description' => 'Indicates whether the rule is enabled. If set to false, the data plane skips this rule and does not perform matching, tagging, or delivery.', 'type' => 'boolean', 'example' => ''], + 'gmtCreate' => ['title' => '', 'description' => 'The time when the rule was created, in UNIX millisecond timestamp format. This value is used for display in the console.', 'type' => 'integer', 'example' => '', 'format' => 'int64'], + 'entityType' => ['title' => '', 'description' => 'The entity type (legacy). Retained for backward compatibility. Use entityTypes instead.', 'type' => 'string', 'example' => ''], + 'entityTypes' => [ + 'title' => '', + 'description' => 'The list of entity types. A single rule can match multiple types, such as acs.ecs.instance, acs.rds.instance, and acs.arms.service.', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'example' => '', + ], + 'spl' => ['title' => '', 'description' => 'The full SPL expression for advanced configuration. If this parameter is not empty, it takes precedence over other filter fields.', 'type' => 'string', 'example' => ''], + 'userId' => ['title' => '', 'description' => 'The UID of the user to whom the rule belongs.', 'type' => 'string', 'example' => ''], + 'resourceGroupId' => ['title' => '', 'description' => 'The resource group ID used for filtering.', 'type' => 'string', 'example' => ''], + 'tagRules' => [ + 'title' => '', + 'description' => 'The tag matching rules.', + 'type' => 'object', + 'properties' => [ + 'op' => ['title' => '', 'description' => 'The tag matching logic.', 'type' => 'string', 'example' => ''], + 'tags' => [ + 'title' => '', + 'description' => 'The tag condition list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'tagKey' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'example' => ''], + 'op' => ['title' => '', 'description' => 'The matching operation.', 'type' => 'string', 'example' => ''], + 'tagValues' => [ + 'title' => '', + 'description' => 'The tag value list.', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'example' => '', + ], + ], + 'description' => '', 'title' => '', - 'description' => 'Template UUID.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '123-12-312-312-31-23', - 'backendName' => 'templateUuid', + 'example' => '', ], - 'targetType' => [ + 'example' => '', + ], + ], + 'example' => '', + ], + 'nameRules' => [ + 'title' => '', + 'description' => 'The name matching rules.', + 'type' => 'object', + 'properties' => [ + 'op' => ['title' => '', 'description' => 'The name matching logic.', 'type' => 'string', 'example' => ''], + 'tags' => [ + 'title' => '', + 'description' => 'The name condition list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'op' => ['title' => '', 'description' => 'The matching operation.', 'type' => 'string', 'example' => ''], + 'tagValues' => [ + 'title' => '', + 'description' => 'The matching value list.', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'example' => '', + ], + ], + 'description' => '', 'title' => '', - 'description' => 'Notification type.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'SMS', - 'backendName' => 'targetType', + 'example' => '', ], + 'example' => '', ], - 'extendType' => 'true', ], - 'backendName' => 'customTemplateEntries', + 'example' => '', ], - 'ignoreRestoredNotification' => [ + 'instanceIds' => [ 'title' => '', - 'description' => 'Whether to notify on recovery.', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'ignoreRestoredNotification', + 'description' => 'The list of manually specified instance IDs in enumeration mode, including instances synchronized manually in version 1.0.', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'example' => '', ], - 'userId' => [ + 'regionIds' => [ 'title' => '', - 'description' => 'User ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '123123****', - 'backendName' => 'userId', + 'description' => 'The list of region IDs used for filtering by region.', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'PrometheusManagedInstance' => [ + 'ObserveGroupInstance' => [ + 'type' => 'object', + 'properties' => [ + 'entityDomain' => ['title' => '', 'description' => 'The entity domain (such as acs).', 'type' => 'string', 'example' => ''], + 'entityType' => ['title' => '', 'description' => 'The entity type (such as acs.ecs.instance).', 'type' => 'string', 'example' => ''], + 'instanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => ''], + 'instanceName' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'example' => ''], + 'regionId' => ['title' => '', 'description' => 'The region ID of the instance.', 'type' => 'string', 'example' => ''], + 'resourceGroupId' => ['title' => '', 'description' => 'The resource group ID of the instance.', 'type' => 'string', 'example' => ''], + 'userId' => ['title' => '', 'description' => 'The UID of the user to which the instance belongs.', 'type' => 'string', 'example' => ''], + 'category' => ['title' => '', 'description' => 'The entity category (adapted by entityType).', 'type' => 'string', 'example' => ''], + 'groupId' => ['title' => '', 'description' => 'The ID of the observation group to which the entity belongs.', 'type' => 'string', 'example' => ''], + 'tags' => [ + 'title' => '', + 'description' => 'The key-value pairs of instance tags.', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'example' => '', + ], + 'dimension' => [ + 'title' => '', + 'description' => 'The key-value pairs of monitoring dimensions.', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ObserveGroupPromInstance' => [ + 'type' => 'object', + 'properties' => [ + 'id' => ['title' => '', 'description' => 'The ID of the Managed Service for Prometheus instance, such as rw-xxxxxxxxxx.', 'type' => 'string', 'example' => ''], + 'region' => ['title' => '', 'description' => 'The region where the Managed Service for Prometheus instance resides. If this parameter is left empty, the backend automatically populates the region based on the workspace to which the application group belongs.', 'type' => 'string', 'example' => ''], + 'kind' => ['title' => '', 'description' => 'The source of the instance. Valid values:'."\n" + .'- system: The system automatically identifies the instance based on the workspace or UModel.'."\n" + .'- custom: The user manually selects the instance in the console.', 'type' => 'string', 'example' => ''], + 'time' => ['title' => '', 'description' => 'The time when the record was written or selected. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'example' => ''], + ], 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ObserveResourceGlobalScopeFilter' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'eq' => ['title' => '', 'description' => 'Specifies whether to retrieve only resources that are exclusive to the global scope.', 'type' => 'boolean', 'example' => ''], + ], + 'description' => 'Defines the filter criteria for resources within the global scope.', + 'example' => '', + ], + 'ObserveResourceListFilter' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'contains' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['description' => 'A string value to match.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'Returns resources if a specified property contains any string in this array.', + 'example' => '', + ], + ], + 'description' => 'Filters for observed resources.', + 'example' => '', + ], + 'ObserveResourceTypeFilter' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'eq' => ['title' => '', 'description' => 'The exact resource type to query. Returns only resources of this type.', 'type' => 'string', 'example' => ''], + ], + 'description' => 'A filter for a resource type.', + 'example' => '', + ], + 'Pagination' => [ + 'description' => 'Details of the paginated response.', + 'type' => 'object', + 'properties' => [ + 'pageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + 'pageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + ], + 'title' => '', + 'example' => '', + ], + 'PartitionKeyFilter' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'eq' => ['title' => '', 'description' => 'Returns only items whose partition key value equals this string.', 'type' => 'string', 'example' => ''], + ], + 'description' => 'This filter routes requests directly to the correct physical partition, greatly improving query speed and lowering costs.', + 'example' => '', + ], + 'PrometheusManagedInstance' => [ + 'description' => 'The structure of a Prometheus managed instance.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'prometheusInstanceId' => [ + 'prometheusInstanceId' => ['title' => 'RUM关联的Prometheus实例ID', 'description' => 'The ID of the Prometheus instance that is associated with Real User Monitoring (RUM).', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'prometheusInstanceId', 'example' => 'rum-xxx'], + 'prometheusInstanceName' => ['title' => 'RUM关联的Prometheus实例名称', 'description' => 'The name of the Prometheus instance that is associated with RUM.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'prometheusInstanceName', 'example' => 'rum-xxx'], + 'regionId' => ['title' => '阿里云RegionId', 'description' => 'The ID of the Alibaba Cloud region.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'regionId', 'example' => 'cn-hangzhou'], + 'workspace' => ['title' => '云监控2.0 workspace', 'description' => 'The Cloud Monitor 2.0 workspace.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'workspace', 'example' => 'workspace-test'], + 'createTime' => ['title' => '创建时间', 'description' => 'The time when the instance was created.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'createTime', 'example' => '2025-03-11T08:21:58Z'], + 'instanceType' => ['title' => '实例类型', 'description' => 'The type of the instance.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'instanceType', 'example' => 'test'], + 'status' => ['title' => '实例状态', 'description' => 'The status of the instance.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'status', 'example' => 'Running'], + ], + 'title' => '', + 'example' => '', + ], + 'PromptTemplateItem' => [ + 'type' => 'object', + 'properties' => [ + 'role' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'content' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'PushingSetting' => [ + 'type' => 'object', + 'properties' => [ + 'templateUuid' => ['description' => 'The UUID of the message template.', 'type' => 'string', 'title' => '', 'example' => '"template-abc123"'], + 'alertActionIds' => [ + 'type' => 'array', + 'items' => ['description' => 'The alert action ID.', 'type' => 'string', 'title' => '', 'example' => '"action-123"'], + 'description' => 'The list of alert action IDs.', 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'rum-xxx', - 'backendName' => 'prometheusInstanceId', + 'example' => '', ], - 'prometheusInstanceName' => [ + 'restoreActionIds' => [ + 'type' => 'array', + 'items' => ['description' => 'The restore action ID.', 'type' => 'string', 'title' => '', 'example' => '"restore-789"'], + 'description' => 'The list of restore action IDs.', 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'rum-xxx', - 'backendName' => 'prometheusInstanceName', + 'example' => '', ], - 'regionId' => [ + ], + 'description' => 'The push settings object.', + 'title' => '', + 'example' => '', + ], + 'QueryAlertRulesFilter' => [ + 'description' => 'Filter conditions. Fields at the same level are combined with a logical AND.', + 'type' => 'object', + 'properties' => [ + 'uuid' => ['description' => 'Filters alert rules by UUID.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/UuidFilter'], + 'displayName' => ['description' => 'Filters alert rules by display name.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/DisplayNameFilter'], + 'labels' => ['description' => 'Filters alert rules by label.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/LabelsFilter'], + 'status' => ['description' => 'Filters alert rules by status.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/StatusFilter'], + 'enabled' => ['description' => 'Filters alert rules by enabled status.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/EnabledFilter'], + 'datasourceType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/DatasourceTypeFilter'], + 'observeResourceType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ObserveResourceTypeFilter'], + 'observeResourceGlobalScope' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ObserveResourceGlobalScopeFilter'], + 'observeResourceList' => ['$ref' => '#/components/schemas/ObserveResourceListFilter', 'description' => '', 'title' => '', 'example' => ''], + 'observeResourceInstanceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => 'i-bp1abcxxxxxxxx', 'deprecated' => true], + 'severityLevels' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/SeverityLevelsFilter'], + 'notifyStrategyId' => ['$ref' => '#/components/schemas/NotifyStrategyIdFilter', 'description' => '', 'title' => '', 'example' => ''], + 'partitionKey' => ['$ref' => '#/components/schemas/PartitionKeyFilter', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'QueryAlertRulesInput' => [ + 'description' => 'The request body of the QueryAlertRules operation.', + 'type' => 'object', + 'properties' => [ + 'filter' => ['description' => 'The filter criteria. Only alert rules that match these criteria are returned.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/QueryAlertRulesFilter'], + 'pagination' => ['description' => 'The pagination settings for the query. If omitted, the system returns the first page of results with the default page size.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/Pagination'], + 'workspace' => ['description' => 'The ID of the workspace that contains the alert rules.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'QueryAlertRulesResult' => [ + 'description' => 'The result of a query for alert rules.', + 'type' => 'object', + 'properties' => [ + 'totalCount' => ['description' => 'The total number of alert rules that match the query.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int64'], + 'alertRules' => [ + 'description' => 'The list of alert rules for the current page.', + 'type' => 'array', + 'items' => ['description' => 'An alert rule.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/AlertRuleV2'], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'QueryConfigUnified' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'type' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', 'type' => 'string', - 'example' => 'cn-hangzhou', - 'backendName' => 'regionId', + 'description' => '', + 'example' => '', + 'required' => true, + 'enum' => ['PROMETHEUS_SINGLE_QUERY', 'UMODEL_METRICSET_QUERY', 'UMODEL_LOGSET_QUERY', 'APM_MULTI_QUERY', 'CLOUD_MONITORING_QUERY', 'UMODEL_METRICSET_MULTI_QUERY', 'UNKNOWN_QUERY'], ], - 'workspace' => [ + 'expr' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'promQl' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => '', 'deprecated' => true], + 'enableDataCompleteCheck' => ['title' => '', 'type' => 'boolean', 'description' => '', 'example' => ''], + 'metricSet' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'metric' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'queries' => [ 'title' => '', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/MetricSetNamedQueryEntry', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', - 'visibility' => 'Public', + 'example' => '', + ], + 'logSet' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'windowSecs' => ['title' => '', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int64'], + 'offsetSecs' => ['title' => '', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int64'], + 'aggregate' => [ + 'title' => '', 'type' => 'string', - 'example' => 'workspace-test', - 'backendName' => 'workspace', + 'description' => '', + 'example' => '', + 'enum' => ['AVG', 'MAX', 'MIN', 'SUM', 'LAST'], ], - 'createTime' => [ + 'entityDomain' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'entityType' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'entityFilters' => [ 'title' => '', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/UmodelEntityFilter'], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58Z', - 'backendName' => 'createTime', + 'example' => '', ], - 'instanceType' => [ + 'labelFilters' => [ 'title' => '', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/UmodelLabelFilter'], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test', - 'backendName' => 'instanceType', + 'example' => '', ], - 'status' => [ + 'entityFields' => [ 'title' => '', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/UmodelEntityField'], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Running', - 'backendName' => 'status', + 'example' => '', ], - ], - ], - 'PushingSetting' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'templateUuid' => [ + 'serviceIdList' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"template-abc123"', - 'backendName' => 'templateUuid', + 'example' => '', ], - 'alertActionIds' => [ + 'filterList' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ApmFilterConfig'], 'description' => '', - 'visibility' => 'Public', + 'example' => '', + ], + 'measureList' => [ + 'title' => '', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"action-123"', - 'extendType' => 'true', - ], - 'backendName' => 'alertActionIds', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ApmMeasureConfig'], + 'description' => '', + 'example' => '', ], - 'restoreActionIds' => [ + 'namespace' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'relationType' => [ + 'title' => '', + 'type' => 'string', 'description' => '', - 'visibility' => 'Public', + 'example' => '', + 'enum' => ['INSTANCE', 'GROUP', 'USER'], + ], + 'dimensions' => [ + 'title' => '', 'type' => 'array', 'items' => [ + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"restore-789"', - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'restoreActionIds', + 'description' => '', + 'example' => '', ], + 'groupId' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'legacyType' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'legacyRaw' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], ], + 'description' => '', + 'example' => '', ], 'RepeatNotifySetting' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'endIncidentState' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"Resolved"', - 'backendName' => 'endIncidentState', - ], - 'repeatInterval' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '5', - 'backendName' => 'repeatInterval', - ], + 'endIncidentState' => ['description' => 'The state that ends the management event.', 'type' => 'string', 'title' => '', 'example' => '"Resolved"'], + 'repeatInterval' => ['description' => 'The interval between repeated notifications.', 'type' => 'string', 'title' => '', 'example' => '5'], ], + 'description' => 'The recurring notification settings object.', + 'title' => '', + 'example' => '', ], 'RumDnsResponse' => [ - 'description' => '', + 'description' => 'The domain name for RUM reporting.', + 'type' => 'object', + 'properties' => [ + 'domain' => ['title' => 'RUM上报域名', 'description' => 'The domain name for RUM reporting.', 'type' => 'string', 'example' => 'rum', 'visibility' => 'Public', 'backendName' => 'domain'], + 'result' => ['title' => '域名DNS初始化状态', 'description' => 'The DNS initialization status of the domain name.', 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public', 'backendName' => 'result'], + 'message' => ['title' => '初始化message（失败场景）', 'description' => 'The message returned if initialization fails.', 'type' => 'string', 'example' => '""', 'visibility' => 'Public', 'backendName' => 'message'], + ], + 'title' => '', + 'example' => '', 'visibility' => 'Public', + ], + 'ScheduleConfigUnified' => [ + 'description' => 'The scheduling configuration.', 'type' => 'object', 'properties' => [ - 'domain' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'type' => [ + 'description' => 'The type of the schedule.', 'type' => 'string', - 'example' => 'rum', - 'backendName' => 'domain', - ], - 'result' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'result', + 'example' => '', + 'required' => true, + 'enum' => ['FIXED'], ], - 'message' => [ + 'intervalSecs' => ['description' => 'The interval between scheduled runs, in seconds.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + ], + 'title' => '', + 'example' => '', + ], + 'ServerResponseManageAlertRulesResult' => [ + 'description' => 'The response object for the request.', + 'type' => 'object', + 'properties' => [ + 'data' => ['description' => 'The result of the operation.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ManageAlertRulesResult'], + 'code' => ['description' => 'The operation status code.', 'type' => 'string', 'title' => '', 'example' => ''], + 'success' => ['description' => 'Indicates whether the request succeeded (`true`) or failed (`false`).', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'requestId' => ['description' => 'The unique ID for the request. Provide this ID when contacting support for assistance.', 'type' => 'string', 'title' => '', 'example' => ''], + 'message' => ['description' => 'A message detailing the outcome of the request, such as a success message or an error description.', 'type' => 'string', 'title' => '', 'example' => ''], + 'total' => ['description' => 'The total number of entries that match the query.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + 'pageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + 'pageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + 'nextToken' => ['description' => 'The token used to retrieve the next page of results. If the token is not returned, there are no more results.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'ServerResponseQueryAlertRulesResult' => [ + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'data' => ['description' => 'The response payload.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/QueryAlertRulesResult'], + 'code' => ['description' => 'The status code of the response. A status code of `200` indicates a successful request.', 'type' => 'string', 'title' => '', 'example' => ''], + 'success' => ['description' => 'Indicates whether the request was successful. Valid values: `true` and `false`.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'requestId' => ['description' => 'The unique request ID, used for troubleshooting.', 'type' => 'string', 'title' => '', 'example' => ''], + 'message' => ['description' => 'The response message. If the request fails, this field contains details about the error.', 'type' => 'string', 'title' => '', 'example' => ''], + 'total' => ['description' => 'The total number of alert rules that match the query.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + 'pageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + 'pageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + 'nextToken' => ['description' => 'The token to retrieve the next page of results. A null value indicates that no more results are available.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'SeverityLevelsFilter' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'contains' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '""', - 'backendName' => 'message', + 'type' => 'array', + 'items' => ['description' => 'A single severity level. Common values include `FATAL`, `ERROR`, `WARN`, `INFO`, and `DEBUG`.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'Matches a log entry if its severity level appears in this array of strings.', + 'example' => '', ], ], + 'description' => 'Filters logs or events by severity level.', + 'example' => '', ], - 'SubscriptionForModify' => [ - 'title' => 'A short description of struct', - 'description' => 'Entity for viewing.', - 'visibility' => 'Public', + 'StatusFilter' => [ + 'description' => 'A filter used to query resources by status.', 'type' => 'object', 'properties' => [ - 'notifyStrategyId' => [ - 'title' => '', - 'description' => 'Notification policy UUID.', - 'visibility' => 'Public', + 'eq' => [ + 'description' => 'Filters the results to include only resources with the specified status.', 'type' => 'string', - 'example' => '123123', - 'backendName' => 'notifyStrategyId', - ], - 'subscriptionName' => [ 'title' => '', - 'description' => 'Name.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'Test subscription.'."\n", - 'backendName' => 'subscriptionName', + 'example' => '', + 'enum' => ['Alarm', 'Ok'], ], - 'description' => [ - 'title' => '', - 'description' => 'Description.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'workspace test', - 'backendName' => 'description', + ], + 'title' => '', + 'example' => '', + ], + 'SubscriptionAndNotifyStrategyForListView' => [ + 'title' => '订阅与通知策略详情视图', + 'description' => 'An output view of an aggregated entity, which includes its own fields such as notifyStrategyUuid, subscriptionUuid, migrationBatchId, and version.'."\n" + ."\n" + .'- Snapshots of child entities populated at runtime, such as notifyStrategy, subscription, subscriptions, and responsePlan.', + 'type' => 'object', + 'properties' => [ + 'uuid' => ['title' => '聚合实体 uuid', 'type' => 'string', 'description' => '', 'example' => ''], + 'name' => ['title' => '名称', 'type' => 'string', 'description' => '', 'example' => ''], + 'description' => ['title' => '描述', 'type' => 'string', 'description' => '', 'example' => ''], + 'enabled' => ['title' => '是否启用', 'type' => 'boolean', 'description' => '', 'example' => ''], + 'notifyStrategyUuid' => ['title' => '关联的 notifyStrategy uuid（与 responsePlan uuid 共享）', 'type' => 'string', 'description' => '', 'example' => ''], + 'subscriptionUuid' => ['title' => '直接绑定的主订阅 uuid（NOTIFY 形态下的 1:1 关联）', 'type' => 'string', 'description' => '', 'example' => ''], + 'migrationBatchId' => ['title' => '迁移批次 ID（用户自建为空；迁移产物有值）', 'type' => 'string', 'description' => '', 'example' => ''], + 'migrationMeta' => ['title' => '迁移元数据 JSON 字符串', 'type' => 'string', 'description' => '', 'example' => ''], + 'version' => ['title' => '乐观锁版本号', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int32'], + 'workspace' => ['title' => '工作空间标识', 'type' => 'string', 'description' => '', 'example' => ''], + 'userId' => ['title' => '所有者 userId', 'type' => 'string', 'description' => '', 'example' => ''], + 'createTime' => ['title' => '创建时间', 'type' => 'string', 'description' => '', 'example' => ''], + 'updateTime' => ['title' => '更新时间', 'type' => 'string', 'description' => '', 'example' => ''], + 'notifyStrategy' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/NotifyStrategyForSNSView'], + ], + 'example' => '', + ], + 'SubscriptionAndNotifyStrategyForModify' => [ + 'title' => '订阅与通知策略修改入参', + 'description' => 'The write payload for an aggregate entity, used for Create and Update operations.'."\n" + ."\n" + .'- **Create**: The `notifyStrategy` parameter is required. Provide either `subscription` (for a single main subscription) or `subscriptions`. The two parameters are mutually exclusive.'."\n" + ."\n" + .'- **Update**: The `uuid` and `version` parameters are required. The operation updates only the sub-entities you provide. For bulk changes to member subscriptions, use the `subscriptions` parameter (an array of `SubscriptionOp`).', + 'type' => 'object', + 'properties' => [ + 'uuid' => ['title' => '聚合实体 uuid', 'description' => 'Required for update operations but optional for create operations. If omitted during creation, the backend automatically generates a UUID.', 'type' => 'string', 'example' => ''], + 'version' => ['title' => '乐观锁版本号', 'description' => 'Required for update operations. The value must match the current version of the record. If the versions do not match, the request fails with an `OPTIMISTIC_LOCK_FAILED` error.', 'type' => 'integer', 'example' => '', 'format' => 'int32'], + 'name' => ['title' => '名称', 'description' => 'Optional. If omitted, the backend derives the name from `notifyStrategy`.', 'type' => 'string', 'example' => ''], + 'description' => ['title' => '描述', 'type' => 'string', 'description' => '', 'example' => ''], + 'enabled' => ['title' => '是否启用（创建时默认启用）', 'type' => 'boolean', 'description' => '', 'example' => ''], + 'notifyStrategy' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/NotifyStrategyForSNSModify'], + 'subscription' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/SubscriptionForSNSModify'], + 'subscriptions' => [ + 'title' => '成员订阅批量操作', + 'description' => 'For update operations only. Use this parameter to batch create, update, and remove member subscriptions.', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/SubscriptionOp'], + 'example' => '', ], - 'filterSetting' => [ - 'description' => 'Filtering settings.', - 'visibility' => 'Public', - 'backendName' => 'filterSetting', - '$ref' => '#/components/schemas/FilterSetting', + 'responsePlan' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/IncidentResponsePlanForSNSModify'], + ], + 'example' => '', + ], + 'SubscriptionAndNotifyStrategyForView' => [ + 'title' => '订阅与通知策略详情视图', + 'description' => 'The output view of an aggregate entity, including fields such as `notifyStrategyUuid`, `subscriptionUuid`, `migrationBatchId`, and `version`.'."\n" + ."\n" + .'- Snapshots of child entities populated at runtime (`notifyStrategy`, `subscription`, `subscriptions`, and `responsePlan`).', + 'type' => 'object', + 'properties' => [ + 'uuid' => ['title' => '聚合实体 uuid', 'type' => 'string', 'description' => '', 'example' => ''], + 'name' => ['title' => '名称', 'type' => 'string', 'description' => '', 'example' => ''], + 'description' => ['title' => '描述', 'type' => 'string', 'description' => '', 'example' => ''], + 'enabled' => ['title' => '是否启用', 'type' => 'boolean', 'description' => '', 'example' => ''], + 'notifyStrategyUuid' => ['title' => '关联的 notifyStrategy uuid（与 responsePlan uuid 共享）', 'type' => 'string', 'description' => '', 'example' => ''], + 'subscriptionUuid' => ['title' => '直接绑定的主订阅 uuid（NOTIFY 形态下的 1:1 关联）', 'type' => 'string', 'description' => '', 'example' => ''], + 'migrationBatchId' => ['title' => '迁移批次 ID（用户自建为空；迁移产物有值）', 'type' => 'string', 'description' => '', 'example' => ''], + 'migrationMeta' => ['title' => '迁移元数据 JSON 字符串', 'type' => 'string', 'description' => '', 'example' => ''], + 'version' => ['title' => '乐观锁版本号', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int32'], + 'workspace' => ['title' => '工作空间标识', 'type' => 'string', 'description' => '', 'example' => ''], + 'userId' => ['title' => '所有者 userId', 'type' => 'string', 'description' => '', 'example' => ''], + 'createTime' => ['title' => '创建时间', 'type' => 'string', 'description' => '', 'example' => ''], + 'updateTime' => ['title' => '更新时间', 'type' => 'string', 'description' => '', 'example' => ''], + 'subscription' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/SubscriptionForSNSView'], + 'responsePlan' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/IncidentResponsePlanForSNSView'], + 'notifyStrategy' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/NotifyStrategyForSNSView'], + 'subscriptions' => [ + 'title' => '全部成员订阅（含主订阅，反查得出）', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/SubscriptionForView'], + 'description' => '', + 'example' => '', ], + ], + 'example' => '', + ], + 'SubscriptionForModify' => [ + 'title' => '', + 'description' => 'The entity for viewing.', + 'type' => 'object', + 'properties' => [ + 'description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'workspace test'], + 'subscriptionName' => ['title' => '', 'description' => 'The name.', 'type' => 'string', 'required' => true, 'example' => '测试订阅'], + 'notifyStrategyId' => ['title' => '', 'description' => 'The UUID of the notification policy.', 'type' => 'string', 'example' => '123123'], + 'filterSetting' => ['description' => 'The filter settings.', '$ref' => '#/components/schemas/FilterSetting', 'title' => '', 'example' => ''], 'pushingSetting' => [ 'title' => '', - 'description' => 'Push settings.', - 'visibility' => 'Public', + 'description' => 'The push settings.', 'type' => 'object', 'properties' => [ - 'templateUuid' => [ + 'templateUuid' => ['title' => '', 'description' => 'The UUID of the template.', 'type' => 'string', 'example' => '123123123'], + 'alertActionIds' => [ 'title' => '', - 'description' => 'Template UUID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '123123123', - 'backendName' => 'templateUuid', + 'description' => 'The list of action plan IDs for alert pushing.', + 'type' => 'array', + 'items' => ['description' => 'The action integration ID.', 'type' => 'string', 'title' => '', 'example' => '123123123'], + 'example' => '', ], 'restoreActionIds' => [ 'title' => '', - 'description' => 'Action integration plan ID list.', - 'visibility' => 'Public', + 'description' => 'The list of action integration plan IDs for recovery pushing.', 'type' => 'array', - 'items' => [ - 'description' => 'Action integration plan ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '123123123', - 'extendType' => 'true', - ], - 'backendName' => 'restoreActionIds', - ], - 'responsePlanId' => [ - 'title' => '', - 'description' => 'Action plan ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '123123123', - 'backendName' => 'responsePlanId', + 'items' => ['description' => 'The action integration plan ID.', 'type' => 'string', 'title' => '', 'example' => '123123123'], + 'example' => '', ], - 'alertActionIds' => [ - 'title' => '', - 'description' => 'Alert push action plan ID list.', - 'visibility' => 'Public', + 'responsePlanId' => ['title' => '', 'description' => 'The action plan ID.', 'type' => 'string', 'example' => '123123123'], + ], + 'example' => '', + ], + 'workspaceFilterSetting' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/WorkspaceFilterSetting'], + 'agentConfig' => [ + 'type' => 'object', + 'properties' => [ + 'agentUuid' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'routes' => [ 'type' => 'array', - 'items' => [ - 'description' => 'Action integration ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '123123123', - 'extendType' => 'true', - ], - 'backendName' => 'alertActionIds', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/NotifyRouteForSubscription'], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'backendName' => 'pushingSetting', + 'description' => '', + 'title' => '', + 'example' => '', ], + 'subscribeLegacyEvent' => ['title' => '', 'description' => 'Specifies whether to subscribe to legacy product events (CMS 1.0, ARMS, or SLS events where workspace is null). Valid values:'."\n" + .'- true: Subscribe.'."\n" + .'- false or null: Do not subscribe.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', + ], + 'SubscriptionForSNSModify' => [ + 'title' => 'SNS 内嵌的订阅入参', + 'description' => 'Specifies the `subscription` child entity, which is an input parameter for the `SubscriptionAndNotifyStrategy` aggregation API.'."\n" + .'The API does not expose the following read-only backend fields:'."\n" + ."\n" + .'- `uuid` (auto-generated) and `name` (defaults to the primary SNS name, D9)'."\n" + ."\n" + .'- `regionId`, `mode` (BundleStrategy), and `subscriptionType` (forced to `NORMAL`; `AI_AGENT` is rejected, D10)'."\n" + ."\n" + .'- `agentConfig` (forced to `null`), `notifyStrategyUuid` (auto-bound), `syncFromType` (forced to `OBS`), and `enabled`', + 'type' => 'object', + 'properties' => [ + 'filterSetting' => ['title' => 'filter 配置', 'description' => '', 'example' => '', '$ref' => '#/components/schemas/FilterSetting'], + 'workspaceFilterSetting' => ['title' => 'workspace filter 配置', 'description' => '', 'example' => '', '$ref' => '#/components/schemas/WorkspaceFilterSetting'], + ], + 'example' => '', + ], + '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' => [ - 'title' => 'A short description of struct', - 'description' => 'Entity for viewing.', - 'visibility' => 'Public', + 'title' => '', + 'description' => 'The entity for viewing.', 'type' => 'object', 'properties' => [ - 'workspace' => [ - 'title' => 'workspace', - 'description' => 'workspace', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'workspace-test', - 'backendName' => 'workspace', - ], - 'notifyStrategyId' => [ - 'title' => '', - 'description' => 'Notification policy UUID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '23123123', - 'backendName' => 'notifyStrategyId', - ], - 'createTime' => [ - 'title' => '', - 'description' => 'Create Time.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58Z', - 'backendName' => 'createTime', - ], - 'enable' => [ - 'title' => '', - 'description' => 'Whether enabled.', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'enabled', - ], - 'subscriptionName' => [ - 'title' => '', - 'description' => 'Name.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'Subscription test.'."\n", - 'backendName' => 'subscriptionName', - ], - 'description' => [ - 'title' => '', - 'description' => 'Description.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'workspace test', - 'backendName' => 'description', - ], - 'filterSetting' => [ - 'description' => 'Filtering settings.', - 'visibility' => 'Public', - 'backendName' => 'filterSetting', - '$ref' => '#/components/schemas/FilterSetting', - ], - 'updateTime' => [ - 'title' => '', - 'description' => 'Update Time.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-05-23T02:29:02Z', - 'backendName' => 'updateTime', - ], - 'subscriptionId' => [ - 'title' => 'UUID', - 'description' => 'UUID', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '123123123123', - 'backendName' => 'subscriptionId', - ], - 'userId' => [ - 'title' => '', - 'description' => 'User ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '123123123', - 'backendName' => 'userId', - ], + 'createTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-03-11T08:21:58Z'], + 'description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'workspace test'], + 'enable' => ['title' => '', 'description' => 'Indicates whether the subscription is enabled.', 'type' => 'boolean', 'example' => 'false'], + 'subscriptionName' => ['title' => '', 'description' => 'The name.', 'type' => 'string', 'required' => true, 'example' => '订阅测试'], + 'notifyStrategyId' => ['title' => '', 'description' => 'The UUID of the notification policy.', 'type' => 'string', 'example' => '23123123'], + 'updateTime' => ['title' => '', 'description' => 'The update time.', 'type' => 'string', 'example' => '2025-05-23T02:29:02Z'], + 'userId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '123123123'], + 'subscriptionId' => ['title' => '', 'description' => 'UUID', 'type' => 'string', 'example' => '123123123123'], + 'workspace' => ['title' => '', 'description' => 'workspace', 'type' => 'string', 'example' => 'workspace-test'], + 'filterSetting' => ['description' => 'The filter settings.', '$ref' => '#/components/schemas/FilterSetting', 'title' => '', 'example' => ''], 'pushingSetting' => [ 'title' => '', - 'description' => 'Push settings.', - 'visibility' => 'Public', + 'description' => 'The push settings.', 'type' => 'object', 'properties' => [ - 'templateUuid' => [ + 'templateUuid' => ['title' => '', 'description' => 'The UUID of the template.', 'type' => 'string', 'example' => '123123123'], + 'alertActionIds' => [ 'title' => '', - 'description' => 'Template UUID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '123123123', - 'backendName' => 'templateUuid', + 'description' => 'The list of action integration IDs for alert pushing.', + 'type' => 'array', + 'items' => ['description' => 'The action integration ID.', 'type' => 'string', 'title' => '', 'example' => '123123123'], + 'example' => '', ], 'restoreActionIds' => [ 'title' => '', - 'description' => 'Recovery push action integration ID list.', - 'visibility' => 'Public', + 'description' => 'The list of action integration IDs for recovery pushing.', 'type' => 'array', - 'items' => [ - 'description' => 'Action integration ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '123123123', - 'extendType' => 'true', - ], - 'backendName' => 'restoreActionIds', + 'items' => ['description' => 'The action integration ID.', 'type' => 'string', 'title' => '', 'example' => '123123123'], + 'example' => '', ], - 'responsePlanId' => [ - 'title' => '', - 'description' => 'Action plan ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '123123123', - 'backendName' => 'responsePlanId', - ], - 'alertActionIds' => [ - 'title' => '', - 'description' => 'Alert push action integration ID list.', - 'visibility' => 'Public', + 'responsePlanId' => ['title' => '', 'description' => 'The action plan ID.', 'type' => 'string', 'example' => '123123123'], + ], + 'example' => '', + ], + 'syncFromType' => ['description' => 'The source type of the synchronization policy.', 'type' => 'string', 'title' => '', 'example' => '"ARMS"'], + 'workspaceFilterSetting' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/WorkspaceFilterSetting'], + 'subscriptionType' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => 'NORMAL', + 'default' => 'NORMAL', + 'enum' => ['NORMAL', 'AI_AGENT'], + ], + 'agentConfig' => [ + 'type' => 'object', + 'properties' => [ + 'agentUuid' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'routes' => [ 'type' => 'array', - 'items' => [ - 'description' => 'Action integration ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '123123123', - 'extendType' => 'true', - ], - 'backendName' => 'alertActionIds', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/NotifyRouteForSubscription'], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'backendName' => 'pushingSetting', + 'description' => '', + 'title' => '', + 'example' => '', ], + 'subscribeLegacyEvent' => ['title' => '', 'description' => 'Specifies whether to subscribe to legacy product events (CMS 1.0, ARMS, or SLS events where workspace is null). Valid values:'."\n" + .'- true: Subscribe.'."\n" + .'- false or null: Do not subscribe.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', + ], + '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' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'key' => [ - 'description' => '', - 'visibility' => 'Public', + 'key' => ['title' => '标签键', 'description' => 'The tag key.', 'type' => 'string', 'example' => 'env', 'maxLength' => 128], + 'value' => ['title' => '标签值', 'description' => 'The tag value.', 'type' => 'string', 'example' => 'test', 'maxLength' => 256], + ], + 'description' => 'The tag.', + 'title' => '标签', + 'example' => '', + ], + 'TagCondition' => [ + 'title' => '标签过滤条件', + 'description' => '基于 tag key/value 的过滤单元', + 'type' => 'object', + 'properties' => [ + 'key' => ['title' => '标签键', 'type' => 'string'], + 'op' => [ + 'title' => '操作符', 'type' => 'string', - 'example' => 'env', - 'maxLength' => 128, - 'backendName' => 'key', + 'enum' => ['EQ', 'EQI', 'START_WITH', 'END_WITH', 'CONTAIN', 'NOT_CONTAIN', 'IN', 'NOT_IN', 'EXIST'], ], - 'value' => [ + 'value' => ['title' => '标签值', 'type' => 'string'], + ], + ], + 'TagSelector' => [ + 'title' => '标签选择器', + 'description' => 'A tag-based selector defined by either `conditions` and `relation` or a custom `expression`.', + 'type' => 'object', + 'properties' => [ + 'conditions' => [ + 'title' => '标签过滤条件列表', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/TagCondition'], 'description' => '', - 'visibility' => 'Public', + 'example' => '', + ], + 'relation' => [ + 'title' => '条件关系', 'type' => 'string', - 'example' => 'test', - 'maxLength' => 256, - 'backendName' => 'value', + 'description' => '', + 'example' => '', + 'default' => 'AND', + 'enum' => ['AND', 'OR'], ], + 'expression' => ['title' => '自定义表达式（高级模式，覆盖 conditions+relation）', 'type' => 'string', 'description' => '', 'example' => ''], ], + 'example' => '', ], 'TransformAction' => [ - 'description' => '', + 'description' => 'The transform configuration.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'mapping' => [ - 'description' => '', + 'description' => 'The mapping configuration.', 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{"warning":"WARNING"}', - ], + 'additionalProperties' => ['description' => 'The severity level mapping configuration.', 'visibility' => 'Public', 'type' => 'string', 'title' => '', 'example' => '{"warning":"WARNING"}'], 'backendName' => 'mapping', + 'title' => '', + 'example' => '', ], - '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', - ], + 'variable' => ['description' => 'The variable name.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'variable', 'title' => '', 'example' => 'var1'], + 'filterSetting' => ['description' => 'The filter configuration.', 'visibility' => 'Public', 'backendName' => 'filterSetting', '$ref' => '#/components/schemas/FilterSetting', 'title' => '', 'example' => ''], + 'source' => ['description' => 'The reference path.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'source', 'title' => '', 'example' => 'data.subject'], + 'labelKey' => ['description' => 'The label name.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'labelKey', 'title' => '', 'example' => 'labelkey1'], + 'type' => ['description' => 'The transform type.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'type', 'title' => '', 'example' => 'SET_FIELD'], + 'value' => ['description' => 'The value to set.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'value', 'title' => '', 'example' => 'value1'], + 'regExp' => ['description' => 'The regular expression.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'regExp', 'title' => '', 'example' => '(.*):(.*)'], + 'target' => ['description' => 'The target location.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'target', 'title' => '', 'example' => 'SUBJECT'], ], + 'title' => '', + 'example' => '', ], 'TransformerForModify' => [ 'title' => 'A short description of struct', - 'description' => 'Data transformer.', - 'visibility' => 'Public', + 'description' => 'The data converter.', 'type' => 'object', 'properties' => [ - 'sortId' => [ - 'title' => '', - 'description' => 'Sort order.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'sortId', - ], - 'quitAfterMatch' => [ - 'title' => '', - 'description' => 'Exit after matching processing.', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'quitAfterMatch', - ], - 'description' => [ - 'title' => '', - 'description' => 'Description.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'workspace test', - 'backendName' => 'description', - ], - 'filterSetting' => [ - 'description' => 'Filter Setting.', - 'visibility' => 'Public', - 'backendName' => 'filterSetting', - '$ref' => '#/components/schemas/FilterSetting', - ], - 'transformerName' => [ - 'title' => '', - 'description' => 'Name.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'name', - 'backendName' => 'transformerName', - ], + 'sortId' => ['title' => '排序数', 'description' => 'The sort number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'visibility' => 'Public', 'backendName' => 'sortId'], + 'quitAfterMatch' => ['title' => '匹配处理后退出', 'description' => 'Specifies whether to exit after a match is processed.', 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public', 'backendName' => 'quitAfterMatch'], + 'description' => ['title' => '描述', 'description' => 'The description.', 'type' => 'string', 'example' => 'workspace test', 'visibility' => 'Public', 'backendName' => 'description'], + 'filterSetting' => ['description' => 'The filter criteria.', '$ref' => '#/components/schemas/FilterSetting', 'title' => '', 'example' => '', 'visibility' => 'Public', 'backendName' => 'filterSetting'], + 'transformerName' => ['title' => '名称', 'description' => 'The name.', 'type' => 'string', 'required' => true, 'example' => 'name', 'visibility' => 'Public', 'backendName' => 'transformerName'], 'actions' => [ - 'title' => '', - 'description' => 'Transformation operation.', - 'visibility' => 'Public', + 'title' => '转换操作', + 'description' => 'The transform operations.', 'type' => 'array', - 'items' => [ - 'description' => 'Processing action.', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/TransformAction', - ], + 'items' => ['description' => 'The transform action.', '$ref' => '#/components/schemas/TransformAction', 'title' => '', 'example' => '', 'visibility' => 'Public', 'extendType' => 'true'], + 'example' => '', + 'visibility' => 'Public', 'backendName' => 'actions', ], ], + 'example' => '', + 'visibility' => 'Public', ], 'TransformerForView' => [ 'title' => 'A short description of struct', - 'description' => 'Data transformer.', + 'description' => 'The data converter.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'workspace' => [ - 'title' => 'workspace', - 'description' => 'workspace', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'workspace-test', - 'backendName' => 'workspace', - ], - 'createTime' => [ - 'title' => '', - 'description' => 'Create Time.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58Z', - 'backendName' => 'createTime', - ], - 'enable' => [ - 'title' => '', - 'description' => 'Whether enabled.', + 'workspace' => ['title' => 'workspace', 'description' => 'The workspace.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'workspace', 'example' => 'workspace-test'], + 'createTime' => ['title' => '创建时间', 'description' => 'The time when the converter was created.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'createTime', 'example' => '2025-03-11T08:21:58Z'], + 'enable' => ['title' => '是否启用', 'description' => 'Indicates whether the converter is enabled.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'enabled', 'example' => 'false'], + 'sortId' => ['title' => '排序数', 'description' => 'The sort ID.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'sortId', 'example' => '1'], + 'transformerId' => ['title' => 'transformer Id', 'description' => 'The transformer ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'transformerId', 'example' => '1123123123123'], + 'quitAfterMatch' => ['title' => '匹配处理后退出', 'description' => 'Indicates whether to exit after a match is processed.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'quitAfterMatch', 'example' => 'false'], + 'description' => ['title' => '描述', 'description' => 'The description.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'example' => 'workspace test'], + 'filterSetting' => ['description' => 'The filter settings.', 'visibility' => 'Public', 'backendName' => 'filterSetting', '$ref' => '#/components/schemas/FilterSetting', 'title' => '', 'example' => ''], + 'updateTime' => ['title' => '更新时间', 'description' => 'The time when the converter was last updated.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'updateTime', 'example' => '2025-01-16T02:27:01Z'], + 'transformerName' => ['title' => '名称', 'description' => 'The name.', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'backendName' => 'transformerName', 'example' => '测试处理流'], + 'actions' => [ + 'title' => '转换操作', + 'description' => 'The transform operations.', 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'enabled', + 'type' => 'array', + 'items' => ['description' => 'The transform action.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/TransformAction', 'title' => '', 'example' => ''], + 'backendName' => 'actions', + 'example' => '', ], - 'sortId' => [ - 'title' => '', - 'description' => 'Sort order.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'sortId', - ], - 'transformerId' => [ - 'title' => 'transformer Id', - 'description' => 'transformer Id', - 'visibility' => 'Public', + 'userId' => ['title' => '用户id', 'description' => 'The user ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'userId', 'example' => '123123123**'], + ], + 'example' => '', + ], + 'UmodelEntityField' => [ + 'description' => 'The display configuration for a UModel entity field.', + 'type' => 'object', + 'properties' => [ + 'field' => ['description' => 'The name of the entity field.', 'type' => 'string', 'title' => '', 'example' => ''], + 'value' => ['description' => 'The field alias or display value.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'UmodelEntityFilter' => [ + 'description' => 'The filter to apply when querying entities. A filter consists of a `field`, an `operator`, and a `value`.', + 'type' => 'object', + 'properties' => [ + 'field' => ['description' => 'The field name to filter on.', 'type' => 'string', 'title' => '', 'example' => ''], + 'operator' => [ + 'description' => 'The comparison operator to use. Supported operators include `=`, `>`, `<`, `!=`, `IN`, and `NOT IN`.', 'type' => 'string', - 'example' => '1123123123123', - 'backendName' => 'transformerId', - ], - 'quitAfterMatch' => [ - 'title' => '', - 'description' => 'Exit after matching processing.', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'quitAfterMatch', - ], - 'description' => [ 'title' => '', - 'description' => 'Description.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'workspace test', - 'backendName' => 'description', - ], - 'filterSetting' => [ - 'description' => 'Filter Setting.', - 'visibility' => 'Public', - 'backendName' => 'filterSetting', - '$ref' => '#/components/schemas/FilterSetting', + 'example' => '', + 'enum' => ['=', '!='], ], - 'updateTime' => [ - 'title' => '', - 'description' => 'Update Time.', - 'visibility' => 'Public', + 'value' => ['description' => 'The value to compare the field against.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'UmodelLabelFilter' => [ + 'description' => 'A filter that selects resources based on a label. A label is a key-value pair that you can assign to resources.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The key of the label used for filtering.', 'type' => 'string', 'title' => '', 'example' => ''], + 'value' => ['description' => 'The value of the label to match.', 'type' => 'string', 'title' => '', 'example' => ''], + 'operator' => [ + 'description' => 'The logical operator used to compare the label\'s value.', 'type' => 'string', - 'example' => '2025-01-16T02:27:01Z', - 'backendName' => 'updateTime', - ], - 'transformerName' => [ 'title' => '', - 'description' => 'Name.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'Test processing flow.'."\n", - 'backendName' => 'transformerName', + 'example' => '', + 'enum' => ['=', '!='], ], - 'actions' => [ - 'title' => '', - 'description' => 'Transformation operation.', - 'visibility' => 'Public', + ], + 'title' => '', + 'example' => '', + ], + 'UuidFilter' => [ + 'description' => 'Contains the criteria for filtering by uuid.', + 'type' => 'object', + 'properties' => [ + 'eq' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'in' => [ 'type' => 'array', - 'items' => [ - 'description' => 'Processing action.', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/TransformAction', - ], - 'backendName' => 'actions', - ], - 'userId' => [ + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', 'title' => '', - 'description' => 'User ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '123123123**', - 'backendName' => 'userId', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], 'WorkspaceFilterSetting' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'tagSelector' => [ - 'description' => '', - 'visibility' => 'Public', - 'backendName' => 'tagSelector', - '$ref' => '#/components/schemas/FilterSetting', - ], + 'tagSelector' => ['description' => 'The tag filter.', '$ref' => '#/components/schemas/FilterSetting', 'title' => '', 'example' => ''], 'workspaceUuids' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"ws-abc123"', - 'extendType' => 'true', - ], - 'backendName' => 'workspaceUuids', + 'items' => ['description' => 'The workspace UUID.', 'type' => 'string', 'title' => '', 'example' => '"ws-abc123"'], + 'description' => 'A list of workspace UUIDs.', + 'title' => '', + 'example' => '', ], ], + 'description' => 'The workspace filter settings object.', + 'title' => '', + 'example' => '', ], ], ], 'apis' => [ - 'PutWorkspace' => [ - 'summary' => 'Create Workspace', - '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' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The context store name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-context-store', 'title' => ''], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => 'body参数', - 'description' => 'Body parameters', 'type' => 'object', 'properties' => [ - 'displayName' => [ - 'title' => '', - 'description' => 'Display name of the workspace', - 'type' => 'string', - 'required' => false, - 'example' => 'workspace-test', - 'maxLength' => 256, - ], - 'description' => [ - 'title' => '工作空间描述', - 'description' => 'Description of the workspace', - 'type' => 'string', - 'required' => false, - 'example' => 'workspace test', - 'maxLength' => 256, - 'pattern' => '', - 'default' => '', - ], - 'slsProject' => [ - 'title' => '日志服务项目名称', - 'description' => 'Name of the Log Service project', - 'type' => 'string', + 'contextType' => ['description' => 'The context type.', 'type' => 'string', 'required' => true, 'example' => 'memory', 'title' => ''], + 'memoryType' => ['description' => 'The memory type.', 'type' => 'string', 'required' => false, 'example' => 'short', 'title' => ''], + 'items' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'messages' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'The properties of the message, such as `role` and `content`.', 'type' => 'any', 'example' => '{"content":"xxxx","role":"xxxx"}', 'title' => ''], + 'description' => 'A single message object.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'description' => 'An array of message objects.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'content' => ['description' => 'The content of the context item.', 'type' => 'string', 'required' => false, 'example' => 'You are a conversation assistant.', 'title' => ''], + 'userId' => ['description' => 'The unique user ID.', 'type' => 'string', 'required' => false, 'example' => 'test_user_001', 'title' => ''], + 'agentId' => ['description' => 'The unique agent ID.', 'type' => 'string', 'required' => false, 'example' => '952730733889060865', 'title' => ''], + 'appId' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => 'mm_480d961a1b5e4efe84603f4cbc0f', 'title' => ''], + 'runId' => ['description' => 'The run ID.', 'type' => 'string', 'required' => false, 'example' => 'jr-80ded1d6953c64ea', 'title' => ''], + 'labels' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'A key-value pair representing a single label.', 'type' => 'string', 'example' => '{"key":"xxxx","value":"xxxx"}', 'title' => ''], + 'description' => 'A map of key-value pairs to apply as labels.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'metadata' => ['description' => 'Key-value pairs to store as metadata.', 'type' => 'object', 'required' => false, 'example' => '{"sessionId":"test_session_001"}', 'title' => ''], + 'infer' => ['description' => 'Specifies whether to perform inference based on the context. The default value is `false`.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'customInstructions' => ['description' => 'The custom instructions for processing the context.', 'type' => 'string', 'required' => false, 'example' => 'Your custom instructions here', 'title' => ''], + 'timestamp' => ['description' => 'The timestamp of the context item.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1774578167', 'title' => ''], + 'categories' => [ + 'type' => 'array', + 'items' => ['description' => 'A category name.', 'type' => 'string', 'required' => false, 'example' => '[]', 'title' => ''], + 'description' => 'A list of categories to apply to the context item.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'immutable' => ['description' => 'Specifies whether the context item is immutable. If set to `true`, the item cannot be changed after it is created. The default value is `false`.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'expirationDate' => ['description' => 'The expiration timestamp for the context item.', 'type' => 'string', 'required' => false, 'example' => '1731231212334396', 'title' => ''], + 'triggerCondition' => ['description' => 'The condition that triggers the context.', 'type' => 'string', 'required' => false, 'example' => 'Identify and troubleshoot SLs issues', 'title' => ''], + 'experience' => ['description' => 'An object containing experience information for the context.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "taskType": "troubleshooting",'."\n" + .' "complexity": "medium",'."\n" + .' "confidence": 0.95'."\n" + .'}', 'title' => ''], + ], + 'description' => 'A single context item.', + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => 'sls-project-test-001', - 'maxLength' => 128, - 'minLength' => 1, - 'default' => '', + 'description' => 'An array of context items.', + 'title' => '', + 'example' => '', ], ], + 'description' => 'The request body.', 'required' => false, - ], - ], - [ - 'name' => 'workspaceName', - 'in' => 'path', - 'schema' => [ - 'description' => 'Name of the workspace', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test-001', - 'maxLength' => 56, - 'minLength' => 1, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'ID of the request', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'workspaceName' => [ - 'description' => 'Name of the workspace.', - 'type' => 'string', - 'example' => 'workspace-test-001', + 'requestId' => ['description' => 'The unique ID for the request.', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8', 'title' => ''], + 'results' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'contextId' => ['description' => 'The ID of the written record or event.', 'type' => 'string', 'title' => '', 'example' => '897294a7-67a4-4f60-976c-e136edc5f97e'], + 'status' => ['description' => 'The write status. Can be "accepted", "queued", or "created".', 'type' => 'string', 'title' => '', 'example' => 'accepted'], + ], + 'description' => 'An object that represents a single result.', + 'title' => '', + 'example' => '', + ], + 'description' => 'An array of objects containing the results of the write operation.', + 'title' => '', + 'example' => '', ], ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'AddContexts', + 'summary' => 'Write to the context', + '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' => 'Create or Modify Workspace', - 'translator' => 'machine', + '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' => 'Get Workspace', - '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' => 'Workspace name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'memoryStoreName', + 'in' => 'path', + 'schema' => ['description' => 'Memory store name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-memory-store', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '实例 ID。', - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test-001', + 'type' => 'object', + 'properties' => [ + 'timestamp' => ['type' => 'integer', 'format' => 'int64', 'example' => '12312314214', 'description' => '', 'title' => ''], + 'asyncMode' => ['description' => 'Asynchronous mode.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'messages' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'content' => ['description' => 'Content.', 'type' => 'string', 'required' => false, 'example' => 'My name is Zhang San and I live in Hangzhou.', 'title' => ''], + 'role' => ['description' => 'Role.', 'type' => 'string', 'required' => false, 'example' => 'user', 'title' => ''], + ], + 'description' => 'Message.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'description' => 'Messages.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'userId' => ['description' => 'User ID.', 'type' => 'string', 'required' => false, 'example' => 'test_user_001', 'title' => ''], + 'agentId' => ['description' => 'Application agent ID.', 'type' => 'string', 'required' => false, 'example' => '952730733889060865', 'title' => ''], + 'appId' => ['description' => 'Application ID.', 'type' => 'string', 'required' => false, 'example' => 'mm_480d961a1b5e4efe84603f4cbc0f', 'title' => ''], + 'runId' => ['description' => 'Run ID.', 'type' => 'string', 'required' => false, 'example' => 'jr-80ded1d6953c64ea', 'title' => ''], + 'infer' => ['description' => 'Infer.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'customInstructions' => ['description' => 'Custom instructions.', 'type' => 'string', 'required' => false, 'example' => 'Your custom instructions here', 'title' => ''], + 'metadata' => ['description' => 'Metadata.', 'type' => 'object', 'required' => false, 'example' => '{"sessionId":"test_session_001"}', 'title' => ''], + ], + 'description' => 'Request body parameters.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'createTime' => [ - 'description' => 'Creation Time', - 'type' => 'string', - 'format' => 'iso8601_normal', - 'example' => '2025-03-11T08:21:58Z', - ], - 'description' => [ - 'title' => '工作空间描述', - 'description' => 'Workspace Description', - 'type' => 'string', - 'example' => 'workspace test', - 'pattern' => '', - 'default' => '', - ], - 'lastModifyTime' => [ - 'description' => 'Last Modified Time', - 'type' => 'string', - 'format' => 'iso8601_normal', - 'example' => '2025-03-11T08:21:58Z', - ], - 'regionId' => [ - 'title' => '地域ID', - 'description' => 'Region ID', - 'type' => 'string', - 'example' => 'cn-heyuan', - 'pattern' => '', - 'default' => '', - ], - 'requestId' => [ - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'slsProject' => [ - 'title' => '日志服务项目名称', - 'description' => 'Log Service Project Name', - 'type' => 'string', - 'example' => 'sls-project-test-001', - 'pattern' => '', - 'default' => '', - ], - 'workspaceName' => [ - 'title' => '工作空间名称', - 'description' => 'Workspace Name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test-001', - 'pattern' => '', - 'default' => '', - ], - 'displayName' => [ - 'description' => 'Workspace Display Name', - 'type' => 'string', - 'example' => 'workspace-test', + 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****', 'title' => ''], + 'results' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'message' => ['description' => 'Details.', 'type' => 'string', 'example' => 'Memory processing has been queued for background execution', 'title' => ''], + 'status' => ['description' => 'Processing status.', 'type' => 'string', 'example' => 'Pending', 'title' => ''], + 'eventId' => ['description' => 'Event ID.', 'type' => 'string', 'example' => '897294a7-67a4-4f60-976c-e136edc5f97e', 'title' => ''], + ], + 'description' => 'Request result.', + 'title' => '', + 'example' => '', + ], + 'description' => 'Request results.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'Response data.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'AddMemories', + 'summary' => 'Add new facts, messages, or metadata to a user’s memory store. The AddMemories endpoint accepts raw text or conversation turns and commits them asynchronously, preparing the memories for subsequent search, retrieval, and graph queries.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - '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' => 'Get Workspace', - 'translator' => 'machine', - ], - 'ListWorkspaces' => [ - 'summary' => 'Get Workspace List', - 'path' => '/workspace', - 'methods' => [ - 'get', - ], - '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' => 'Changes the resource group of a resource.', + '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' => 'Workspace name, fuzzy search', - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'resourceType' => ['description' => 'The resource type.', 'type' => 'string', 'required' => false, 'example' => 'Service', 'title' => ''], + 'resourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-ae******ey', 'title' => ''], + ], + 'description' => 'The request body.', 'required' => false, - 'example' => 'workspace-test-001', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'nextToken', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Pagination Token', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxxxxxxx', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + ], + 'title' => '', + 'description' => 'The schema of the response.', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ChangeResourceGroup', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + ], + 'CreateAddonRelease' => [ + 'summary' => 'Installs an add-on.', + 'path' => '/integration-policies/{policyId}/addon-releases', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'maxResults', - 'in' => 'query', - 'schema' => [ - 'description' => 'Page size'."\n" - .'Default value:'."\n" - .' 50'."\n" - .'Maximum value:'."\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' => 'Workspace name, exact match', - 'type' => 'array', - 'items' => [ - 'description' => 'Workspace name, exact match', - 'type' => 'string', - 'required' => false, - 'example' => 'workspace-test-001', + 'title' => '请求体参数。', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'addonName' => ['title' => '需要接入监控的组件 Addon 名称。', 'description' => 'The name of the add-on to integrate.', 'type' => 'string', 'required' => true, 'example' => 'cs-gpu'], + 'aliyunLang' => [ + 'title' => '组件的语言类型。', + 'description' => 'The language of the add-on.', + 'enumValueTitles' => ['en' => 'English', 'zh' => 'Chinese'], + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + 'dryRun' => [ + 'title' => '是否试运行，默认为 false。', + 'description' => 'Specifies whether to perform a dry run. The default value is false.', + 'enumValueTitles' => ['true' => 'Performs a dry run.', 'false' => 'Does not perform a dry run.'], + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'envType' => [ + 'title' => '环境类型。如果 Policy 类型为 CS 和 ECS，对应使用，其他类型统一为 Cloud。', + 'description' => 'The environment type. Set this parameter to CS for container environments or ECS for ECS environments. For all other environment types, set this parameter to Cloud.', + 'enumValueTitles' => ['CS' => 'container environment', 'ECS' => 'ECS environment', 'Cloud' => 'Alibaba Cloud service environment'], + 'type' => 'string', + 'required' => false, + 'example' => 'CS', + ], + 'parentAddonReleaseId' => ['title' => '父级 AddonReleaseId。', 'description' => 'The ID of the parent AddonRelease.', 'type' => 'string', 'required' => false, 'example' => 'policy-xxxxxxxxxxx'], + 'releaseName' => ['title' => '接入后的插件名称，如果不指定则生成默认规则名称。', 'description' => 'The name of the release after the integration. If you do not specify this parameter, a default name is generated.', 'type' => 'string', 'required' => false, 'example' => 'test-gpu-integration-name'], + 'values' => ['title' => '输入的元数据。', 'description' => 'The metadata.', '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' => 'The version of the add-on to integrate.', 'type' => 'string', 'required' => true, 'example' => '0.0.2'], + 'workspace' => ['title' => '安装组件资源的工作空间名称。'."\n", 'description' => 'The name of the workspace where the add-on is installed.', 'type' => 'string', 'required' => false, 'example' => 'default'], + 'entityRules' => ['title' => '实体发现规则。', 'description' => 'The entity discovery rules.', '$ref' => '#/components/schemas/EntityDiscoverRule', 'required' => false, 'example' => ''], ], 'required' => false, - 'example' => 'workspace-test-001', + 'example' => '', ], ], [ - 'name' => 'region', - 'in' => 'query', - 'schema' => [ - 'description' => 'Region', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-heyuan', - ], + 'name' => 'policyId', + 'in' => 'path', + 'schema' => ['title' => '环境策略 ID。', 'description' => 'The ID of the environment policy.', 'type' => 'string', 'required' => true, 'example' => 'policy-yyyyyyyyyy'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '返回数据。', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'maxResults' => [ - 'description' => 'Page size'."\n" - .'Default value:'."\n" - .' 50'."\n" - .'Maximum value:'."\n" - .' 50', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', + 'release' => [ + 'title' => '接入组件信息。', + 'description' => 'The information about the integrated add-on.', + 'type' => 'object', + 'properties' => [ + 'addonName' => ['title' => '接入监控的组件 Addon 名称。', 'description' => 'The name of the integrated add-on.', 'type' => 'string', 'example' => 'cs-gpu'], + 'alertRuleCount' => ['title' => '告警组数量。', 'description' => 'The number of alert rules.', 'type' => 'integer', 'format' => 'int64', 'example' => '6'], + 'conditions' => [ + 'title' => '组件安装阶段信息。', + 'description' => 'The information about the add-on installation phases.', + 'type' => 'array', + 'items' => [ + 'description' => 'The operator. The supported matching methods are exact match, prefix match, and regular expression.', + 'type' => 'object', + 'properties' => [ + 'firstTransitionTime' => ['title' => '第一次转换时间。', 'description' => 'The time when the phase first transitioned.', 'type' => 'string', 'example' => '2024-11-04T16:10:22+08:00'], + 'lastTransitionTime' => ['title' => '最后一次转换时间。', 'description' => 'The time when the phase last transitioned.', 'type' => 'string', 'example' => '2024-11-04T16:10:22+08:00'], + 'message' => ['title' => '详细信息。', 'description' => 'The details of the phase.', 'type' => 'string', 'example' => 'The addon loaded successfully'], + 'status' => ['title' => '阶段状态。', 'description' => 'The status of the phase.', 'type' => 'string', 'example' => '{\'phase\': \'Created\', \'executionDetails\': [], \'invocations\': [], \'latestExecError\': {\'message\': \'\', \'code\': \'\', \'requestId\': \'\', \'extraInfo\': \'\', \'title\': \'\'}}'], + 'type' => ['title' => '阶段类型。', 'description' => 'The type of the phase.', 'type' => 'string', 'example' => 'Loaded'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'config' => ['title' => '组件配置。', 'description' => 'The configuration of the add-on.', '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' => 'The time when the add-on was integrated.', 'type' => 'string', 'example' => '2024-11-05T15:21:30+08:00'], + 'dashboardCount' => ['title' => '大盘数量。', 'description' => 'The number of dashboards.', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'environmentId' => ['title' => '环境 ID。', 'description' => 'The environment ID.', 'type' => 'string', 'example' => 'policy-xxxxxxxxxxx'], + 'exporterCount' => ['title' => '插件数量。', 'description' => 'The number of exporters.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'haveConfig' => ['title' => '是否有配置。', 'description' => 'Indicates whether a configuration is available.', 'type' => 'boolean', 'example' => 'true'], + 'installUserId' => ['title' => '安装的用户 ID。', 'description' => 'The ID of the user who installed the add-on.', 'type' => 'string', 'example' => '1654218965xxxxxx'], + 'language' => ['title' => '语言。', 'description' => 'The language.', 'type' => 'string', 'example' => 'zh'], + 'managed' => ['title' => '是否为托管组件。', 'description' => 'Indicates whether the add-on is a managed add-on.', 'type' => 'boolean', 'example' => 'true'], + 'parentAddonReleaseId' => ['title' => '父级 AddonReleaseId。', 'description' => 'The ID of the parent AddonRelease.', 'type' => 'string', 'example' => 'policy-xxxxxxxxxxx'], + 'policyId' => ['title' => '策略环境 ID。', 'description' => 'The ID of the environment policy.', 'type' => 'string', 'example' => 'policy-xxxxxxxxxx'], + 'regionId' => ['title' => '地域 ID。', 'description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'releaseId' => ['title' => '安装后的 ReleaseID。', 'description' => 'The ID of the release.', 'type' => 'string', 'example' => '2e898e60-5e6a-46d1-a994-xxxxxxxxxx'], + 'releaseName' => ['title' => 'Release 的名称。', 'description' => 'The name of the release.', 'type' => 'string', 'example' => 'test-gpu-integration-name'], + 'scene' => ['title' => '组件场景。', 'description' => 'The scenario of the add-on.', 'type' => 'string', 'example' => '1'], + 'status' => ['title' => '组件状态。', 'description' => 'The status of the add-on.', 'type' => 'string', 'example' => '200'], + 'updateTime' => ['title' => '更新时间。', 'description' => 'The time when the add-on was last updated.', 'type' => 'string', 'example' => '2024-09-13T02:21:02Z'], + 'userId' => ['title' => '所属用户 ID。', 'description' => 'The user ID.', 'type' => 'string', 'example' => '165421896xxxxxx'], + 'version' => ['title' => '组件版本。', 'description' => 'The version of the add-on.', 'type' => 'string', 'example' => '1.0.0'], + 'envType' => ['title' => '环境类型。', 'description' => 'The environment type.', 'type' => 'string', 'example' => 'CS'], + 'workspace' => ['title' => '工作空间。', 'description' => 'The workspace.', 'type' => 'string', 'example' => 'default'], + 'entityRules' => ['title' => '实体详情。', 'description' => 'The details of the entity.', '$ref' => '#/components/schemas/EntityGroupBase', 'example' => ''], + ], + 'example' => '', ], - 'nextToken' => [ - 'description' => 'Pagination Token', + 'requestId' => ['title' => '请求 ID。', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0'], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Install Access Component', + 'description' => 'Creates a release for an add-on.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '210', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAddonRelease'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + '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' => 'Create an aggregation task group.', + 'path' => '/prometheus-instances/{instanceId}/agg-task-groups', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Source Prometheus instance ID of the aggregation task group.', 'type' => 'string', 'required' => true, 'example' => 'pq4apob9jm'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'Request body structure.', + 'type' => 'object', + 'properties' => [ + 'aggTaskGroupConfig' => ['title' => '', 'description' => 'Aggregation task group configuration.'."\n" + .'Currently only the "RecordingRuleYaml" format is supported, which must conform to the RecordingRule format requirements of open-source Prometheus.', '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' => '', 'description' => 'Aggregation task group configuration type. Default: "RecordingRuleYaml" (open-source Prometheus RecordingRule format).', 'type' => 'string', 'example' => 'RecordingRuleYaml', 'default' => 'RecordingRuleYaml', 'required' => false], + 'aggTaskGroupName' => ['title' => '', 'description' => 'Aggregation task group name.', 'type' => 'string', 'required' => true, 'example' => 'test-group'], + 'cronExpr' => ['title' => '', 'description' => 'The specific scheduling expression when the scheduling mode is set to "Cron". For example, "0/1 * * * *" means scheduling every 1 minute starting from minute 0.', 'type' => 'string', 'example' => '0/1 * * * *', 'required' => false], + 'delay' => ['title' => '', 'description' => 'Fixed delay time for scheduling. Unit: seconds. Default: 30.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '120', 'minimum' => '0', 'example' => '30', 'default' => '30', 'required' => false], + 'description' => ['title' => '', 'description' => 'Aggregation task group description.', 'type' => 'string', 'example' => 'desc', 'required' => false], + 'fromTime' => ['title' => '', 'description' => 'Second-level timestamp corresponding to the scheduling start time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1724996015', 'required' => false], + 'maxRetries' => ['title' => '', 'description' => 'Maximum number of retries for executing aggregation tasks. Default: 20.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'default' => '20', 'required' => false], + 'maxRunTimeInSeconds' => ['title' => '', 'description' => 'Maximum retry duration for executing aggregation tasks. Unit: seconds. Default: 600.', 'type' => 'integer', 'format' => 'int32', 'example' => '600', 'default' => '600', 'required' => false], + 'precheckString' => ['title' => '', 'description' => 'Pre-check configuration. Not configured by default. The input string must be valid JSON.', 'type' => 'string', '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"}', 'required' => false], + 'scheduleMode' => [ + 'title' => '', + 'description' => 'Scheduling mode. "Cron" or "FixedRate". Default: "FixedRate".', + 'enumValueTitles' => ['FixedRate' => 'Fixed rate', 'Cron' => 'Cron expression'], 'type' => 'string', - 'example' => 'xxxxxxxxxx', + 'required' => false, + 'example' => 'FixedRate', + 'default' => 'FixedRate', + 'enum' => ['FixedRate', 'Cron'], ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID'."\n" - ."\n", + 'scheduleTimeExpr' => ['title' => '', 'description' => 'Scheduling time expression. "@s" or "@m" is recommended, indicating the granularity of scheduling time window alignment. Default: "@m".', 'type' => 'string', 'example' => '@m', 'default' => '@m', 'required' => false], + 'status' => [ + 'title' => '', + 'description' => 'Aggregation task group status. "Running" or "Stopped". Default: Running.', + 'enumValueTitles' => ['Stopped' => 'Disabled', 'Running' => 'Enabled'], 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'total' => [ - 'title' => '当总结果个数大于MaxResults时，用于翻页的token。', - 'description' => 'Total count', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'example' => 'Running', + 'default' => 'Running', + 'enum' => ['Running', 'Stopped'], + 'required' => false, ], - 'workspaces' => [ - 'title' => '数组，返回示例目录。', - 'description' => 'List of workspaces', + 'tags' => [ + 'title' => '', + 'description' => 'Resource group tags.', 'type' => 'array', 'items' => [ - 'title' => 'WorkspaceItemType', - 'description' => 'WorkspaceItemType', + 'description' => 'Resource tag value.', 'type' => 'object', 'properties' => [ - 'createTime' => [ - 'description' => 'Creation time', - 'type' => 'string', - 'format' => 'iso8601_normal', - 'example' => '2025-03-11T08:21:58Z', - ], - 'displayName' => [ - 'description' => 'Workspace display name', - 'type' => 'string', - 'example' => 'workspace-test', - ], - 'description' => [ - 'title' => '工作空间描述', - 'description' => 'Workspace description', - 'type' => 'string', - 'example' => 'workspace test', - 'pattern' => '', - 'default' => '', - ], - 'lastModifyTime' => [ - 'description' => 'Last modified time', - 'type' => 'string', - 'format' => 'iso8601_normal', - 'example' => '2025-03-11T08:21:58Z', - ], - 'regionId' => [ - 'title' => '地域ID', - 'description' => 'Region ID', - 'type' => 'string', - 'example' => 'cn-heyuan', - 'pattern' => '', - 'default' => '', - ], - 'slsProject' => [ - 'title' => '日志服务项目名称', - 'description' => 'Log Service project name', - 'type' => 'string', - 'example' => 'sls-project-test-001', - 'pattern' => '', - 'default' => '', - ], - 'workspaceName' => [ - 'title' => '工作空间名称', - 'description' => 'Workspace name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test-001', - 'pattern' => '', - 'default' => '', - ], + 'key' => ['title' => '', 'description' => 'Key of the resource group tag.', 'type' => 'string', 'required' => false, 'example' => 'key1'], + 'value' => ['title' => '', 'description' => 'Value of the resource group tag.', 'type' => 'string', 'required' => false, 'example' => 'value1'], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'example' => '', ], + 'targetPrometheusId' => ['title' => '', 'description' => 'Target Prometheus instance ID of the aggregation task group.', 'type' => 'string', 'required' => true, 'example' => 'rw-pq4apob9jm'], + 'toTime' => ['title' => '', 'description' => 'Second-level timestamp corresponding to the scheduling end time. 0 means scheduling will not stop.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'required' => false], ], + 'required' => false, + 'example' => '', ], ], + [ + 'name' => 'overrideIfExists', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Whether to override and update when a resource with the same name exists during aggregation task group creation.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true'], + ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Response body structure.', + 'type' => 'object', + 'properties' => [ + 'aggTaskGroupConfigHash' => ['title' => '', 'description' => 'Digest of the aggregation task group configuration.', 'type' => 'string', 'example' => 'a54136014dc386a92c83a6ef1e97ff22'], + 'aggTaskGroupId' => ['title' => '', 'description' => 'Aggregation task group ID.', 'type' => 'string', 'example' => 'aggTaskGroup-f4b8e50525cf41c894488c0c71ec483f'], + 'aggTaskGroupName' => ['title' => '', 'description' => 'Aggregation task group name.', 'type' => 'string', 'example' => 'pipeline-aggtask-group'], + 'requestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '16C0A6D6-C3E7-511D-A60B-A87FD85F5BA7'], + 'sourcePrometheusId' => ['title' => '', 'description' => 'Source Prometheus instance ID of the aggregation task group.', 'type' => 'string', 'example' => 'rw-ecc04af14729b1a16e40a0d10068'], + 'status' => ['title' => '', 'description' => 'Current status of the aggregation task group.', 'type' => 'string', 'example' => 'Pending2Running'], + ], + 'example' => '', + ], + ], ], - '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' => 'Get Workspace List', - 'translator' => 'machine', - ], - 'DeleteWorkspace' => [ - 'summary' => 'Delete Workspace', - 'path' => '/workspace/{workspaceName}', - 'methods' => [ - 'delete', + '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' => 'Create Aggregation Task Group', + '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' => 'Create a webhook', + 'path' => '/webhook', + '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', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'workspaceName', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '实例 ID。', - 'description' => 'Workspace Name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test-001', + 'description' => 'The request parameters.', + 'type' => 'object', + 'properties' => [ + 'contentType' => [ + 'description' => 'The content type. Valid values:'."\n" + ."\n" + .'- JSON (default)'."\n" + ."\n" + .'- FORM', + 'type' => 'string', + 'default' => 'JSON', + 'enum' => ['JSON', 'FORM'], + 'required' => false, + 'example' => 'JSON', + 'title' => '', + ], + 'headers' => [ + 'description' => 'The headers.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'The header.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'lang' => [ + 'description' => 'The language. Valid values:'."\n" + ."\n" + .'- zh\\_CN'."\n" + ."\n" + .'- en\\_US', + 'type' => 'string', + 'enum' => ['zh_CN', 'en_US'], + 'required' => false, + 'example' => 'zh_CN', + 'title' => '', + ], + 'method' => [ + 'description' => 'The request method. Valid values:'."\n" + ."\n" + .'- GET'."\n" + ."\n" + .'- POST', + 'type' => 'string', + 'required' => false, + 'default' => 'POST', + 'enum' => ['GET', 'POST'], + 'example' => 'GET', + 'title' => '', + ], + 'name' => ['description' => 'The name of the webhook.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], + 'url' => ['description' => 'The URL for the alert callback.', 'type' => 'string', 'required' => true, 'example' => 'https://aliyun.com/test', 'title' => ''], + 'webhookId' => ['description' => 'The unique ID of the webhook.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'workspace' => ['type' => 'string', 'example' => 'my-workspace', 'description' => '', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -7700,320 +6372,363 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'alertWebhookId' => ['description' => 'The unique ID of the webhook.', 'type' => 'string', 'example' => 'test', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', - 'title' => 'Delete Workspace', - 'translator' => 'machine', - ], - 'CreateCloudResource' => [ - 'summary' => '创建云资源中心', - 'path' => '/cloudresource', - 'methods' => [ - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resource already exist .', 'description' => 'The resource already exists.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateAlertWebhook', + 'description' => 'Creates an alert webhook to use as a notification recipient.', + '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', - ], + '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' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'workspace' => ['type' => 'string', 'description' => 'The workspace.', 'required' => false, 'title' => '', 'example' => 'default-cms-xxxxxxx-cn-hangzhou'], + 'bizTraceCode' => ['type' => 'string', 'description' => 'The identifier for the business trace. It can contain only letters, digits, and underscores (\\_). The first character must be a lowercase letter.', 'required' => false, 'title' => '', 'example' => 'label_env'], + 'bizTraceName' => ['type' => 'string', 'description' => 'The name of the business trace.', 'required' => false, 'title' => '', 'example' => 'just test'], + 'ruleConfig' => ['type' => 'string', 'description' => 'The configuration rules.', 'required' => false, 'title' => '', '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' => ['type' => 'string', 'description' => 'The advanced configuration.', 'required' => false, 'title' => '', 'example' => '{"sample":{"strategy":"BY_APP"}}'], + ], + 'description' => 'The request body.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], + 'requestId' => ['type' => 'string', 'description' => 'The ID of the request.', 'title' => '', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'bizTraceId' => ['type' => 'string', 'description' => 'The ID of the business trace.', 'title' => '', 'example' => 'e339260ed64c95d'], ], + 'title' => '', + 'description' => 'The response schema.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateBizTrace', + 'summary' => 'Creates a business trace.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"bizTraceId\\": \\"e339260ed64c95d\\"\\n}","type":"json"}]', ], - 'GetCloudResource' => [ - 'summary' => '查询云资源中心', + 'CreateCloudResource' => [ 'path' => '/cloudresource', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + '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', - 'abilityTreeNodes' => [ - 'FEATUREcms5OJOSH', - ], - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-heyuan', - ], - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', - ], - 'GetCloudResourceData' => [ - 'summary' => '查询云资源中心数据', - 'path' => '/cloudresource/data', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateCloudResource', + 'summary' => 'Creates a cloud resource.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateCloudResource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'CloudResource', 'arn' => 'acs:cms:{#regionId}:{#accountId}:cloudresource'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', + ], + 'CreateContextStore' => [ + 'summary' => 'Creates a context store.', + 'path' => '/workspace/{workspace}/contextstore', + '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' => 'free', 'autoTest' => true], 'parameters' => [ [ - 'name' => 'from', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1721767203', - ], - ], - [ - 'name' => 'to', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1721767203', - ], + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], ], [ - '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', + 'type' => 'object', + 'properties' => [ + 'contextStoreName' => ['description' => 'The name of the context store.', 'type' => 'string', 'required' => true, 'example' => 'test-context-store', 'title' => ''], + 'contextType' => ['description' => 'The type of the context store.', 'type' => 'string', 'required' => true, 'example' => 'memory', 'title' => ''], + 'description' => ['description' => 'The description of the context store.', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''], + 'config' => [ + 'type' => 'object', + 'properties' => [ + 'source' => [ + 'type' => 'object', + 'properties' => [ + 'project' => ['description' => 'The name of the Log Service project.', 'type' => 'string', 'required' => false, 'example' => 'sls-test-project', 'title' => ''], + 'logstore' => ['description' => 'The name of the Log Service Logstore.', 'type' => 'string', 'required' => false, 'example' => 'sls-test-logstore', 'title' => ''], + 'startTime' => ['description' => 'The effective start time.', 'type' => 'string', 'format' => 'iso8601_normal', 'required' => false, 'example' => '1751508233000', 'title' => ''], + ], + 'description' => 'The configuration source.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'metadataField' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'A key-value map that defines the metadata fields and their corresponding data sources.', 'type' => 'string', 'example' => ' {'."\n" + .' "project": "attributes.project",'."\n" + .' "logstore": "attributes.logstore",'."\n" + .' "agentId": "attributes.agent_id",'."\n" + .' "scene": "attributes.scene"'."\n" + .' }', 'title' => ''], + 'description' => 'The metadata fields.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The configuration.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'dataset' => [ + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the dataset.', 'type' => 'string', 'required' => false, 'example' => 'test_dataset', 'title' => ''], + ], + 'description' => 'The properties of the dataset.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The request body.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - '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' => '', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E5B1D3D4-BB28-5996-8AD2-***********', 'title' => ''], ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateContextStore', + '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"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E5B1D3D4-BB28-5996-8AD2-***********\\"\\n}","type":"json"}]', ], - 'DeleteCloudResource' => [ - 'summary' => '删除云资源中心', - 'path' => '/cloudresource', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'CreateContextStoreAPIKey' => [ + 'summary' => 'Creates an API key for a context store.', + 'path' => '/workspace/{workspace}/contextstore/{contextStoreName}/apikey', + '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'], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The context store name.', 'type' => 'string', 'required' => true, 'example' => 'test-context-store', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The display name of the API key. Use this name to identify its purpose.', 'type' => 'string', 'required' => true, 'example' => 'Production Service Key', 'title' => ''], + ], + 'description' => 'The request body.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '3B311FD9-A60B-55E0-A896-A0C73*********'], + 'apiKey' => ['description' => 'The value of the API key. This value is returned only upon creation. Store it in a secure location.', 'type' => 'string', 'example' => 'sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', 'title' => ''], + 'name' => ['description' => 'The display name of the API key.', 'type' => 'string', 'example' => 'Production Service Key', 'title' => ''], ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateContextStoreAPIKey', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3B311FD9-A60B-55E0-A896-A0C73*********\\",\\n \\"apiKey\\": \\"sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\\",\\n \\"name\\": \\"Production Service Key\\"\\n}","type":"json"}]', ], - 'CreateEntityStore' => [ - 'summary' => 'Create storage related to EntityStore', - 'path' => '/workspace/{workspaceName}/entitystore', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateDataset' => [ + 'summary' => 'Creates a dataset.', + 'path' => '/workspace/{workspace}/dataset', + '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' => 'workspaceName', + 'name' => 'workspace', 'in' => 'path', + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'workspace name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test-001', + 'type' => 'object', + 'properties' => [ + 'datasetName' => ['description' => 'The name of the dataset.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test_dataset', 'title' => ''], + 'description' => ['description' => 'The description of the dataset.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'schema' => [ + 'type' => 'object', + 'required' => true, + 'additionalProperties' => ['description' => 'The definition of a field in the schema.', '$ref' => '#/components/schemas/IndexKey', 'title' => '', 'example' => ''], + 'description' => 'The schema of the dataset.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The request body.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -8022,64 +6737,130 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'request ID', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'workspaceName' => [ - 'description' => 'workspace name', - 'type' => 'string', - 'example' => 'workspace-test-001', - ], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], ], + 'title' => '', + 'description' => 'The data returned.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateDataset', + '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' => 'Create EntityStore', - 'translator' => 'machine', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', ], - 'GetEntityStore' => [ - 'summary' => 'Get EntityStore related storage information', - 'path' => '/workspace/{workspaceName}/entitystore', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CreateDeliveryTask' => [ + 'summary' => 'Create a data delivery task to deliver metric data from a data source to a storage destination or message queue. This task supports three delivery types: Prometheus Remote Write, Kafka, and MaxCompute. You can also use tags to filter which metrics are delivered and attach custom tags to them.', + 'path' => '/delivery-tasks', + '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' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'workspaceName', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'Workspace name'."\n" - ."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test-001', + 'type' => 'object', + 'properties' => [ + 'taskName' => ['description' => 'The name of the task. The name can contain Chinese characters, English letters, underscores (\\_), and hyphens (-).', 'type' => 'string', 'required' => true, 'example' => 'my-task', 'title' => ''], + 'dataSourceId' => ['description' => 'The ID of the Prometheus instance that serves as the data source.', 'type' => 'string', 'required' => true, 'example' => 'rw-xxxxxx', 'title' => ''], + 'taskDescription' => ['description' => 'The task description.', 'type' => 'string', 'required' => false, 'example' => 'my delivery task', 'title' => ''], + 'labelFiltersType' => [ + 'description' => 'The mode for applying the label filters.', + 'type' => 'string', + 'enum' => ['Allow', 'Deny'], + 'required' => false, + 'example' => 'Allow', + 'title' => '', + ], + 'labelFilters' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'A key-value pair that specifies a filter condition. For example, `__name__: up` or `job: my_job`.', 'type' => 'string', 'example' => '__name__: up', 'title' => ''], + 'description' => 'The label conditions for filtering metrics. The key is the label name and the value is the value to match. The filtering behavior is controlled by `labelFiltersType`.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'externalLabels' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'A key-value pair for an external label. For example, `region: cn-hangzhou`.', 'type' => 'string', 'example' => 'region: cn-hangzhou', 'title' => ''], + 'description' => 'A map of key-value pairs to attach as additional labels to all delivered metrics.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'sinkList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'sinkType' => [ + 'description' => 'The type of the delivery destination (sink).', + 'type' => 'string', + 'required' => true, + 'enum' => ['Prometheus', 'AcsMaxCompute', 'AcsKafka'], + 'example' => 'Prometheus', + 'title' => '', + ], + 'sinkConfigs' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'A configuration setting for the sink. The available settings depend on the `sinkType`.', 'type' => 'string', 'example' => 'Url: http://xxxx/api/v1/write', 'title' => ''], + 'description' => 'The configuration for the sink, specified as key-value pairs. The valid keys and values depend on the value of `sinkType`.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => true, + 'description' => 'An object that contains the configuration for a delivery destination.', + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'description' => 'An array of delivery destination objects.', + 'title' => '', + 'example' => '', + ], + 'resourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-ae******ey', 'title' => ''], + 'tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The key of the resource tag.', 'type' => 'string', 'required' => false, 'example' => '_cms_workspace', 'title' => ''], + 'value' => ['description' => 'The value of the resource tag.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + 'description' => 'A resource tag, specified as a key-value pair.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'description' => 'An array of resource tags.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The request body.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -8088,115 +6869,179 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'description' => 'Region ID', - 'type' => 'string', - 'example' => 'cn-heyuan', - ], - 'requestId' => [ - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'."\n", - ], - 'workspaceName' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'example' => 'workspace-test-001', - ], + 'requestId' => ['description' => 'The unique ID for the request.', 'type' => 'string', 'title' => '', 'example' => '4CB23A2E-B426-5D4B-9AA2-6C7A508D954B'], + 'taskId' => ['description' => 'The ID of the delivery task.', 'type' => 'string', 'example' => '98e367d8fb8cc83b', 'title' => ''], ], + 'title' => '', + 'description' => 'The data returned in the response.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\\\n\\",\\n \\"workspaceName\\": \\"workspace-test-001\\"\\n}","type":"json"}]', - 'title' => 'Get EntityStore', - 'translator' => 'machine', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateDeliveryTask', + 'requestParamsDescription' => '### SinkConfigs parameters'."\n" + ."\n" + .'**sinkType = Prometheus**'."\n" + ."\n" + .'| Key | Required | Description | Example value | Enumerated values |'."\n" + .'| --------------- | -------- | ------------------------------------------------------------------------- | --------------------------- | ---------------------------------------------------------------------------- |'."\n" + .'| Url | Yes | Remote Write endpoint. | `http://xxxx/api/v1/write` | |'."\n" + .'| Network | No | Network type. | `PublicNetwork` | \\- PublicNetwork (public network)<br>\\- PrivateNetwork (private network/VPC) |'."\n" + .'| VpcId | No | VPC ID. Required if `Network` is `PrivateNetwork`. | `vpc-xxxxxx` | |'."\n" + .'| VSwitchId | No | VSwitch ID. | `vsw-xxxxxx` | |'."\n" + .'| SecurityGroupId | No | Security group ID. | `sg-xxxxxx` | |'."\n" + .'| Header | No | Custom HTTP headers, specified as a JSON-formatted map string. | `{"aaa":"bbb","ccc":"ddd"}` | |'."\n" + .'| AuthType | No | Authentication type. | `BasicAuth` | \\- BasicAuth<br>\\- None |'."\n" + .'| Username | No | Username for basic authentication. Required if `AuthType` is `BasicAuth`. | `admin` | |'."\n" + .'| Password | No | Password for basic authentication. Required if `AuthType` is `BasicAuth`. | `xxxxxx` | |'."\n" + ."\n" + .'**sinkType = AcsKafka**'."\n" + ."\n" + .'| Key | Required | Description | Example value |'."\n" + .'| ---------- | -------- | ------------------ | ---------------- |'."\n" + .'| InstanceId | Yes | Kafka instance ID. | `alikafka_xxxxx` |'."\n" + .'| Topic | Yes | Kafka topic name. | `my-topic` |'."\n" + ."\n" + .'**sinkType = AcsMaxCompute**'."\n" + ."\n" + .'| Key | Required | Description | Example value |'."\n" + .'| ----------- | -------- | ------------------------ | --------------- |'."\n" + .'| ServiceName | Yes | MaxCompute service name. | `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"}]', ], - 'GetEntityStoreData' => [ - 'summary' => 'Query the entity and relationship data under a specified Workspace, returning the entity data within a certain time range (the returned result is transmitted after compression).', - 'path' => '/workspace/{workspace}/entitiesAndRelations', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateEntityStore' => [ + 'path' => '/workspace/{workspaceName}/entitystore', + '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', + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'workspace-test-001'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Content encoding type for the compression algorithm', - 'type' => 'string', - 'required' => false, - 'example' => 'gzip', - 'default' => 'gzip', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'workspaceName' => ['description' => 'The name of the workspace.', 'type' => 'string', 'title' => '', 'example' => 'workspace-test-001'], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create EntityStore', + 'summary' => 'Creates storage for an EntityStore.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEntityStore'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'workspace', - 'in' => 'path', - 'schema' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test-001', + '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' => 'Creates an Integration Center policy.', + 'path' => '/integration-policies', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'Request Body', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'from' => [ - 'description' => 'Start time of the query.'."\n" - ."\n" - .'Unix timestamp format, representing the number of seconds since 1970-1-1 00:00:00 UTC.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1721767203', - ], - 'query' => [ - 'description' => 'Query statement', - 'type' => 'string', - 'required' => true, - 'example' => '.entity with(domain=\'acs\', type=\'acs.k8s.node\') | limit 0, 10', + 'entityGroup' => [ + 'description' => 'The entity group used to create the policy. You can quickly create a policy using an entity group. The clusterId and vpcId parameters are independent of each other.', + 'type' => 'object', + 'properties' => [ + 'clusterEntityType' => ['description' => 'The cluster entity type. Examples: acs.ack.cluster, acs.one.cluster, and acs.asi.cluster.', 'type' => 'string', 'required' => false, 'example' => 'acs.ack.cluster', 'title' => ''], + 'clusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'na61prod3-na61cloudhdfsssd', 'title' => ''], + 'entityUserId' => ['description' => 'The ID of the user who owns the cluster.', 'type' => 'string', 'required' => false, 'example' => '12xxxx', 'title' => ''], + 'entityGroupId' => ['description' => 'The entity group ID.', 'type' => 'string', 'required' => false, 'example' => 'eg-b79f65d11fb94e779867cf937c3a3002', 'title' => ''], + 'vpcId' => ['description' => 'The virtual private cloud (VPC) ID.', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp18fgg3ffxa9czna40xt', 'title' => ''], + 'disablePolicyShare' => ['description' => 'Specifies whether to disable unique policy binding. If this parameter is set to true, you can create multiple policies for a container cluster.', 'type' => 'boolean', 'required' => false, 'example' => 'ture', 'title' => ''], + 'clusterNamespace' => ['type' => 'string', 'title' => '', 'description' => '', 'required' => false, 'example' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'to' => [ - 'description' => 'End time of the query.'."\n" - ."\n" - .'Unix timestamp format, representing the number of seconds since 1970-1-1 00:00:00 UTC.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1721767283', + 'policyName' => ['title' => '', 'description' => 'The policy name.', 'type' => 'string', 'required' => false, 'example' => 'prod-database'], + 'policyType' => ['title' => '', 'description' => 'The policy type. Valid values: CS, ECS, and Cloud.', 'type' => 'string', 'required' => true, 'example' => 'CS'], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-aekz2km4kmhtbii', 'title' => ''], + 'tags' => [ + 'description' => 'The resource tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The resource tags.', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The key of the tag.', 'type' => 'string', 'required' => false, 'example' => 'use', 'title' => ''], + 'value' => ['description' => 'The value of the tag.', 'type' => 'string', 'required' => false, 'example' => 'database', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'workspace' => ['title' => '', 'description' => 'The workspace.', 'type' => 'string', 'required' => false, 'example' => 'prometheus'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -8205,214 +7050,310 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'data' => [ - 'description' => 'Total list of returned data', - 'type' => 'array', - 'items' => [ - 'description' => 'List of data corresponding to the request header', - 'type' => 'array', - 'items' => [ - 'description' => 'Data corresponding to the request header', - 'type' => 'string', - 'example' => 'data1', - ], - ], - ], - 'header' => [ - 'description' => 'List of request headers', - 'type' => 'array', - 'items' => [ - 'description' => 'Request header', - 'type' => 'string', - 'example' => 'headerKey', - ], - ], - 'requestId' => [ - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'responseStatus' => [ - 'description' => 'Result status', + 'policy' => [ + 'description' => 'The upload policy.', 'type' => 'object', 'properties' => [ - 'result' => [ - 'description' => 'Execution result', - 'type' => 'string', - 'example' => 'Success,PartialSuccess,Error', - ], - 'retryPolicy' => [ - 'description' => 'Retry policy', - 'type' => 'string', - 'example' => 'None,Once,Continuous', - ], - 'level' => [ - 'description' => 'Status level', - 'type' => 'string', - 'example' => 'Info,Warn,Error', - ], - 'statusItem' => [ - 'description' => 'Detailed status information list', - 'type' => 'array', - 'items' => [ - 'description' => 'Detailed status information', - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'description' => 'Status code', - 'type' => 'string', - 'example' => 'Success,ExecuteTimeout,UModelNotExist', - ], - 'level' => [ - 'description' => 'Status level', - 'type' => 'string', - 'example' => 'Info,Warn,Error', - ], - 'message' => [ - 'description' => 'Calculation execution information', - 'type' => 'string', - 'example' => 'Query execution timeout after 30 seconds', - ], - 'suggestion' => [ - 'description' => 'Suggestions when an error occurs during execution', - 'type' => 'string', - 'example' => 'Try to reduce the query scope or increase timeout limit, then retry', - ], - ], - ], - ], - 'executionStates' => [ - 'description' => 'Information during the execution process', - 'type' => 'string', - 'example' => '{}', - ], + 'entityGroupId' => ['description' => 'The entity group ID.', 'type' => 'string', 'example' => 'eg-b79f65d11fb94e779867cf937c3a3002', 'title' => ''], + 'policyId' => ['title' => '', 'description' => 'The policy ID.', 'type' => 'string', 'example' => 'policy-14c8e9a29b0a46da843f8781471062ff'], + 'policyName' => ['title' => '', 'description' => 'The policy name.', 'type' => 'string', 'example' => 'metrics-inner-manage'], + 'policyType' => ['title' => '', 'description' => 'The policy type.', 'type' => 'string', 'example' => 'CS'], + 'regionId' => ['title' => '', 'description' => 'The region.', 'type' => 'string', 'example' => 'cn-heyuan'], + 'userId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => 'u1234567'], + 'workspace' => ['title' => '', 'description' => 'The workspace where the policy resides.', 'type' => 'string', 'example' => 'prometheus'], ], + 'title' => '', + 'example' => '', ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5'], + 'created' => ['description' => 'Indicates whether the policy was created.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Create Access Center Policy', + 'description' => 'This operation creates an event integration.', + 'changeSet' => [ + ['createdAt' => '2025-10-28T08:08:20.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-10-13T07:13:42.000Z', 'description' => 'Request parameters changed'], ], - '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' => 'Query Entity and Relationship Data', - 'translator' => 'machine', - ], - 'DeleteEntityStore' => [ - 'summary' => 'Delete EntityStore related storage', - 'path' => '/workspace/{workspaceName}/entitystore', - 'methods' => [ - 'delete', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateMemoryStore' => [ + 'path' => '/workspace/{workspace}/memorystore', + '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' => 'paid', 'autoTest' => true], 'parameters' => [ [ - 'name' => 'workspaceName', + 'name' => 'workspace', 'in' => 'path', + 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'workspace name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test-001', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'memoryStoreName' => ['description' => 'The name of the MemoryStore. The name must be unique within the workspace.', 'type' => 'string', 'required' => true, 'example' => 'test-memory-store', 'title' => ''], + 'description' => ['description' => 'The description of the MemoryStore.', 'type' => 'string', 'required' => false, 'example' => 'Test memory store for demonstration.', 'title' => ''], + 'shortTermTtl' => ['description' => 'The short-term TTL, which is the number of conversation rounds to retain.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''], + 'extractionStrategies' => [ + 'description' => 'The extraction strategies to use. Valid values include `Episodic`, `Summary`, and `Fact`.', + 'type' => 'array', + 'items' => ['description' => 'An extraction strategy.', 'type' => 'string', 'required' => false, 'example' => 'Fact', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'customExtractionStrategies' => [ + 'description' => 'A list of custom extraction strategies.', + 'type' => 'array', + 'items' => ['description' => 'A custom extraction strategy.', '$ref' => '#/components/schemas/CustomExtractionStrategy', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'sourceType' => ['description' => 'The source type of the memory. Valid values are `None` and `Trace`.', 'type' => 'string', 'example' => 'None/Trace', 'title' => ''], + 'traceSourceConfig' => [ + 'type' => 'object', + 'properties' => [ + 'workspace' => ['description' => 'The name of the workspace that contains the trace source.', 'type' => 'string', 'example' => 'test-workspace', 'title' => ''], + 'query' => ['description' => 'The query to filter traces.', 'type' => 'string', 'example' => '(serviceName : "langchain-rag" or serviceName : "agentscope-code-correction") and hostname = frontend-proxy-999c48c8d-hvk6c ', 'title' => ''], + 'includeOutput' => ['description' => 'Specifies whether to include the output in the trace.', 'type' => 'boolean', 'title' => '', 'example' => ''], + ], + 'description' => 'Configuration for the trace source. Required if `sourceType` is `Trace`.', + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response data.', + 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'request ID', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], + 'requestId' => ['title' => 'ID of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a memory store', + 'summary' => 'Creates a MemoryStore.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', - 'title' => 'Delete EntityStore', - 'translator' => 'machine', - ], - 'CreateUmodel' => [ - 'summary' => 'Create Umodel configuration', - 'path' => '/workspace/{workspace}/umodel', - 'methods' => [ - 'post', - ], - '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' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - ], + 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'workspace-test'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'Request Body', 'type' => 'object', 'properties' => [ - 'description' => [ - 'description' => 'Umodel description', - 'type' => 'string', + 'pipelineName' => ['description' => 'The pipeline name.', 'type' => 'string', 'required' => false, 'example' => 'pipeline-name-1', 'title' => ''], + 'description' => ['description' => 'The pipeline description.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'pipeline' => [ + 'type' => 'object', + 'properties' => [ + 'nodes' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The node ID.', 'type' => 'string', 'required' => false, 'example' => 'node_1', 'title' => ''], + 'type' => ['description' => 'The node type.', 'type' => 'string', 'required' => false, 'example' => 'dedup-fuzzy', 'title' => ''], + 'parameters' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'A key-value map of the node parameters.', '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" + .' }', 'title' => ''], + 'description' => 'The node parameters.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'A node object.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'description' => 'The pipeline nodes.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The pipeline configuration.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'source' => [ + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'The data source type.', 'type' => 'string', 'required' => false, 'example' => 'logstore', 'title' => ''], + 'logstore' => [ + 'type' => 'object', + 'properties' => [ + 'project' => ['description' => 'The Log Service Project name.', 'type' => 'string', 'required' => false, 'example' => 'test-project', 'title' => ''], + 'logstore' => ['description' => 'The Logstore name.', 'type' => 'string', 'required' => false, 'example' => 'test-logstore', 'title' => ''], + 'query' => ['description' => 'The query statement to filter logs.', 'type' => 'string', 'required' => false, 'example' => 'status:500 and method:GET', 'title' => ''], + ], + 'description' => 'The Log Service Logstore configuration. This parameter is required when `source.type` is set to `logstore`.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The data source.', 'required' => false, - 'example' => 'workspace test', + 'title' => '', + 'example' => '', + ], + 'sink' => [ + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'The sink type.', 'type' => 'string', 'required' => false, 'example' => 'dataset', 'title' => ''], + 'dataset' => [ + 'type' => 'object', + 'properties' => [ + 'workspace' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'workspace-test', 'title' => ''], + 'dataset' => ['description' => 'The dataset name.', 'type' => 'string', 'required' => false, 'example' => 'dataset_1', 'title' => ''], + ], + 'description' => 'The destination dataset configuration. This parameter is required when `sink.type` is set to `dataset`.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The data sink for the processed output.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'executePolicy' => [ + 'type' => 'object', + 'properties' => [ + 'mode' => ['description' => 'The execution mode. Set to `runOnce` for a single execution, or `scheduled` for a recurring execution.', 'type' => 'string', 'required' => false, 'example' => 'runOnce', 'title' => ''], + 'runOnce' => [ + 'type' => 'object', + 'properties' => [ + 'fromTime' => ['description' => 'The start timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1772519013', 'title' => ''], + 'toTime' => ['description' => 'The end timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1772519013', 'title' => ''], + ], + 'description' => 'The configuration for a one-time execution. This parameter is required when `executePolicy.mode` is set to `runOnce`.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'scheduled' => [ + 'type' => 'object', + 'properties' => [ + 'interval' => ['description' => 'The execution interval in seconds.', 'type' => 'string', 'required' => false, 'example' => '86400', 'title' => ''], + 'fromTime' => ['description' => 'The start timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1772519013', 'title' => ''], + ], + 'description' => 'The configuration for a scheduled execution. This parameter is required when `executePolicy.mode` is set to `scheduled`.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The execution policy.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'description' => 'The request body.', 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -8421,64 +7362,142 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '123-0F43-23423-AC43-34234', - ], - 'workspace' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'example' => 'workspace-test', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0CEC5375-C554-562B-A65F-***'], ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreatePipeline', + 'summary' => 'Create a pipeline.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"123-0F43-23423-AC43-34234\\",\\n \\"workspace\\": \\"workspace-test\\"\\n}","type":"json"}]', - 'title' => 'Create Umodel', - 'description' => 'Create Umodel configuration in the specified workspace', - 'translator' => 'machine', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-***\\"\\n}","type":"json"}]', ], - 'GetUmodel' => [ - 'summary' => 'Get Umodel configuration information', - 'path' => '/workspace/{workspace}/umodel', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CreatePrometheusInstance' => [ + 'summary' => 'Creates a Managed Service for Prometheus instance.', + 'path' => '/prometheus-instances', + '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', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', + 'description' => 'The request struct.', + 'type' => 'object', + 'properties' => [ + 'archiveDuration' => [ + 'title' => '', + 'description' => 'The number of days that data is automatically archived after the storage period expires. A value of 0 indicates that data is not archived. Valid values for the archive duration:'."\n" + .'* V1: 60 to 365 days.'."\n" + .'* V2: 60 to 3650 days (3650 indicates permanent retention).', + 'type' => 'integer', + 'format' => 'int32', + 'enum' => [], + 'required' => false, + 'example' => '60', + ], + 'authFreeReadPolicy' => ['description' => 'The authentication-free read policy. IP CIDR blocks and VPC IDs are supported.', '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" + .'}', 'title' => ''], + 'authFreeWritePolicy' => ['description' => 'The authentication-free write policy.', '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" + .'}', 'title' => ''], + 'enableAuthFreeRead' => ['description' => 'Specifies whether to enable authentication-free read. This parameter is supported only for V2 instances.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'enableAuthFreeWrite' => ['description' => 'Specifies whether to enable authentication-free write. This parameter is supported only for V2 instances.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'enableAuthToken' => ['description' => 'Specifies whether to enable the authorization token. This parameter is supported only for V1 instances.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'prometheusInstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'required' => true, 'example' => 'name1', 'title' => ''], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-aekz5qqvjyatgoy', 'title' => ''], + 'status' => [ + 'description' => 'The instance status.', + 'enumValueTitles' => ['Running' => 'Running', 'Stoped' => 'Stoped'], + 'type' => 'string', + 'default' => 'Running', + 'enum' => ['Running'], + 'required' => false, + 'example' => 'Running', + 'title' => '', + ], + 'storageDuration' => [ + 'title' => '', + 'description' => 'The storage duration (in days):'."\n" + .'* By write volume: 90 or 180.'."\n" + .'* By metric reporting volume: 15, 30, 60, 90, or 180.', + 'enumValueTitles' => [15 => '15 days.', 30 => '30 days.', 60 => '60 days.', 90 => '90 days.', 180 => '180 days.'], + 'type' => 'integer', + 'format' => 'int32', + 'enum' => ['15', '30', '60', '90', '180'], + 'required' => false, + 'example' => '90', + ], + 'tags' => [ + 'description' => 'The tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tags.', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'key1', 'title' => ''], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => '110109200001214284', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'workspace' => ['title' => '', 'description' => 'The workspace to which the instance belongs. Default value: default-cms-{userId}-{regionId}.', 'type' => 'string', 'required' => false, 'example' => 'wokspace1'], + 'paymentType' => [ + 'title' => '', + 'description' => 'The billable methods. Valid values:'."\n" + .'* POSTPAY: pay-as-you-go by metric reporting volume.'."\n" + .'* POSTPAY_GB: pay-as-you-go by metric write volume.'."\n" + .'If this parameter is left empty, the default billing method configured by the user is used. If the user has not configured a default billing method, the system uses pay-as-you-go by metric reporting volume.', + 'enumValueTitles' => ['POSTPAY' => 'reporting volume.', 'POSTPAY_GB' => 'write volume.'], + 'type' => 'string', + 'enum' => ['POSTPAY', 'POSTPAY_GB'], + 'required' => false, + 'example' => 'POSTPAY', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -8487,418 +7506,639 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'commonSchemaRef' => [ - 'description' => 'This field does not need to be filled currently', + 'prometheusInstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'rw-abc123'], + 'requestId' => ['description' => 'Id of the request', 'type' => 'string', 'example' => '264C3E89-BE6E-5F82-A484-CE9C2196C7DC', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusInstanceId\\": \\"rw-abc123\\",\\n \\"requestId\\": \\"264C3E89-BE6E-5F82-A484-CE9C2196C7DC\\"\\n}","type":"json"}]', + 'title' => 'Create a prometheus instance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePrometheusInstance'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + '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' => 'Creates a Prometheus view.', + 'path' => '/prometheus-views', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'authFreeReadPolicy' => ['description' => 'Not in use.', '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" + .'}', 'title' => ''], + 'enableAuthFreeRead' => ['title' => '', 'description' => 'Specifies whether anonymous read is supported.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'enableAuthToken' => ['title' => '', 'description' => 'Specifies whether authToken is supported.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'prometheusInstances' => [ + 'description' => 'The list of Prometheus instances.', 'type' => 'array', 'items' => [ - 'description' => 'This field does not need to be filled currently', 'type' => 'object', 'properties' => [ - 'group' => [ - 'description' => 'Common Umodel Schema group', - 'type' => 'string', - 'example' => 'test-job-123123', - ], - 'version' => [ - 'description' => 'Version', - 'type' => 'string', - 'example' => '5', - ], + 'prometheusInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'arms-1d581fac20a462dcde743d9628', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-wulanchabu', 'title' => ''], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'required' => false, 'example' => '167271234567890', 'title' => ''], ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], + 'required' => true, + 'title' => '', + 'example' => '', ], - 'description' => [ - 'description' => 'Umodel description', - 'type' => 'string', - 'example' => 'workspace test', - ], - 'regionId' => [ - 'description' => 'Region', + 'prometheusViewName' => ['description' => 'The Prometheus view name.', 'type' => 'string', 'required' => true, 'example' => 'test-prom-view-name', 'title' => ''], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfm3gn5i6bigbi', 'title' => ''], + 'status' => [ + 'description' => 'Not in use.', + 'enumValueTitles' => ['Running' => 'Running.'], 'type' => 'string', - 'example' => 'cn-heyuan', + 'default' => 'Running', + 'enum' => ['Running'], + 'required' => false, + 'example' => 'null', + 'title' => '', ], - 'requestId' => [ - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '123-123123-sdf-435-3123', + 'tags' => [ + 'description' => 'The tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag key.', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'test-key', 'title' => ''], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'test-value', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'workspace' => [ - 'description' => 'Workspace name', + 'version' => [ + 'title' => '', + 'description' => 'Valid values:'."\n" + .'- V1: legacy version'."\n" + .'- V2: new version.', + 'enumValueTitles' => ['V1' => 'V1 version.', 'V2' => 'V2 version.'], 'type' => 'string', - 'example' => 'workspace-test', + 'required' => true, + 'enum' => ['V1', 'V2'], + 'example' => 'V2', ], + 'workspace' => ['title' => '', 'description' => 'Default value: default-cms-{userId}-{regionId}.', 'type' => 'string', 'required' => false, 'example' => 'cms-monitor-test-aysls-pub-cn-zhangjiakou-spe-monitor'], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'prometheusViewId' => ['description' => 'The Prometheus view ID.', 'type' => 'string', 'example' => 'cd5237f7dbd574cf9bbd648ff9efb16cd', 'title' => ''], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + ], + 'example' => '', + ], + ], ], - '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' => 'Get Umodel', - 'description' => 'Get Umodel configuration information', - 'translator' => 'machine', - ], - 'UpdateUmodel' => [ - 'summary' => 'Update Umodel configuration information', - 'path' => '/workspace/{workspace}/umodel', - 'methods' => [ - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusViewId\\": \\"cd5237f7dbd574cf9bbd648ff9efb16cd\\",\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + 'title' => 'Create a prometheus view', + 'description' => 'Creates a site monitoring task.', + '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', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'namespace' => ['title' => '每个云产品在每个Regin只能创建一个虚拟实例', 'description' => 'Each cloud product supports only one virtual instance per region.', 'type' => 'string', 'required' => true, 'example' => 'cms_prometheus'], + 'tenantId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'Id of the request', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-************', 'title' => ''], + 'instance' => [ + 'title' => '实例ID', + 'description' => 'The instance.', + 'type' => 'object', + 'properties' => [ + 'instanceId' => ['title' => '地域ID', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'rw-e815960b4c9ebc5c3d89790c7e82'], + 'regionId' => ['title' => '用户ID', 'description' => 'Region ID', 'type' => 'string', 'example' => 'cn-zhengzhou-jva'], + 'userId' => ['title' => '用户ID', 'description' => 'The user ID.', 'type' => 'string', 'example' => '167212345678'], + 'namespace' => ['title' => '云产品', 'description' => 'The cloud product.', 'type' => 'string', 'example' => 'ack-csi-fuse'], + 'httpApiUrl' => ['title' => 'HTTP API查询地址', 'description' => 'The HTTP API query URL.', 'type' => 'string', 'example' => 'http://xxxxxxx'], + 'createdAt' => ['title' => '创建时间', 'description' => 'The time when the instance was created.', 'type' => 'string', 'example' => '1751520976660'], + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create Prometheus Monitoring Virtual Instance', + 'summary' => 'Creates a virtual instance for Prometheus monitoring.', + 'description' => 'Creates a virtual instance for Prometheus monitoring.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePrometheusVirtualInstance'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreatePrometheusVirtualInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'All Resource', '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' => 'Creates a service for application observability.', + 'path' => '/workspace/{workspace}/service', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'Request Body', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'description' => [ - 'description' => 'Description.', + 'serviceName' => ['description' => 'The service name.', 'type' => 'string', 'required' => true, 'example' => 'mag_test', 'title' => ''], + 'serviceType' => [ + 'description' => 'The service type.', + 'enumValueTitles' => ['TRACE' => 'application performance monitoring', 'RUM' => 'Real User Monitoring', 'XTRACE' => 'OpenTelemetry Tracing Analysis'], 'type' => 'string', + 'required' => true, + 'example' => 'TRACE', + 'title' => '', + ], + 'displayName' => ['description' => 'The display name. This parameter is valid only when serviceType is set to RUM.', 'type' => 'string', 'example' => 'Mag test application', 'title' => '', 'required' => false], + 'description' => ['description' => 'The service description. This parameter is valid only when serviceType is set to RUM.', 'type' => 'string', 'example' => 'Mag test application', 'title' => '', 'required' => false], + 'attributes' => ['description' => 'The extended properties.', 'type' => 'string', 'example' => '{"language":"java"}', 'title' => '', 'required' => false], + 'serviceStatus' => ['description' => 'The service status. Do not specify this parameter when you create a service.', 'type' => 'string', 'example' => 'Created', 'title' => '', 'required' => false], + 'pid' => ['description' => 'The application ID. You do not typically need to specify this parameter.', 'type' => 'string', 'example' => 'bx3udsi5ie@ed2ba6beebdb6de', 'title' => '', 'required' => false], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-xxxxxxx', 'title' => '', 'required' => false], + 'tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The `key` of the tag.', 'type' => 'string', 'example' => 'env', 'title' => '', 'required' => false], + 'value' => ['description' => 'The `value` of the tag.', 'type' => 'string', 'example' => 'prod', 'title' => '', 'required' => false], + ], + 'description' => 'A tag.', + 'title' => '', + 'required' => false, + 'example' => '', + ], + 'description' => 'An array of tags.', + 'title' => '', + 'example' => '', 'required' => false, - 'example' => 'workspace test', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'default-cms-1793369865235921-cn-shenzhen', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '234324-123-123-123-23423', - ], - 'workspace' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'example' => 'workspace-test', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3A2FA9E9-9CF1-5CB1-A808-52828F14310D', 'title' => ''], + 'serviceId' => ['description' => 'The service ID.', 'type' => 'string', 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', 'title' => ''], + 'pid' => ['description' => 'The ID of the ARMS application for backward compatibility.', 'type' => 'string', 'example' => 'cwzxvuc6uo@d60088ad4797d26', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"234324-123-123-123-23423\\",\\n \\"workspace\\": \\"workspace-test\\"\\n}","type":"json"}]', - 'title' => 'Update Umodel', - 'description' => 'Update Umodel configuration information', - 'translator' => 'machine', - ], - 'DeleteUmodel' => [ - 'summary' => 'Delete Umodel configuration information', - 'path' => '/workspace/{workspace}/umodel', - 'methods' => [ - 'delete', + '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' => 'Create Application Observability Service', + 'requestParamsDescription' => 'For the attributes extended property, you can specify the language property. If serviceType is set to TRACE, valid values for language are java, python, and golang. If serviceType is set to XTRACE, see the open source specifications at https\\://opentelemetry.io/docs/specs/semconv/registry/attributes/telemetry/ for valid language values.', + '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/*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'CreateServiceObservability' => [ + 'summary' => 'Creates application observability and prepares the prerequisite resources required for integration.', + 'path' => '/workspace/{workspace}/service-observability/{type}', + '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' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'example' => 'default-cms-1654218965343050-cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'type', + 'in' => 'path', 'schema' => [ - 'description' => 'workspace name', + 'description' => 'The type of application observability.', + 'enumValueTitles' => ['rum' => 'Real User Monitoring', 'apm' => 'Application Performance Monitoring'], 'type' => 'string', 'required' => true, - 'example' => 'workspace-test', + 'example' => 'apm', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'request ID', - 'type' => 'string', - 'example' => '123123-3213-345-9941-345345345', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create application observability', + 'extraInfo' => 'Description:'."\n" + ."\n" + .'- Resource initialization involves multiple actions and may incur a delay. The API call only needs to be initiated successfully. You can call GetServiceObservability to check the status; if status returns running, the resource initialization is successful.'."\n" + ."\n" + .'- Application Performance Monitoring (APM), OpenTelemetry tracing, and Real User Monitoring (RUM) require separate resource initialization.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"123123-3213-345-9941-345345345\\"\\n}","type":"json"}]', - 'title' => 'Delete Umodel', - 'description' => 'Delete the Umodel under the specified workspace', - 'translator' => 'machine', - ], - 'GetUmodelData' => [ - 'summary' => 'Retrieve associated Umodel graph data', - 'path' => '/workspace/{workspace}/umodel/graph', - 'methods' => [ - 'post', - ], - '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', - ], - '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' => 'Workspace name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - ], + 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'method', - 'in' => 'query', - 'schema' => [ - 'description' => 'Method', - 'type' => 'string', - 'required' => true, - 'example' => 'ListData', - ], + 'name' => 'serviceId', + 'in' => 'path', + 'schema' => ['description' => 'The service ID.', 'type' => 'string', 'required' => true, 'example' => 'em87vd@c2e25bcfe0e21ce0***', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', + 'allowEmptyValue' => false, 'style' => 'json', 'schema' => [ - 'description' => 'Request Body', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'content' => [ - 'description' => 'Query conditions', - 'type' => 'any', - 'required' => false, - 'example' => '{'."\n" - .' "filter": {'."\n" - .' "domains": []'."\n" - .' },'."\n" - .' "offset": 0,'."\n" - .' "size": 100000'."\n" - .'}', + 'recordType' => [ + 'title' => '', + 'description' => 'The type of the linked entry. Valid values:'."\n" + .'- logCorrelation: application log association.', + 'type' => 'string', + 'required' => true, + 'enum' => ['logCorrelation'], + 'example' => 'logCorrelation', ], + 'recordContent' => ['title' => '', 'description' => 'The entry content in JSON string format. The format may vary depending on the value of 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, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Return result', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'nodes' => [ - 'description' => 'List of nodes', - 'type' => 'array', - 'items' => [ - 'description' => 'Nodes.', - 'type' => 'any', - 'example' => '{}', - ], - ], - 'links' => [ - 'description' => 'List of node link relationships', - 'type' => 'array', - 'items' => [ - 'description' => 'Node link relationship', - 'type' => 'any', - 'example' => '{}', - ], - ], - 'totalNodesCount' => [ - 'description' => 'Total number of nodes', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'totalLinksCount' => [ - 'description' => 'Total number of node links', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'errors' => [ - 'description' => 'Error information', - 'type' => 'array', - 'items' => [ - 'description' => 'Error information', - 'type' => 'object', - 'properties' => [ - 'message' => [ - 'description' => 'Details.', - 'type' => 'string', - 'example' => 'ok', - ], - 'type' => [ - 'description' => 'Error type', - 'type' => 'string', - 'example' => 'external', - ], - ], - ], - ], - 'requestId' => [ - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '123-123-234-345-123', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a service-linked entry', + 'summary' => 'Creates a service-linked entry for associating configurations with the application monitoring service, such as log association.', + 'extraInfo' => 'When recordType is set to logCorrelation, two log binding types are supported:'."\n" + .'- bindType=logstore: indicates a Logstore.'."\n" + .'- bindType=storeview: indicates a StoreView.'."\n" + ."\n" + .'Ensure that the storage corresponding to the specified project and storeName values exists.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - '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' => 'Get Umodel Data', - 'description' => 'Find Umodel', - 'translator' => 'machine', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', ], - 'UpsertUmodelData' => [ - 'summary' => 'Write Umodel Elements', - 'path' => '/workspace/{workspace}/umodel/data', - 'methods' => [ - 'patch', - ], - 'schemes' => [ - 'https', - ], + 'CreateTicket' => [ + 'summary' => 'To share a console page or embed it into a third-party system without requiring a password, you can call the CreateTicket operation to generate a ticket. You can then use the ticket to create a password-free link.', + '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' => 'Workspace name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - ], + 'name' => 'expirationTime', + 'in' => 'query', + 'schema' => ['description' => '- The expiration time of the URL for the embedded page, in seconds. The value can range from 0 to 2,592,000 seconds (30 days). The default value is 86,400 seconds (one day).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '86400'], ], [ - 'name' => 'method', + 'name' => 'accessTokenExpirationTime', 'in' => 'query', + 'schema' => ['description' => '- The expiration time of the access token, in seconds. This is the period during which a user can access the page APIs. The value can range from 0 to 86,400 seconds (one day). The default value is 86,400 seconds (one day).'."\n" + ."\n" + .'- The effective expiration time of the access token is the minimum value of accessTokenExpirationTime and expirationTime.'."\n" + ."\n" + .'- If you call the operation using a Security Token Service (STS) token, the effective expiration time of the access token is the minimum value of accessTokenExpirationTime, expirationTime, and the expiration time of the STS token.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '600'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Method', - 'type' => 'string', - 'required' => false, - 'example' => 'Upsert', + 'title' => 'Schema of Response', + 'description' => 'The response struct.', + 'type' => 'object', + 'properties' => [ + 'ticket' => ['title' => 'Id of the request', 'description' => 'The password-free ticket.', 'type' => 'string', 'example' => 'eyJ***************.eyJ******************.KUT****************'], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ticket\\": \\"eyJ***************.eyJ******************.KUT****************\\"\\n}","type":"json"}]', + 'title' => 'Create Login-free Ticket', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTicket'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateTicket', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'CreateUmodel' => [ + 'summary' => 'Creates a Umodel configuration.', + 'path' => '/workspace/{workspace}/umodel', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'workspace-test'], + ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'List of elements', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'elements' => [ - 'description' => 'Element content', - 'type' => 'array', - 'items' => [ - 'description' => 'Element content', - 'type' => 'any', - 'required' => false, - 'example' => '{}', - ], - 'required' => false, - ], + 'description' => ['description' => 'The description of the Umodel.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'workspace test'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -8907,314 +8147,385 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '123-0F43-23423-AC43-34234'], + 'workspace' => ['description' => 'The name of the workspace.', 'type' => 'string', 'title' => '', 'example' => 'workspace-test'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"123-0F43-23423-AC43-34234\\",\\n \\"workspace\\": \\"workspace-test\\"\\n}","type":"json"}]', + 'title' => 'Create Umodel', + 'description' => 'Creates a Umodel configuration in a specified workspace.', + 'changeSet' => [ + ['createdAt' => '2025-08-12T02:41:41.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', - 'title' => 'Add or Overwrite Umodel (Elements)', - 'translator' => 'machine', - ], - 'DeleteUmodelData' => [ - 'summary' => 'Delete Umodel Elements', - 'path' => '/workspace/{workspace}/umodel/data', - 'methods' => [ - 'delete', + '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'], + ], + ], + ], ], + ], + 'DeleteAddonRelease' => [ + 'summary' => 'Deletes add-on release information.', + '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', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'workspace', - 'in' => 'path', - 'schema' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - ], + 'name' => 'releaseName', + 'in' => 'query', + 'schema' => ['title' => 'AddonRelease 的名称。', 'description' => 'The name of the AddonRelease.', 'type' => 'string', 'required' => false, 'example' => 'test-gpu-integration-name'], ], [ - 'name' => 'domain', + 'name' => 'force', 'in' => 'query', 'schema' => [ - 'description' => 'Can specify the name of a specific Umodel data, leaving it blank means all', - 'type' => 'string', + 'title' => '是否硬性删除，默认 false。', + 'description' => 'Specifies whether to forcibly delete the add-on release. The default value is false.', + 'type' => 'boolean', 'required' => false, - 'example' => 'apm', + 'enumValueTitles' => ['true' => 'Yes', 'false' => 'No'], + 'example' => 'false', ], ], [ - 'name' => 'name', + 'name' => 'policyId', + 'in' => 'path', + 'schema' => ['title' => '环境 ID。', 'description' => 'The environment ID.', 'type' => 'string', 'required' => true, 'example' => 'policy-xxxxxxxxxxxxx'], + ], + [ + 'name' => 'addonName', 'in' => 'query', + 'schema' => ['title' => 'Addon 名称，当 AddonName 赋值时，将忽略 ReleaseName 参数批量卸载所属于同一个 Addon 的所有 AddonRelease。', 'description' => 'The name of the add-on. If you specify this parameter, the ReleaseName parameter is ignored and all AddonReleases that belong to the add-on are uninstalled in a batch.', 'type' => 'string', 'required' => false, 'example' => 'cs-gpu'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Can specify the name of a specific Umodel data, leaving it blank means all', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '请求 ID。', 'description' => 'The request ID.', 'type' => 'string', 'example' => '264C3E89-BE6E-5F82-A484-CE9C2196C7DC'], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-BE6E-5F82-A484-CE9C2196C7DC\\"\\n}","type":"json"}]', + 'title' => 'Uninstall Access Component', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAddonRelease'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'kind', - 'in' => 'query', - 'schema' => [ - 'description' => 'Can specify the kind of a specific Umodel data, leaving it blank means all', - 'type' => 'string', - 'required' => false, - 'example' => 'metric_set', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteAddonRelease', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'AddonRelease', 'arn' => 'acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#PolicyId}/addonrelease/*'], + ], ], ], ], + ], + 'DeleteAggTaskGroup' => [ + 'summary' => 'Deletes an aggregation task group.', + 'path' => '/prometheus-instances/{instanceId}/agg-task-groups/{groupId}', + 'methods' => ['delete'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['title' => '聚合任务组所属的 Prometheus 实例的 id，聚合任务从这个实例中读取数据', 'description' => 'The ID of the Prometheus instance from which the aggregation task reads data.', 'type' => 'string', 'required' => true, 'example' => 'rw-pq4apob9jm'], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => ['title' => '聚合任务组 id', 'description' => 'The ID of the aggregation task group.', 'type' => 'string', 'required' => true, 'example' => 'aggTaskGroup-xxx'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '出参结构体', + 'description' => 'The response parameter struct.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '111111-222-333-1111-33333', - ], + 'requestId' => ['title' => '请求 id', 'description' => 'The request ID.', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"111111-222-333-1111-33333\\"\\n}","type":"json"}]', - 'title' => 'Delete Umodel Data', - 'description' => 'Delete the Umodel Data under a specified workspace', - 'translator' => 'machine', - ], - 'GetUmodelCommonSchemaRef' => [ - 'summary' => '获取Umodel配置信息', - 'path' => '/workspace/{workspace}/umodel/common-schema-ref', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', + 'title' => 'Delete Aggregation Task Group', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAggTaskGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + '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}'], + ], + ], + ], ], + ], + 'DeleteAlertWebhooks' => [ + 'path' => '/webhooks', + 'methods' => ['delete'], + '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' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'workspace', - 'in' => 'path', + 'name' => 'webhookIds', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'Unique webhook identifiers.', + 'type' => 'array', + 'items' => ['description' => 'Unique webhook identifier.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], 'required' => true, - 'example' => 'workspace-test', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Response structure', 'type' => 'object', 'properties' => [ - 'commonSchemaRef' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'group' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'apm-common', - ], - 'version' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0.1.0', - ], - ], - ], - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'E5B1D3D4-BB28-5996-8AD2-***********'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"commonSchemaRef\\": [\\n {\\n \\"group\\": \\"apm-common\\",\\n \\"version\\": \\"0.1.0\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'GetUmodelCommonSchemaRef', - ], - 'DeleteUmodelCommonSchemaRef' => [ - 'summary' => '删除Umodel配置信息', - 'path' => '/workspace/{workspace}/umodel/common-schema-ref', - 'methods' => [ - 'delete', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteAlertWebhooks', + 'summary' => 'Deletes one or more alert webhooks.', + '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', - ], + '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' => 'workspace', + 'name' => 'bizTraceId', 'in' => 'path', + 'schema' => ['description' => 'The ID of the business trace.', 'type' => 'string', 'required' => false, 'example' => 'e339260ed64c95d', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + ], + 'title' => '', + 'description' => 'The response schema.', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteBizTrace', + 'summary' => 'Deletes a business trace.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'group', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'apm-common', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteBizTrace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'BizTrace', 'arn' => 'acs:cms:{#regionId}:{#accountId}:biztrace/{#BizTraceId}'], + ], ], ], ], + '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'], + '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' => '', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', - 'title' => 'DeleteUmodelCommonSchemaRef', - ], - 'UpsertUmodelCommonSchemaRef' => [ - 'summary' => '更新Umodel配置信息', - 'path' => '/workspace/{workspace}/umodel/common-schema-ref', - 'methods' => [ - 'patch', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteCloudResource', + 'summary' => 'Deletes a cloud resource.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteCloudResource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'CloudResource', 'arn' => 'acs:cms:{#regionId}:{#accountId}:cloudresource'], + ], + ], + ], ], + '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', - ], + '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' => 'workspace', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - ], + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'group', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'card-service-daily01', - ], + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the context store.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-context-store', 'title' => ''], ], [ - 'name' => 'version', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '0.1.0', - ], + 'name' => 'contextId', + 'in' => 'path', + 'schema' => ['description' => 'The unique identifier of the context. This can be a generated record ID or event ID.', 'type' => 'string', 'required' => true, 'minLength' => 1, 'example' => '897294a7-67a4-4f60-976c-e136edc5f97e', 'title' => ''], ], ], 'responses' => [ @@ -9222,652 +8533,218 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0B9377D9-C56B-5C2E-A8A4-************', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E5B1D3D4-BB28-5996-8AD2-***********', 'title' => ''], + 'contextId' => ['description' => 'The unique identifier of the deleted context.', 'type' => 'string', 'example' => '897294a7-67a4-4f60-976c-e136edc5f97e', 'title' => ''], + 'status' => ['description' => 'The deletion status. For example, deleted.', 'type' => 'string', 'example' => 'deleted', 'title' => ''], ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteContext', + 'summary' => 'Deletes a context.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-************\\"\\n}","type":"json"}]', - 'title' => 'UpsertUmodelCommonSchemaRef', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E5B1D3D4-BB28-5996-8AD2-***********\\",\\n \\"contextId\\": \\"897294a7-67a4-4f60-976c-e136edc5f97e\\",\\n \\"status\\": \\"deleted\\"\\n}","type":"json"}]', ], - 'CreateChat' => [ - 'summary' => '创建对话', - 'path' => '/chat', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'sse', - ], + 'DeleteContextStore' => [ + 'summary' => 'Deletes a context store.', + 'path' => '/workspace/{workspace}/contextstore/{contextStoreName}', + 'methods' => ['delete'], + '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' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'digitalEmployeeName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'threadId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'thread_id01', - ], - 'action' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'reconnect' => 'reconnect', - 'stop' => 'stop', - 'create' => 'create', - ], - 'example' => 'create', - ], - 'variables' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'workspace' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'workspace01', - ], - 'region' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hongkong', - ], - 'project' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'project01', - ], - 'lastMessageId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'message_id01', - ], - 'userContext' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"metadata":"test"}', - ], - ], - 'required' => false, - ], - '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', - 'properties' => [ - 'id' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'call_001', - ], - 'type' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'function', - ], - 'function' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'get_pod_metrics', - ], - 'arguments' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{ "namespace": "prod", "pod": "order-service-abc" }', - ], - '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, - ], - 'success' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'True', - ], - 'interactions' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'type' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'user_input', - ], - 'result' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'content' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1765000012', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'references' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'id' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'metric_001', - ], - 'data' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The context store name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-context-store', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'messages' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'version' => [ - 'title' => '消息版本号', - 'type' => 'string', - ], - 'parentCallId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'sess_abc123', - 'title' => '上一层级执行ID', - ], - 'callId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'call_search_001', - 'title' => '当前执行ID', - ], - 'role' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'tool', - 'title' => '消息发起角色', - ], - 'seq' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '消息序列号', - ], - 'timestamp' => [ - 'description' => '', - 'type' => 'string', - 'format' => 'int64', - 'example' => '1765000005', - 'title' => 'timestamp / 纳秒', - ], - 'type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'done', - 'title' => '消息具体类型', - ], - 'detail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - 'title' => '消息明细', - ], - 'contents' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'example' => '{}', - 'title' => '内容信息明细结构', - ], - 'title' => '内容信息', - ], - 'tools' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'example' => '{}', - 'title' => '工具明细结构', - ], - 'title' => '工具使用列表', - ], - 'agents' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'example' => '{}', - 'title' => '调用的Agent详细内容', - ], - 'title' => '调用的Agent列表', - ], - 'events' => [ - 'title' => '事件列表', - 'type' => 'array', - 'items' => [ - 'title' => '事件详细内容', - 'type' => 'object', - ], - ], - 'artifacts' => [ - 'title' => '产物产出信息', - 'type' => 'array', - 'items' => [ - 'title' => '产物明细的结构', - 'type' => 'object', - ], - ], - ], - 'title' => '消息数据明细结构', - ], - 'title' => '会话的消息列表', - ], - 'traceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '21504600000008405622576e3b48', - 'title' => '当前message请求的id数据'."\n" - .'根数据中第一个追踪ID', - ], - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0CEC5375-XXXX-XXXX-XXXX-9A629907C1F0', - 'title' => '当前message请求的id数据'."\n" - .'根数据中第一个RequestID', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****', 'title' => ''], ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteContextStore', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - '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"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', ], - 'CreateDigitalEmployee' => [ - 'summary' => '创建DigitalEmployee', - 'path' => '/digital-employee', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + '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' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The context store name.', 'type' => 'string', 'required' => false, 'example' => 'test-context-store', 'title' => ''], + ], + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => ['description' => 'The API key\'s display name, which identifies its purpose.', 'type' => 'string', 'required' => false, 'example' => 'Production Service Key', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ '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' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'llm-xxxxx', - ], - 'indexId' => [ - 'description' => '', - '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' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - ], - ], - ], - 'required' => false, - ], - 'resourceGroupId' => [ - 'title' => '资源组 ID', - 'type' => 'string', - 'example' => 'rg-ae******ey', - ], - 'tags' => [ - 'title' => '标签', - 'type' => 'array', - 'items' => [ - 'title' => '标签', - '$ref' => '#/components/schemas/Tag', - ], - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], ], - 'required' => false, + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteContextStoreAPIKey', + 'summary' => 'Deletes an 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' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the ContextStore.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'title' => '', 'example' => 'test-context-store'], + ], + [ + 'name' => 'contextIds', + 'in' => 'query', + 'schema' => ['description' => 'A comma-separated list of context IDs.', 'type' => 'string', 'example' => 'mem_long_01,mem_long_02', 'title' => '', 'required' => false], + ], + [ + 'name' => 'filter', + 'in' => 'query', + 'schema' => ['description' => 'The filter condition, specified as a JSON string in the query. The syntax is the same as the `filter` parameter of the `SearchContext` operation.', 'type' => 'string', 'example' => '{"userId":"u-10001"}', 'title' => '', 'required' => false], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3B311FD9-A60B-55E0-A896-A0C73*********', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****', 'title' => ''], + 'deletedCount' => ['description' => 'The number of deleted contexts.', 'type' => 'integer', 'format' => 'int32', 'example' => '55', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3B311FD9-A60B-55E0-A896-A0C73*********\\",\\n \\"name\\": \\"test\\"\\n}","type":"json"}]', - ], - 'GetDigitalEmployee' => [ - 'summary' => '查询 DigitalEmployee', - 'path' => '/digital-employee/{name}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteContexts', + 'summary' => 'Deletes contexts in bulk.', + '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' => 'Deletes a dataset.', + 'path' => '/workspace/{workspace}/dataset/{datasetName}', + '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' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'name', + 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'datasetName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the dataset.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test_dataset', 'title' => ''], ], ], 'responses' => [ @@ -9875,409 +8752,238 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'deprecated' => false, - 'example' => 'acs:ram::12345678912:role/testrole', - 'pattern' => '', - 'readOnly' => false, - 'default' => '', - ], - 'regionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'knowledges' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'bailian' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'workspaceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'llm-xxxxx', - ], - 'indexId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'index-xxxx', - ], - 'region' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'attributes' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], - 'sop' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - ], - ], - ], - ], - 'employeeType' => [ - 'type' => 'string', - ], - 'tags' => [ - 'title' => '标签', - 'type' => 'array', - 'items' => [ - 'title' => '标签', - '$ref' => '#/components/schemas/Tag', - ], - ], - 'resourceGroupId' => [ - 'title' => '资源组 ID', - 'type' => 'string', - 'example' => 'rg-ae******ey', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0'], ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDigitalEmployee.NotFound', - 'errorMessage' => 'The specified DigitalEmployee does not exist.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteDataset', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - '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"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', ], - 'UpdateDigitalEmployee' => [ - 'summary' => '更新UpdateDigitalEmployee', - 'path' => '/digital-employee/{name}', - 'methods' => [ - 'patch', - ], - 'schemes' => [ - 'https', - ], + 'DeleteDeliveryTask' => [ + 'summary' => 'Deletes a delivery task.', + 'path' => '/delivery-task/{taskId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + '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', - ], + 'schema' => ['description' => 'The delivery task ID.', 'type' => 'string', 'required' => true, 'example' => '98e367d8fb8cc83b', 'title' => ''], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ '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' => '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' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'llm-xxxx', - ], - 'indexId' => [ - 'description' => '', - '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' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - ], - ], - ], - 'required' => false, - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], - 'required' => false, + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteDeliveryTask', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + ], + 'DeleteEntityStore' => [ + 'path' => '/workspace/{workspaceName}/entitystore', + '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' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'workspace-test-001'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-***', - ], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-***\\"\\n}","type":"json"}]', - ], - 'ListDigitalEmployees' => [ - 'summary' => '列出资源DigitalEmployee', - 'path' => '/digital-employee', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete EntityStore', + 'summary' => 'Deletes an EntityStore.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEntityStore'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + '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' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '10', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to force delete the cloud native appliance.'."\n" + .'Default: `false`.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'], ], [ - 'name' => 'nextToken', - 'in' => 'query', + 'name' => 'policyId', + 'in' => 'path', + 'schema' => ['description' => 'The policy ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'policy-273c360bed1948818c5fb861886bc405'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5'], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxxx', 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete Access Center Policy', + 'summary' => 'Deletes an Integration Center policy.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIntegrationPolicy'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + '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' => 'Deletes memories based on filter properties. You must set at least one filter property. If no filter properties are set, a validation error is returned.', + 'path' => '/workspace/{workspace}/memorystore/{memoryStoreName}/memory', + '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' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'default-cms-1793369865235921-cn-shenzhen', 'title' => ''], + ], + [ + 'name' => 'memoryStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the memory store.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-memory-store', 'title' => ''], + ], [ - 'name' => 'employeeType', + 'name' => 'agentId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'enum' => [ - 'system', - 'custom', - ], - ], + 'schema' => ['description' => 'The agent ID of the application.', 'type' => 'string', 'required' => false, 'example' => '952730733889060865', 'title' => ''], ], [ - 'name' => 'displayName', + 'name' => 'userId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The user ID.', 'type' => 'string', 'required' => false, 'example' => 'test_user_001', 'title' => ''], ], [ - 'name' => 'tags', + 'name' => 'runId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '标签', - 'type' => 'array', - 'items' => [ - 'title' => '标签', - '$ref' => '#/components/schemas/Tag', - ], - ], + 'schema' => ['description' => 'The run ID.', 'type' => 'string', 'required' => false, 'example' => 'jr-dd7c645fd6fe50d4', 'title' => ''], ], [ - 'name' => 'resourceGroupId', + 'name' => 'appId', 'in' => 'query', - 'schema' => [ - 'title' => '资源组 ID', - 'type' => 'string', - 'example' => 'rg-ae******ey', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => '98ea19fe-128b-4841-b318-0359bec3c65d', 'title' => ''], ], ], 'responses' => [ @@ -10285,200 +8991,54 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => 'llm-xxxx', - ], - 'indexId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'index-xxxx', - ], - 'region' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'attributes' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], - 'sop' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - ], - ], - ], - ], - 'employeeType' => [ - 'type' => 'string', - ], - 'resourceGroupId' => [ - 'title' => '资源组 ID', - 'type' => 'string', - 'example' => 'rg-ae******ey', - ], - 'tags' => [ - 'title' => '标签', - 'type' => 'array', - 'items' => [ - 'title' => '标签', - '$ref' => '#/components/schemas/Tag', - ], - ], - ], - ], - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], ], - '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"}]', - ], - 'DeleteDigitalEmployee' => [ - 'summary' => '删除DigitalEmployee', - 'path' => '/digital-employee/{name}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteMemories', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + ], + 'DeleteMemory' => [ + 'summary' => 'Deletes a memory.', + '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', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'name', + 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'default-cms-xxxxxx-cn-beijing', 'title' => ''], + ], + [ + 'name' => 'memoryStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the memory store.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-memory-store', 'title' => ''], + ], + [ + 'name' => 'memoryId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the memory.', 'type' => 'string', 'required' => true, 'minLength' => 1, 'example' => '019ca1e5-7307-7d50-b943-5e628326a8ed', 'title' => ''], ], ], 'responses' => [ @@ -10486,1184 +9046,919 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '0B9377D9-C56B-5C2E-A8A4-************'], ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', - ], - 'CreateThread' => [ - 'summary' => '创建会话', - 'path' => '/digitalEmployee/{name}/thread', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteMemory', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-************\\"\\n}","type":"json"}]', + ], + 'DeleteMemoryStore' => [ + 'summary' => 'Deletes a Memory Store.', + 'path' => '/workspace/{workspace}/memorystore/{memoryStoreName}', + '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' => 'The name of the Workspace.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'title' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'variables' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'workspace' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rum-monitor-test-aysls-pub-cn-heyuan-monitor', - ], - 'project' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'az_alipay', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], + 'name' => 'memoryStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the Memory Store.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-memory-store', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response data.', '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*****', - ], - 'threadId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'thread_id01', - ], + 'requestId' => ['title' => 'ID of the request', 'description' => 'The Request ID.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"threadId\\": \\"thread_id01\\"\\n}","type":"json"}]', - ], - 'GetThread' => [ - 'summary' => '获取会话', - 'path' => '/digitalEmployee/{name}/thread/{threadId}', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete a memory store', + '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', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - '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' => ['description' => 'The name of the workspace.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'workspace-test'], ], [ - 'name' => 'threadId', + 'name' => 'pipelineName', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'thread_id01', - ], + 'schema' => ['description' => 'The name of the pipeline.', 'type' => 'string', 'required' => false, 'example' => 'pipeline-name-1', 'title' => ''], ], ], '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*****', - ], - 'threadId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'thread-t71rrw-1s7r7z9gu0v2s', - ], - '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' => 'hd1', - ], - 'project' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'kubenest', - ], - ], - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5'], ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeletePipeline', + 'summary' => 'Deletes a pipeline.', + '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"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CD8BA7D6-995D-578D-9941-78B0FECD14B5\\"\\n}","type":"json"}]', ], - 'GetThreadData' => [ - 'summary' => '获取会话数据', - 'path' => '/digitalEmployee/{name}/thread/{threadId}/data', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DeletePrometheusInstance' => [ + 'path' => '/prometheus-instances/{prometheusInstanceId}', + 'methods' => ['delete'], + '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' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'name', + 'name' => 'prometheusInstanceId', 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'rw-abc123'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete Prometheus Instance', + 'summary' => 'Deletes a Prometheus instance.', + 'description' => 'Deletes a Prometheus instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePrometheusInstance'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'threadId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'thread_id01', + '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' => [ [ - 'name' => 'nextToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxxxxxxx', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ [ - 'name' => 'maxResults', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'name' => 'prometheusViewId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the Prometheus view.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'rw-xxxxxx'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'maxResults' => [ - 'title' => '最大结果数量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'data' => [ - 'title' => '消息数据', - 'type' => 'array', - 'items' => [ - 'title' => '消息数据', - 'type' => 'object', - 'properties' => [ - 'traceId' => [ - 'title' => '当前message请求的id数据'."\n" - .'根数据中第一个追踪ID', - 'type' => 'string', - ], - 'requestId' => [ - 'title' => '当前message请求的id数据'."\n" - .'根数据中第一个RequestID', - 'type' => 'string', - ], - 'messages' => [ - 'title' => '会话的消息列表', - 'type' => 'array', - 'items' => [ - 'title' => '消息数据明细结构', - 'type' => 'object', - 'properties' => [ - 'version' => [ - 'title' => '消息数据的版本号', - 'type' => 'string', - ], - 'parentCallId' => [ - 'title' => '上一层级执行ID', - 'type' => 'string', - ], - 'callId' => [ - 'title' => '当前执行ID', - 'type' => 'string', - ], - 'role' => [ - 'title' => '消息发起角色', - 'type' => 'string', - ], - 'seq' => [ - 'title' => '消息序列号', - 'type' => 'integer', - 'format' => 'int32', - ], - 'timestamp' => [ - 'title' => 'timestamp / 纳秒', - 'type' => 'string', - ], - 'type' => [ - 'title' => '消息具体类型', - 'type' => 'string', - ], - 'detail' => [ - 'title' => '消息明细', - 'type' => 'string', - ], - 'contents' => [ - 'title' => '内容信息', - 'type' => 'array', - 'items' => [ - 'title' => '内容信息明细结构', - 'type' => 'object', - ], - ], - 'tools' => [ - 'title' => '工具使用列表', - 'type' => 'array', - 'items' => [ - 'title' => '工具明细结构', - 'type' => 'object', - ], - ], - 'agents' => [ - 'title' => '调用的Agent列表', - 'type' => 'array', - 'items' => [ - 'title' => '调用的Agent详细内容', - 'type' => 'object', - ], - ], - 'events' => [ - 'title' => '事件列表', - 'type' => 'array', - 'items' => [ - 'title' => '事件详细内容', - 'type' => 'object', - ], - ], - 'artifacts' => [ - 'title' => '产物产出信息', - 'type' => 'array', - 'items' => [ - 'title' => '产物明细的结构', - 'type' => 'object', - ], - ], - ], - ], - ], - ], - ], - ], - 'nextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxxxxxxx', - 'title' => '分页参数，下一页信息', - ], - 'requestId' => [ - 'title' => '当前请求ID', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], - 'threadId' => [ - 'title' => '当前会话ID', - 'description' => '', - 'type' => 'string', - 'example' => 'aliding_thread_448d05c048a3481f8c19bc1a6038f8f6', - ], - 'digitalEmployeeName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - 'title' => '当前数字员工信息', - ], + 'requestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0'], ], + 'example' => '', ], ], ], - '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"}]', - ], - 'ListThreads' => [ - 'summary' => '列出会话', - 'path' => '/digitalEmployee/{name}/threads', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete prometheus view instance.', + 'summary' => 'Deletes a Prometheus view instance.', + 'description' => 'Deletes a Prometheus view instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePrometheusView'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + '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"}]', + ], + 'DeletePrometheusVirtualInstance' => [ + 'summary' => 'Deletes a Prometheus virtual instance by its ID.', + 'path' => '/virtual-instances/{prometheusInstanceId}', + 'methods' => ['delete'], + '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' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'name', + 'name' => 'prometheusInstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'The ID of the Prometheus virtual instance.', 'type' => 'string', 'required' => false, 'example' => 'virtual-xxxxxxxxxxxxxxxx', 'title' => ''], ], - [ - 'name' => 'status', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Running', - ], - ], - [ - 'name' => 'threadId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'thread_id01', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeletePrometheusVirtualInstance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + ], + 'DeleteService' => [ + 'summary' => 'Deletes an Application Monitoring service.', + 'path' => '/workspace/{workspace}/service/{serviceId}', + 'methods' => ['delete'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'maxResults', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ [ - 'name' => 'nextToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxxx', - ], + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'filter', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'dukang-oxs-pre-obeqi', - ], - 'value' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '[{\'Type\': \'primaryDoc\', \'Id\': \'01ZM8y7\', \'Name\': \'key\'}, {\'Type\': \'text\', \'Id\': \'mHe1U1b\', \'Name\': \'value\'}, {\'Type\': \'text\', \'Id\': \'rRIhpBs\', \'Name\': u\'\\u4f5c\\u7528\'}]', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'name' => 'serviceId', + 'in' => 'path', + 'schema' => ['description' => 'The service ID.', 'type' => 'string', 'required' => true, 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', 'title' => ''], ], ], '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', - ], - 'threadId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'thread_id01', - ], - 'total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'maxResults' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'threads' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'threadId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'thread-t71rrw-1s7r7z9gu0v2s', - ], - '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' => '*', - ], - 'variables' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'workspace' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'hd1-np', - ], - 'project' => [ - 'description' => 'SLS project。', - 'type' => 'string', - 'example' => 'ciec_rl_ads', - ], - ], - ], - 'createTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2025-04-22T12:46:34Z', - ], - 'updateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2025-06-24 10:05:21', - ], - ], - ], - ], - 'nextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxxxxxxxx', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '51B6A3E8-EA9E-5143-BE11-8E5F83474C95', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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"}]', - ], - 'UpdateThread' => [ - 'summary' => '更新会话', - 'path' => '/digitalEmployee/{name}/thread/{threadId}', - 'methods' => [ - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete Application Observability Service', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteService'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + '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', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'name', + 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'default-cms-1654218***343050-cn-hangzhou', 'title' => ''], ], [ - 'name' => 'threadId', + 'name' => 'serviceId', 'in' => 'path', + 'schema' => ['description' => 'The service ID.', 'type' => 'string', 'required' => true, 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', 'title' => ''], + ], + [ + 'name' => 'recordType', + 'in' => 'query', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'The type of the association entry. Valid values:'."\n" + .'logCorrelation: application log association', 'type' => 'string', 'required' => true, - 'example' => 'thread-t71rrw-1s7r7z9gu0v2s', + 'enum' => ['logCorrelation'], + 'example' => 'logCorrelation', ], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'title' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'MY ANTOM Tech Team Annual Dinner Performance Lucky Draw', - ], - 'status' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'active', - 'enum' => [ - 'active', - 'archived', - ], - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], ], - 'required' => false, + 'example' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete a service association entry', + 'summary' => 'Deletes a service association entry.', + 'description' => 'Deletes a created service association entry.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', + ], + 'DeleteUmodel' => [ + 'summary' => 'Deletes a Umodel configuration.', + 'path' => '/workspace/{workspace}/umodel', + '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' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'workspace-test'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'threadId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'thread_id01', - ], - 'version' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0.1.0', - ], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '123123-3213-345-9941-345345345'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"threadId\\": \\"thread-12313\\",\\n \\"version\\": 123123\\n}","type":"json"}]', - ], - 'DeleteThread' => [ - 'summary' => '删除会话', - 'path' => '/digitalEmployee/{name}/thread/{threadId}', - 'methods' => [ - 'delete', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"123123-3213-345-9941-345345345\\"\\n}","type":"json"}]', + 'title' => 'Delete Umodel', + 'description' => 'Deletes a Umodel from a specified workspace.', + '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'], + ], + ], + ], ], + ], + 'DeleteUmodelCommonSchemaRef' => [ + 'summary' => 'Deletes a public Umodel schema reference.', + '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' => 'delete', - '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' => 'The workspace name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'workspace-test'], ], [ - 'name' => 'threadId', - 'in' => 'path', + 'name' => 'group', + 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The public Umodel schema group.', 'type' => 'string', 'required' => true, - 'example' => 'thread_id01', + 'enumValueTitles' => [], + 'title' => '', + 'example' => 'apm-common', ], ], ], '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' => '123-0F43-23423-AC43-34234', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"123-0F43-23423-AC43-34234\\"\\n}","type":"json"}]', - ], - 'UpdateIntegrationPolicy' => [ - 'summary' => 'Update the specified policy', - 'path' => '/integration-policies/{integrationPolicyId}', - 'methods' => [ - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + 'title' => 'DeleteUmodelCommonSchemaRef', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUmodelCommonSchemaRef'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteUmodelCommonSchemaRef', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Umodel', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/umodel'], + ], + ], + ], ], + ], + 'DeleteUmodelData' => [ + 'path' => '/workspace/{workspace}/umodel/data', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + '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' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'workspace-test'], + ], + [ + 'name' => 'domain', + 'in' => 'query', + 'schema' => ['description' => 'The name of the Umodel data to delete. Omit this parameter to delete all Umodel data.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'apm'], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the Umodel data. If unspecified, data with any name is deleted.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test'], + ], + [ + 'name' => 'kind', + 'in' => 'query', + 'schema' => ['description' => 'The kind of the Umodel data. If unspecified, data of all kinds is deleted.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'metric_set'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Request body parameters', 'type' => 'object', 'properties' => [ - 'feePackage' => [ - 'description' => 'Fee package type, CS_Pro/CS_Basic/empty.', - 'type' => 'string', - 'required' => false, - 'example' => 'CS_Pro', - ], - 'policyName' => [ - 'description' => 'Rule name, minimum 3 characters, maximum 63 characters, must start with a letter.', - 'type' => 'string', - 'required' => false, - 'example' => 'metrics-inner-manage', - ], - 'resourceGroupId' => [ - 'description' => 'Resource group ID of the instance.', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aekzoiafjtr7zyq', - ], - 'tags' => [ - 'description' => 'Resource tags.', - 'type' => 'array', - 'items' => [ - 'description' => 'Resource tags.', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => 'Tag `key` value.', - 'type' => 'string', - 'required' => false, - 'example' => 'algo_bhv_expose_in_airec_exposure', - ], - 'value' => [ - 'description' => 'Tag `value` value.', - 'type' => 'string', - 'required' => false, - 'example' => '[{\'Id\': \'kgqie6hm\', \'Name\': \'Sheet1\'}]', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '111111-222-333-1111-33333'], ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete Umodel Data', + 'summary' => 'Deletes Umodel elements.', + 'description' => 'Deletes Umodel data from a specified workspace.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUmodelData'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'integrationPolicyId', - 'in' => 'path', - 'schema' => [ - 'description' => 'Access center policy ID', - 'type' => 'string', - 'required' => true, - 'example' => 'polixy-xxxxxxxxx', + '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' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'example' => 'workspace-test-001'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Response schema', + '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' => 'The request ID.', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', - 'title' => 'Update Access Center Policy', - 'translator' => 'machine', - ], - 'DeleteIntegrationPolicy' => [ - 'summary' => 'Delete Access Center Policy', - 'path' => '/integration-policies/{policyId}', - 'methods' => [ - 'delete', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete Workspace', + 'summary' => 'Deletes a workspace.', + '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' => 'Queries metric metadata.', + 'path' => '/describe-metric-meta-list', + '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', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'force', + 'name' => 'namespace', + 'in' => 'query', + 'schema' => ['description' => 'The namespace, which is used to distinguish between services.', 'type' => 'string', 'required' => false, 'example' => 'acs_ecs_dashboard', 'title' => ''], + ], + [ + 'name' => 'metaFormat', 'in' => 'query', 'schema' => [ - 'description' => 'Whether to forcibly delete the cloud-native all-in-one machine,'."\n" - .'default value: `false`.', - 'type' => 'boolean', + 'description' => 'The metadata source. Valid values:'."\n" + .'- CMS: CloudMonitor Basic monitoring metrics.'."\n" + .'- PROM_BASIC: Prometheus CloudMonitor basic monitoring metrics.', + 'type' => 'string', + 'enum' => ['CMS', 'PROM_BASIC'], 'required' => false, - 'example' => 'false', + 'example' => 'CMS', + 'title' => '', ], ], [ - 'name' => 'policyId', - 'in' => 'path', + 'name' => 'metricName', + 'in' => 'query', + 'schema' => ['description' => 'The metric name.', 'type' => 'string', 'required' => false, 'example' => 'CPUUtilization', 'title' => ''], + ], + [ + 'name' => 'labels', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'Policy environment ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-273c360bed1948818c5fb861886bc405', + 'description' => 'Filters resources by label. The following labels are available:'."\n" + .'- metricCategory: the metric category description.'."\n" + .'- alertEnable: specifies whether alerting is required.'."\n" + .'- alertUnit: the recommended alert unit.'."\n" + .'- unitFactor: the unit conversion factor.'."\n" + .'- minAlertPeriod: the minimum alert period.'."\n" + .'- productCategory: the service type category.', + 'type' => 'array', + 'items' => [ + 'description' => 'The label key.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The label name.', 'type' => 'string', 'required' => false, 'example' => 'productCategory', 'title' => ''], + 'value' => ['description' => 'The label value.', 'type' => 'string', 'required' => false, 'example' => 'ecs', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 2000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2000', 'title' => ''], + ], + [ + 'name' => 'keywords', + 'in' => 'query', + 'schema' => ['description' => 'The keyword.', 'type' => 'string', 'required' => false, 'example' => '实例理论', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + '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' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'totalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '6370', 'title' => ''], + 'pageNumber' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'pageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '2000', 'title' => ''], + 'resources' => [ + 'description' => 'The metric configuration information of the resources.', + 'type' => 'array', + 'items' => [ + 'description' => 'The metric configuration information of the resources.', + 'type' => 'object', + 'properties' => [ + 'namespace' => ['description' => 'The namespace.', 'type' => 'string', 'example' => 'acs_ecs_dashboard', 'title' => ''], + 'metricName' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'CPUUtilization', 'title' => ''], + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'ECS CPU Utilization', 'title' => ''], + 'unit' => ['description' => 'The unit.', 'type' => 'string', 'example' => '%', 'title' => ''], + 'labels' => [ + 'description' => 'The CloudMonitor labels. This parameter is returned only when metaFormat is set to CMS.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The CloudMonitor label content.', '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" + .'}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'dimensions' => [ + 'description' => 'The resource filtering dimensions of CloudMonitor Basic.', + 'type' => 'array', + 'items' => ['description' => 'The resource filtering dimensions of CloudMonitor Basic.', 'type' => 'string', 'example' => '["userId","instanceId"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'type' => ['description' => 'The metric type.', 'type' => 'string', 'example' => 'Gauge', 'title' => ''], + 'dimensionDescription' => [ + 'description' => 'The dimension description.', + 'type' => 'array', + 'items' => [ + 'description' => 'The dimension description.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name.', 'type' => 'string', 'example' => 'user_id', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'statistics' => ['description' => 'The statistical method of the metric. Example values:'."\n" + .'- Maximum: the maximum value.'."\n" + .'- Minimum: the minimum value.'."\n" + .'- Average: the average value.', 'type' => 'string', 'example' => 'Maximum', 'title' => ''], + 'periods' => ['description' => 'The period.', 'type' => 'string', 'example' => '60', 'title' => ''], + 'metaFormat' => ['description' => 'The metadata source. CMS indicates CloudMonitor Basic monitoring metrics. PROM_BASIC indicates Prometheus CloudMonitor basic monitoring metrics.'."\n" + ."\n" + .'Sample value:'."\n" + .'CMS'."\n" + .'Valid values:'."\n" + .'CMS'."\n" + .'PROM_BASIC.', 'type' => 'string', 'example' => 'PROM_BASIC', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query cloudMonitor metric details', + 'description' => 'Queries the details of CloudMonitor monitoring metrics metadata.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CD8BA7D6-995D-578D-9941-78B0FECD14B5\\"\\n}","type":"json"}]', - 'title' => 'Delete Access Center Policy', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'cms:DescribeMetricMetaList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'All Resource', '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"}]', 'translator' => 'machine', ], - 'CreateIntegrationPolicy' => [ - 'summary' => 'Create Access Center Policy', - 'path' => '/integration-policies', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DescribeRegions' => [ + 'path' => '/regions', + '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', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'language', + 'in' => 'query', 'schema' => [ - 'description' => 'Request body.', - 'type' => 'object', - 'properties' => [ - 'entityGroup' => [ - 'description' => 'Entity group for creating the policy. Policies can be quickly created using the entity group, and `clusterId` and `vpcId` are independent of each other.', - 'type' => 'object', - 'properties' => [ - 'clusterEntityType' => [ - 'description' => 'Cluster entity type, such as acs.ack.cluster/acs.one.cluster/acs.asi.cluster or others.', - 'type' => 'string', - 'required' => false, - 'example' => 'acs.ack.cluster', - ], - 'clusterId' => [ - 'description' => 'Cluster ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'na61prod3-na61cloudhdfsssd', - ], - 'entityUserId' => [ - 'description' => 'User ID to which the cluster belongs.', - 'type' => 'string', - 'required' => false, - 'example' => '12xxxx', - ], - 'entityGroupId' => [ - 'description' => 'Entity group ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'eg-b79f65d11fb94e779867cf937c3a3002', - ], - 'vpcId' => [ - 'description' => 'VPC ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp18fgg3ffxa9czna40xt', - ], - 'disablePolicyShare' => [ - 'description' => 'Whether to disable the unique binding of the Policy. If enabled, multiple Policies can be created for a single container cluster.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'ture', - ], - 'clusterNamespace' => [ - 'title' => '', - 'type' => 'string', - ], - ], - 'required' => false, - ], - 'policyName' => [ - 'title' => '策略名称', - 'description' => 'Policy name', - 'type' => 'string', - 'required' => false, - 'example' => 'prod-database', - ], - 'policyType' => [ - 'title' => '策略类型：CS/ECS/Cloud', - 'description' => 'Policy type: CS/ECS/Cloud', - 'type' => 'string', - 'required' => true, - 'example' => 'CS', - ], - 'resourceGroupId' => [ - 'description' => 'Resource group ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aekz2km4kmhtbii', - ], - 'tags' => [ - 'description' => 'Resource tags.', - 'type' => 'array', - 'items' => [ - 'description' => 'Resource tags.', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => 'Tag `key` value.', - 'type' => 'string', - 'required' => false, - 'example' => 'use', - ], - 'value' => [ - 'description' => 'Tag `value` value.', - 'type' => 'string', - 'required' => false, - 'example' => 'database', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'workspace' => [ - 'title' => '工作空间，不填则创建或使用默认工作空间。', - 'description' => 'Workspace.', - 'type' => 'string', - 'required' => false, - 'example' => 'prometheus', - ], - ], + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese. This is the default value.'."\n" + ."\n" + .'- en: English.'."\n" + ."\n" + .'- ja: Japanese.', + 'enumValueTitles' => ['ja' => 'ja', 'en' => 'en', 'zh' => 'zh'], + 'type' => 'string', 'required' => false, + 'example' => 'zh', + 'title' => '', ], ], ], @@ -11672,2002 +9967,1701 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'policy' => [ - 'description' => 'Uploaded policy.', - 'type' => 'object', - 'properties' => [ - 'entityGroupId' => [ - 'description' => 'Entity group ID.', - 'type' => 'string', - 'example' => 'eg-b79f65d11fb94e779867cf937c3a3002', - ], - 'policyId' => [ - 'title' => '策略id', - 'description' => 'Policy ID.', - 'type' => 'string', - 'example' => 'policy-14c8e9a29b0a46da843f8781471062ff', - ], - 'policyName' => [ - 'title' => '策略名称', - 'description' => 'Policy name.', - 'type' => 'string', - 'example' => 'metrics-inner-manage', - ], - 'policyType' => [ - 'title' => '策略类型', - 'description' => 'Policy type.', - 'type' => 'string', - 'example' => 'CS', - ], - 'regionId' => [ - 'title' => 'region', - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-heyuan', - ], - 'userId' => [ - 'title' => '用户id', - 'description' => 'User ID.', - 'type' => 'string', - 'example' => 'u1234567', - ], - 'workspace' => [ - 'title' => 'Policy所在的工作空间。', - 'description' => 'The workspace where the Policy resides.', - 'type' => 'string', - 'example' => 'prometheus', + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'regions' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'localName' => ['description' => 'The name of the region.', 'type' => 'string', 'example' => 'China (Beijing)', 'title' => ''], ], + 'description' => 'The region information.', + 'title' => '', + 'example' => '', ], - ], - 'requestId' => [ + 'description' => 'The list of regions.', 'title' => '', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5', - ], - 'created' => [ - 'description' => 'Whether it is created.', - 'type' => 'boolean', - 'example' => 'true', + 'example' => '', ], ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DescribeRegions', + 'summary' => 'Retrieves a list of regions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - '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' => 'Create Access Center Policy', - 'description' => 'This interface is used to support users in creating event integration.', - 'translator' => 'machine', + '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"}]', ], - 'UpdateAddonRelease' => [ - 'summary' => 'Upgrade Access Component', - 'path' => '/integration-policies/{policyId}/addon-releases/{releaseName}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'ExecuteQuery' => [ + 'path' => '/workspace/{workspace}/dataset/{datasetName}/query', + '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' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'releaseName', + 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'title' => 'Release 的名称。', - 'description' => 'The name of the Release.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-gpu-integration-name', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'datasetName', + 'in' => 'path', + 'schema' => ['description' => 'The dataset name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test_dataset', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'Request body.', 'type' => 'object', 'properties' => [ - 'addonVersion' => [ - 'title' => 'Addon 的版本信息。', - 'description' => 'Addon version information.', - 'type' => 'string', - 'required' => false, - 'example' => '0.0.2', - ], - 'dryRun' => [ - 'title' => '是否预检本次请求。', - 'description' => 'Whether to pre-check this request.', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '是', - 'false' => '否', - ], - 'example' => 'true', - ], - 'values' => [ - 'title' => '元数据信息。', - 'description' => 'Metadata information.', - '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' => 'Entity discovery rules.', - 'required' => false, - '$ref' => '#/components/schemas/EntityDiscoverRule', - ], + 'type' => ['description' => 'The query type. Valid values: SQL and SPL.', 'type' => 'string', 'required' => true, 'example' => 'SQL', 'title' => ''], + 'query' => ['description' => 'The query statement to execute.', 'type' => 'string', 'required' => true, 'example' => 'SELECT count(1) from "datasetname"', 'title' => ''], ], + 'description' => 'A container for the request parameters.', 'required' => false, - ], - ], - [ - 'name' => 'policyId', - 'in' => 'path', - 'schema' => [ - 'title' => '策略环境 ID。', - 'description' => 'Policy environment ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-xxxxxxxxxxxx', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '9F00A7AF-2728-5424-B321-79D39C00A1EC', + 'requestId' => ['description' => 'The unique request ID.', 'type' => 'string', 'example' => '3B311FD9-A60B-55E0-A896-A0C73*********', 'title' => ''], + 'meta' => [ + 'type' => 'object', + 'properties' => [ + 'affectedRows' => ['description' => 'The number of scanned or processed log entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'elapsedMillisecond' => ['description' => 'The query execution time in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1231243', 'title' => ''], + 'progress' => ['description' => 'The query completion status. A value of `Complete` indicates that the query has finished.', 'type' => 'string', 'example' => 'Complete', 'title' => ''], + 'count' => ['description' => 'The number of log entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'description' => 'Metadata about the query execution.', + 'title' => '', + 'example' => '', + ], + 'data' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'The log entry, returned as a JSON-formatted string.', 'type' => 'string', 'example' => '{\'remote_addr\': \'198.51.XXX.XXX\', \'pv\': \'1\', \'__source__\': \'\', \'__time__\': \'1649902984\'}', 'title' => ''], + 'description' => 'An object that represents a single log entry.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'description' => 'An array of log entries. Each object in the array represents a log entry.', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ExecuteQuery', + 'summary' => 'Executes SQL and SPL queries.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9F00A7AF-2728-5424-B321-79D39C00A1EC\\"\\n}","type":"json"}]', - 'title' => 'Update Access Component Configuration', - 'translator' => 'machine', + '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"}]', ], - 'ListIntegrationPolicyStorageRequirements' => [ - 'summary' => 'Get Storage Requirements Information for Access Center Policy', - 'path' => '/integration-policies/{policyId}/storage-requirements', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetAddon' => [ + 'summary' => 'Retrieves the details of an add-on.', + 'path' => '/addons/{addonName}', + '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', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'policyId', - 'in' => 'path', - 'schema' => [ - 'title' => '接入中心策略ID', - 'description' => 'Access Center Policy ID', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e', - ], - ], - [ 'name' => 'addonName', - 'in' => 'query', - 'schema' => [ - 'title' => 'Addon名称，如mysql。', - 'description' => 'Addon Release Name', - 'type' => 'string', - 'required' => false, - 'example' => 'release-1234357', - ], + 'in' => 'path', + 'schema' => ['description' => 'This is a query parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'security-actiontrail'], ], [ - 'name' => 'storageType', + 'name' => 'version', 'in' => 'query', - 'schema' => [ - 'title' => '存储类型', - 'description' => 'Storage Type, LogStore/Prometheus/TraceStore/EventStore/EntityStore.', - 'type' => 'string', - 'required' => false, - 'example' => 'LogStore', - ], + 'schema' => ['description' => 'The version number of the add-on.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '*'], ], [ - 'name' => 'addonReleaseName', + 'name' => 'aliyunLang', 'in' => 'query', - 'schema' => [ - 'title' => 'AddonRelease的名称。', - 'description' => 'Name of AddonRelease.', - 'type' => 'string', - 'required' => false, - 'example' => 'kafka-17201012937917', - ], + 'schema' => ['description' => 'The language of the response. Valid values: zh and en. Default value: zh.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'ID of the request', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', - ], - 'storageRequirements' => [ - 'description' => 'List of storage requirements', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'apiVersion' => [ - 'description' => 'API Version', - 'type' => 'string', - 'example' => 'v1', - ], - 'kind' => [ - 'description' => 'Resource kind', - 'type' => 'string', - 'example' => 'Pod', - ], - 'metadata' => [ - 'description' => 'Metadata', + 'data' => [ + 'description' => 'The data returned.', + 'type' => 'object', + 'properties' => [ + 'alias' => ['description' => 'The alias of the component.', 'type' => 'string', 'example' => 'resume_vector_alias', 'title' => ''], + 'categories' => [ + 'description' => 'The list of component categories.', + 'type' => 'array', + 'items' => ['description' => 'The name of the category.', 'type' => 'string', 'example' => 'alibaba-cloud-service', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'dashboards' => [ + 'description' => 'The list of dashboards.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the dashboard.', 'type' => 'object', 'properties' => [ - 'annotations' => [ - 'description' => 'Annotations', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'Annotations', - 'example' => 'prometheus.io/path', - ], - ], - 'labels' => [ - 'description' => 'Resource labels', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'Resource labels', - 'example' => 'key=value', - ], - ], - 'name' => [ - 'description' => 'Resource name', - 'type' => 'string', - 'example' => 'pod-1234567', - ], - 'namespace' => [ - 'description' => 'Namespace', - 'type' => 'string', - 'example' => 'arms-prom', - ], + 'description' => ['description' => 'The description of the dashboard.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'name' => ['description' => 'The name of the dashboard.', 'type' => 'string', 'example' => 'rum_api_dot_metric_set', 'title' => ''], + 'url' => ['description' => 'The URL of the preview image.', 'type' => 'string', 'example' => 'http://iac-service-transfer.oss-cn-hangzhou.aliyuncs.com/78c5_288850010070719968_bdcf7cca781844c8ac4add133791713f', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'spec' => [ - 'description' => 'Resource spec', + 'title' => '', + 'example' => '', + ], + 'description' => ['description' => 'The description of the add-on.', 'type' => 'string', 'example' => 'o11y-demo-cn-heyuan', 'title' => ''], + 'environments' => [ + 'description' => 'The environment information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about a single environment.', 'type' => 'object', 'properties' => [ - 'entityId' => [ - 'description' => 'Instance ID, which can be specified if you need to pinpoint to the instance level. It depends on the data in EntityStore.', - 'type' => 'string', - 'example' => 'es-xxxxx', - ], - 'instance' => [ - 'description' => 'Prom Instance ID.', - 'type' => 'string', - 'example' => 'i-bp122p85gthbniw8rsu9', - ], - 'instanceName' => [ - 'description' => 'Prom instance name', - 'type' => 'string', - 'example' => 'category_predict', - ], - 'project' => [ - 'description' => 'Optional parameter, determined based on the current environment type', - 'type' => 'string', - 'example' => 'datagrid_cdm', - ], - 'region' => [ - 'description' => 'Region', - 'type' => 'string', - 'example' => 'cn-shenzhen', - ], - 'shareScope' => [ - 'description' => 'Storage sharing scope: Environment | Region | Workspace | Custom', - 'type' => 'string', - 'example' => 'Region', - ], - 'storageType' => [ - 'description' => 'Instance storage type', - 'type' => 'string', - 'example' => 'Prometheus', - ], - 'systemTags' => [ - 'description' => 'Tags to be applied to the target storage (injected as system tags)', + 'enable' => ['description' => 'Indicates whether the feature is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'label' => ['description' => 'The display name of the environment.', 'type' => 'string', 'example' => '容器环境', 'title' => ''], + 'dependencies' => [ + 'description' => 'The dependencies.', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'system-key=value', - 'description' => 'Tags to be applied to the target storage (injected as system tags)', + 'properties' => [ + 'clusterTypes' => [ + 'description' => 'The dependencies on cluster types.', + 'type' => 'array', + 'items' => ['description' => 'The cluster type dependency.', 'type' => 'string', 'example' => 'ManagedKubernetes/Default', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'features' => [ + 'description' => 'The dependencies on probes.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Indicates whether the component depends on the target probe.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'services' => [ + 'description' => 'The dependencies on activated services.', + 'type' => 'array', + 'items' => ['description' => 'The service name.', 'type' => 'string', 'example' => 'Prometheus', 'title' => ''], + 'title' => '', + 'example' => '', + ], ], + 'title' => '', + 'example' => '', ], - 'tags' => [ - 'description' => 'Tags to be applied to the target storage (injected as regular tags)', + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'Observability integration.', 'title' => ''], + 'name' => ['description' => 'The name of the add-on.', 'type' => 'string', 'example' => 'cs-default-umodel-1752755202744_k8s.metric.high_level_metric_deployment_cn-hangzhou/c0a686118449c4390b9cc0a07ea3e0e85', 'title' => ''], + 'policies' => [ + 'description' => 'The ID of the resource group.', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'key=value', - 'description' => 'Tags to be applied to the target storage (injected as regular tags)', + 'properties' => [ + 'alertDefaultStatus' => ['description' => 'The status of the default policy for alert rules.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'defaultInstall' => ['description' => 'Indicates whether the add-on is installed by default.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'enableServiceAccount' => ['description' => 'Indicates whether a service account is assigned for communication with the console API.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'metricCheckRule' => [ + 'description' => 'The metric check rule.', + 'type' => 'object', + 'properties' => [ + 'promQL' => [ + 'description' => 'The data check rule that is used after installation.', + 'type' => 'array', + 'items' => ['description' => 'The data check rule that is used after installation.', 'type' => 'string', 'example' => 'up=1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'needRestartAfterIntegration' => ['description' => 'Indicates whether to guide the user to restart pods after the add-on is installed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'protocols' => [ + 'description' => 'The protocol.', + 'type' => 'array', + 'items' => [ + 'description' => 'The protocol.', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'The description of the protocol.', 'type' => 'string', 'example' => 'Support OpenTelemetry Protocol', 'title' => ''], + 'icon' => ['description' => 'The URL of the icon.', 'type' => 'string', 'example' => 'icon URL', 'title' => ''], + 'label' => ['description' => 'The display name of the protocol.', 'type' => 'string', 'example' => 'OpenTelemetry', 'title' => ''], + 'name' => ['description' => 'The name of the protocol.', 'type' => 'string', 'example' => 'OpenTelemetry', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'targetAddonName' => ['description' => 'The name of the target add-on to which the system redirects.', 'type' => 'string', 'example' => 'cs-default', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'userId' => [ - 'description' => 'User ID', - 'type' => 'string', - 'example' => '12345678', - ], - 'workspace' => [ - 'description' => 'Workspace', - 'type' => 'string', - 'example' => 'test-api', - ], - ], - ], - 'status' => [ - 'description' => 'Storage requirement status', - 'type' => 'object', - 'properties' => [ - 'instanceId' => [ - 'description' => 'Instance ID', - 'type' => 'string', - 'example' => 'rmq-cn-uqm3ket1t0u', - ], - 'interUrl' => [ - 'description' => 'Internal URL', - 'type' => 'string', - 'example' => 'http://192.168.xxxxxx', - ], - 'intraUrl' => [ - 'description' => 'External 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\'s metric center', - 'type' => 'string', - 'example' => 'xxxx', - ], - 'region' => [ - 'description' => 'Region', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'storageType' => [ - 'description' => 'Instance storage type', - 'type' => 'string', - 'example' => 'Prometheus', - ], - 'workspace' => [ - 'description' => 'Workspace.', - 'type' => 'string', - 'example' => 'default', + 'policyType' => ['description' => 'The type of the integration policy.', 'type' => 'string', 'example' => 'CS', 'title' => ''], + 'commonSchemaRefs' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'group' => ['description' => 'The group name of the common schema.', 'type' => 'string', 'example' => 'acs-ecs', 'title' => ''], + 'version' => ['description' => 'The version of the common schema.', 'type' => 'string', 'example' => '0.1.3', 'title' => ''], + ], + 'description' => 'The information about the associated common schema.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The list of associated common schemas.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'addonReleaseNames' => [ - 'description' => 'Collection of AddonReleases.', - 'type' => 'array', - 'items' => [ - 'description' => 'Name of the AddonRelease.', - 'type' => 'string', - 'example' => 'kafka-17201238912', - ], - ], + 'title' => '', + 'example' => '', ], + 'icon' => ['description' => 'The URL of the icon.', 'type' => 'string', 'example' => 'https://xxxxx', 'title' => ''], + 'keywords' => [ + 'description' => 'The keywords.', + 'type' => 'array', + 'items' => ['description' => 'A keyword.', 'type' => 'string', 'example' => 'metrics', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'language' => ['description' => 'The language.', 'type' => 'string', 'example' => 'zh', 'title' => ''], + 'latestReleaseCreateTime' => ['description' => 'The time when the latest version was created.', 'type' => 'string', 'example' => '2023-09-12 12:30:30', 'title' => ''], + 'name' => ['description' => 'The name of the add-on.', 'type' => 'string', 'example' => 'rum_api_dashboard_explorer_link_metric_set', 'title' => ''], + 'once' => ['description' => 'Indicates whether the add-on can be installed only once.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'scene' => ['description' => 'The scenario of the component.', 'type' => 'string', 'example' => 'middleware', 'title' => ''], + 'version' => ['description' => 'The version of the component.', 'type' => 'string', 'example' => '*', 'title' => ''], + 'weight' => ['description' => 'The weight.', 'type' => 'string', 'example' => '10', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'requestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetAddon', + 'description' => 'Retrieves the details of an add-on.', + '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' => 'Get Storage Requirements Information for Access Center Policy', - 'description' => 'During the effective period of the policy, all alarms within the application group will no longer send notifications.'."\n" - .' '."\n" - .'This article provides an example of creating a pause alarm notification policy `PauseNotify` for the application group `7301****`. This application group will pause alarms from `1622949300000` to `1623208500000` (Beijing Time `2021-06-06 11:15:00` to `2021-06-09 11:15:00`).', - 'translator' => 'machine', + 'ramActions' => [], + '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"}]', ], - 'ListIntegrationPolicyPodMonitors' => [ - 'summary' => 'Get PodMonitor Resources of Access Center Policy', - 'path' => '/integration-policies/{policyId}/pod-monitors', - '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' => [ - 'title' => '接入中心策略ID。', - 'description' => 'Access center policy ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-1d4634924c8ba599822c601fcee3', - ], + 'schema' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => 'The name of the add-on.', 'example' => 'apm-opentelemetry'], ], [ - 'name' => 'addonReleaseName', + 'name' => 'aliyunLang', 'in' => 'query', - 'schema' => [ - 'title' => 'Addon Release名称。', - 'description' => 'Addon Release name.', - 'type' => 'string', - 'required' => false, - 'example' => 'release-123456789', - ], + 'schema' => ['type' => 'string', 'required' => false, 'title' => '', 'description' => 'The language. Valid values: zh (Chinese) and en (English). Default value: zh.', 'example' => 'zh'], ], [ - 'name' => 'namespace', + 'name' => 'environmentType', 'in' => 'query', - 'schema' => [ - 'title' => '命名空间。', - 'description' => 'Namespace.', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'schema' => ['type' => 'string', 'required' => false, 'title' => '', 'description' => 'The type of environment. Valid values: CS (Container Service) and ECS.', 'example' => 'Client'], ], [ - 'name' => 'encryptYaml', + 'name' => 'version', 'in' => 'query', - 'schema' => [ - 'title' => '是否加密Yaml。', - 'description' => 'Whether to encrypt Yaml.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['type' => 'string', 'description' => 'The version of the component.', 'required' => false, 'title' => '', 'example' => '0.1.0'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'clusterId' => [ - 'description' => 'Cluster ID.', - 'type' => 'string', - 'example' => 'et15prod-et15storage', - ], - 'podMonitors' => [ - 'description' => 'PodMonitor list', + 'codes' => [ 'type' => 'array', 'items' => [ - 'description' => 'PodMonitor list', 'type' => 'object', 'properties' => [ - 'addonName' => [ - 'description' => 'Addon name.', - 'type' => 'string', - 'example' => 'cloud-ecs', - ], - 'addonReleaseName' => [ - 'description' => 'Addon Release name.', - 'type' => 'string', - 'example' => 'release-2345678', - ], - 'addonVersion' => [ - 'description' => 'Addon version.', - 'type' => 'string', - 'example' => '0.0.1', - ], - 'configYaml' => [ - 'description' => 'Configuration yaml.', - 'type' => 'string', - 'example' => 'apiVersion: xxxxx', - ], - 'enableStatus' => [ - 'description' => 'Enable status.', - 'type' => 'string', - 'example' => 'run', - ], - 'encryptYaml' => [ - 'description' => 'Encrypt yaml.', - 'type' => 'boolean', - 'example' => 'YXBpVmVyc2lvbjogeHh4eHgK', - ], - 'endpoints' => [ - 'description' => 'Instance endpoints.', - 'type' => 'array', - 'items' => [ - 'description' => 'Endpoint details', - 'type' => 'object', - 'properties' => [ - 'interval' => [ - 'description' => 'Collection interval', - 'type' => 'string', - 'example' => '30s', - ], - 'matchedTargetCount' => [ - 'description' => 'Number of matched targets', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'path' => [ - 'description' => 'Metric collection path', - 'type' => 'string', - 'example' => '/metrics', - ], - 'port' => [ - 'description' => 'Port number', - 'type' => 'string', - 'example' => '9100', - ], - 'targetPort' => [ - 'description' => 'Target port', - 'type' => 'string', - 'example' => 'https', - ], - ], - ], - ], - 'matchedPodCount' => [ - 'description' => 'Number of matched pods', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'name' => [ - 'description' => 'Collection name.', - 'type' => 'string', - 'example' => 'znzmo_entity_test', - ], - 'namespace' => [ - 'description' => 'Namespace', - 'type' => 'string', - 'example' => 'sla-ns-d5aeb2b4f91b47', - ], + 'codeTemplate' => ['type' => 'string', 'description' => 'The code template.', 'title' => '', 'example' => 'javascript\\nnpm install @arms/rum-miniapp --save'], + 'name' => ['type' => 'string', 'description' => 'The name of the code template.', 'title' => '', 'example' => 'cs-default-CS-cs-default-1753236205394-cs-default-CS-kubeApiserver'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => 'The list of code templates.', + 'title' => '', + 'example' => '', ], - 'policyId' => [ - 'description' => 'Policy 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' => ['type' => 'string', 'title' => '', 'description' => 'The ID of the request.', 'example' => '0CEC5375-C554-562B-A65F-***'], ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetAddonCodeTemplate', + 'summary' => 'Details of an add-on schema.', + 'description' => 'This topic provides an example of how to modify version `1` of alert template `123456`. In this example, the alert level is set to `Critical`, the statistical method is set to `Average`, the comparison operator for the alert threshold is set to `GreaterThanOrEqualToThreshold`, the alert threshold is set to `90`, and the number of retries is set to `3`. The response indicates that the alert template was successfully modified.', + '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' => 'Query PodMonitor Resources of Access Center Policy', - 'description' => 'This article provides an example to query the alarm template list. The result shows that there are 2 alarm templates in the alarm template list, which are `ECS_Template1` and `ECS_Template2`.', - 'translator' => 'machine', + '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"}]', ], - 'ListIntegrationPolicyDashboards' => [ - 'summary' => 'Policy Dashboard List', - 'path' => '/integration-policies/{policyId}/dashboards', - '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' => 'policyId', + 'name' => 'releaseName', 'in' => 'path', - 'schema' => [ - 'description' => 'Policy ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e', - ], + 'schema' => ['title' => 'AddonRelease 的名称。', 'description' => 'The name of the add-on release.', 'type' => 'string', 'required' => true, 'example' => 'test-gpu-integration-name'], ], [ - 'name' => 'addonName', - 'in' => 'query', - 'schema' => [ - 'description' => 'Addon Name.', - 'type' => 'string', - 'required' => false, - 'example' => 'cs-default', - ], - ], - [ - 'name' => 'scene', - 'in' => 'query', - 'schema' => [ - 'description' => 'Component Scenario.', - 'type' => 'string', - 'required' => false, - 'example' => 'databse', - ], - ], - [ - 'name' => 'language', - 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'Query Language', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - 'default' => 'zh', - 'enum' => [ - 'zh', - 'en', - ], - ], + 'name' => 'policyId', + 'in' => 'path', + 'schema' => ['title' => '环境 ID。', 'description' => 'The ID of the environment.', 'type' => 'string', 'required' => true, 'example' => 'policy-xxxxxxxxxxxx'], ], ], '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', - ], - 'total' => [ - 'description' => 'Number of components.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'dashboards' => [ - 'description' => 'List of dashboards.', - 'type' => 'array', - 'items' => [ - 'description' => 'List of dashboards.', - 'type' => 'object', - 'properties' => [ - 'uid' => [ - 'description' => 'ID of the current Alibaba Cloud primary account, read-only', - 'type' => 'string', - 'example' => '1258199346721590', - ], - 'engine' => [ - 'title' => '大盘引擎：'."\n" - .'grafana：共享grafana。'."\n" - .'cms：cms自研大盘引擎。', - 'description' => 'Dashboard engine:'."\n" - .'grafana: shared grafana.'."\n" - .'cms: cms self-developed dashboard engine.', - 'type' => 'string', - 'example' => 'grafana', - ], - 'title' => [ - 'description' => 'Title of the UI module (not name)', - 'type' => 'string', - 'example' => 'test', - ], - 'name' => [ - 'title' => '大盘名称', - 'description' => 'Dashboard name', - 'type' => 'string', - 'example' => 'k8s-pod', - ], - 'url' => [ - 'description' => 'pagerDuty integration webhook. Supports V1 and V2 versions', - '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' => 'Region', - 'type' => 'string', - 'example' => 'cn-hongkong', - ], - 'folderUid' => [ - 'description' => 'UID of the dashboard folder.', - 'type' => 'string', - 'example' => 'Env-AAA', - ], - 'tags' => [ - 'description' => 'List of tags.', - 'type' => 'array', - 'items' => [ - 'description' => 'Tag.', - 'type' => 'string', - 'example' => 'tag1', + 'config' => ['title' => '组件配置。', 'description' => 'The configuration of the component.', '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' => 'The details of the release.', + 'type' => 'object', + 'properties' => [ + 'addonName' => ['title' => '组件 Addon 名称。', 'description' => 'The name of the add-on component.', 'type' => 'string', 'example' => 'cs-gpu'], + 'alertRuleCount' => ['title' => '告警规则数量。', 'description' => 'The number of alert rules.', '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' => 'Information about the installation phases.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'firstTransitionTime' => ['title' => '第一次转换时间。', 'description' => 'The time when the phase first transitioned.', 'type' => 'string', 'example' => '2024-11-04T16:10:22+08:00'], + 'lastTransitionTime' => ['title' => '最后一次转换时间。', 'description' => 'The time when the phase last transitioned.', 'type' => 'string', 'example' => '2024-11-04T16:10:22+08:00'], + 'message' => ['title' => '详细信息。', 'description' => 'The detailed message.', 'type' => 'string', 'example' => 'The addon loaded successfully'], + 'status' => ['title' => '阶段状态。', 'description' => 'The status of the phase.', 'type' => 'string', 'example' => 'True'], + 'type' => ['title' => '阶段类型。', 'description' => 'The type of the phase.', 'type' => 'string', 'example' => 'Loaded'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], + 'example' => '', + ], + 'config' => ['title' => '组件配置信息。', 'description' => 'The configuration information of the component.', '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' => 'The time when the add-on was accessed.', 'type' => 'string', 'example' => '2024-11-04T16:10:12+08:00'], + 'dashboardCount' => ['title' => '大盘数量。', 'description' => 'The number of dashboards.', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'environmentId' => ['title' => '环境 ID。', 'description' => 'The ID of the environment.', 'type' => 'string', 'example' => 'policy-xxxxxxxxxxx'], + 'exporterCount' => ['title' => '插件数量。', 'description' => 'The number of plug-ins.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'haveConfig' => ['title' => '是否有配置。', 'description' => 'Indicates whether a configuration exists.', 'type' => 'boolean', 'example' => 'true'], + 'installUserId' => ['title' => '接入用户 ID。', 'description' => 'The ID of the user who accessed the add-on.', 'type' => 'string', 'example' => '1707xxxxxxxxxxxx'], + 'language' => ['title' => '语言。', 'description' => 'The language.', 'type' => 'string', 'example' => 'zh'], + 'managed' => ['title' => '是否为托管组件。', 'description' => 'Indicates whether the component is a managed component.', 'type' => 'boolean', 'example' => 'true'], + 'parentAddonReleaseId' => ['title' => '父级 AddonReleaseId。', 'description' => 'The ID of the parent add-on release.', 'type' => 'string', 'example' => 'policy-xxxxxxxxxxxxx'], + 'policyId' => ['title' => '策略 ID。', 'description' => 'The ID of the policy.', 'type' => 'string', 'example' => 'policy-xxxxxxxxxxxxx'], + 'regionId' => ['title' => '区域 ID。', 'description' => 'The ID of the region.', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'releaseId' => ['title' => 'Release ID。', 'description' => 'The ID of the release.', 'type' => 'string', 'example' => '7339d808-66f9-4d40-83fa-xxxxxxxxxxx'], + 'releaseName' => ['title' => 'Release 的名称。', 'description' => 'The name of the release.', 'type' => 'string', 'example' => 'test-gpu-integration-name'], + 'scene' => ['title' => '组件场景。', 'description' => 'The scenario of the component.', 'type' => 'string', 'example' => 'container'], + 'status' => ['title' => '组件状态。', 'description' => 'The status of the component.', 'type' => 'string', 'example' => 'running'], + 'updateTime' => ['title' => '更新时间。', 'description' => 'The time when the release was last updated.', 'type' => 'string', 'example' => '2024-11-04T16:10:12+08:00'], + 'userId' => ['title' => '所属用户 ID。', 'description' => 'The ID of the user to which the release belongs.', 'type' => 'string', 'example' => '1707xxxxxxxxxxxx'], + 'version' => ['title' => '组件版本。', 'description' => 'The version of the component.', 'type' => 'string', 'example' => '0.0.2'], + 'envType' => ['title' => '环境类型。', 'description' => 'The type of the environment.', 'type' => 'string', 'example' => 'CS'], + 'workspace' => ['title' => '工作空间。', 'description' => 'The workspace.', 'type' => 'string', 'example' => 'default'], + 'entityRules' => ['title' => '实体详情。', 'description' => 'The details of the entity.', '$ref' => '#/components/schemas/EntityGroupBase', 'example' => ''], ], + 'title' => '', + 'example' => '', ], + 'requestId' => ['title' => '请求 ID。', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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' => 'Query Dashboard List', - 'description' => 'This article provides an example of querying the alarm template list. The result shows that there are 2 alarm templates in the list, which are `ECS_Template1` and `ECS_Template2`.', - 'translator' => 'machine', - ], - 'ListIntegrationPolicyCustomScrapeJobRules' => [ - 'summary' => 'Get storage requirement information for the access center policy', - 'path' => '/integration-policies/{policyId}/custom-scrape-job-rules', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'View Add-on Component Information', + 'summary' => 'Queries the details and accessed state of an add-on release.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '210', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAddonRelease'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + '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' => 'The details of an add-on schema.', + 'path' => '/addons/{addonName}/schema', + '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' => [ - 'title' => '接入中心策略ID。', - 'description' => 'Access center policy ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-d95435164593aece55f9999ce45c', - ], + 'schema' => ['title' => '', 'description' => 'The name of the add-on.', 'type' => 'string', 'required' => true, 'example' => 'cloud-rds-audit-log'], ], [ - 'name' => 'addonReleaseName', + 'name' => 'aliyunLang', 'in' => 'query', - 'schema' => [ - 'title' => 'Addon Release名称。', - 'description' => 'Addon Release name.', - 'type' => 'string', - 'required' => false, - 'example' => 'release12345678', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values: \\`zh\\` and \\`en\\`. The default value is \\`zh\\`.', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], [ - 'name' => 'encryptYaml', + 'name' => 'environmentType', 'in' => 'query', - 'schema' => [ - 'title' => '是否加密Yaml。', - 'description' => 'Whether to encrypt Yaml.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['title' => '', 'description' => 'The environment type. Valid values: \\`CS\\` (container) and \\`ECS\\`.', 'type' => 'string', 'required' => false, 'example' => 'CS'], ], [ - 'name' => 'namespace', + 'name' => 'version', 'in' => 'query', - 'schema' => [ - 'title' => '命名空间。', - 'description' => 'Namespace.', - 'type' => 'string', - 'required' => false, - 'example' => 'arms-prom', - ], + 'schema' => ['description' => 'The version of the component.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '0.1.1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'clusterId' => [ - 'description' => 'Cluster ID.', - 'type' => 'string', - 'example' => 'et15prod-et15storage', - ], - 'customScrapeJobRules' => [ - 'description' => 'Custom scraping job rules', + 'fields' => [ + 'description' => 'A list of data table fields.', 'type' => 'array', 'items' => [ - 'description' => 'Custom service discovery rules', + 'description' => 'The information about a data table field.', 'type' => 'object', 'properties' => [ - 'addonName' => [ - 'description' => 'Addon name.', - 'type' => 'string', - 'example' => 'cloud-ecs', - ], - 'addonReleaseName' => [ - 'description' => 'Addon Release name', - 'type' => 'string', - 'example' => 'release-12345678', - ], - 'addonVersion' => [ - 'description' => 'Addon version', - 'type' => 'string', - 'example' => '0.0.1', - ], - 'configYaml' => [ - 'description' => 'Configuration yaml', - 'type' => 'string', - 'example' => 'scrape_cofnigs:'."\n" - .'- jobxxxxxx', - ], - 'enableStatus' => [ - 'description' => 'Enable status', - 'type' => 'string', - 'example' => 'mini', - ], - 'encryptYaml' => [ - 'description' => 'Encrypt yaml', - 'type' => 'boolean', - 'example' => 'true', - ], - 'matchedPodCount' => [ - 'description' => 'Matched pod count', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'message' => [ - 'description' => 'Detailed information.', - 'type' => 'string', - 'example' => 'ok', - ], - 'name' => [ - 'description' => 'Service name.', - 'type' => 'string', - 'example' => 'dlab1', - ], - 'namespace' => [ - 'description' => 'Namespace', - 'type' => 'string', - 'example' => 'prod-data', - ], - 'scrapeConfigs' => [ - 'description' => 'Custom configurations', + 'conditions' => [ + 'description' => 'A list of display conditions.', 'type' => 'array', 'items' => [ - 'description' => 'Custom configurations', + 'description' => 'A display condition.', 'type' => 'object', 'properties' => [ - 'jobName' => [ - 'description' => 'Scraping job name', - 'type' => 'string', - 'example' => 'mysql-exporter', - ], - 'message' => [ - 'description' => 'Detailed information.', - 'type' => 'string', - 'example' => 'successful', - ], - 'metricsPath' => [ - 'description' => 'Metrics path', - 'type' => 'string', - 'example' => '/metrics', - ], - 'scheme' => [ - 'description' => 'Call method.', - 'type' => 'string', - 'example' => 'http', - ], - 'scrapeInterval' => [ - 'description' => 'Scrape interval', - 'type' => 'string', - 'example' => '30s', - ], - 'scrapeTimeout' => [ - 'description' => 'Scrape timeout', - 'type' => 'string', - 'example' => '60s', - ], - 'serviceDiscoveryConfigs' => [ - 'description' => 'Service discovery configuration', - 'type' => 'array', - 'items' => [ - 'description' => 'Service discovery configuration', - 'type' => 'string', - 'example' => '{}', + 'action' => ['description' => 'The control mode of the field.', 'type' => 'string', 'title' => '', 'example' => 'show'], + 'field' => ['description' => 'The name of the field.', 'type' => 'string', 'title' => '', 'example' => 'store.storageTarget'], + 'op' => ['description' => 'The operator for the condition.', 'type' => 'string', 'title' => '', 'example' => '=='], + 'value' => ['description' => 'The target value for the condition.', 'type' => 'any', 'title' => '', 'example' => 'Custom'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'defaultValue' => ['description' => 'The default value.', 'type' => 'any', 'title' => '', 'example' => 'mysql.default'], + 'description' => ['description' => 'The description.', 'type' => 'string', 'title' => '', 'example' => 'MySQL datasource'], + 'disabled' => ['description' => 'Specifies whether the field is hidden. Valid values: \\`true\\` (hidden) and \\`false\\` (displayed).', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'element' => ['description' => 'The type of the element.', 'type' => 'string', 'title' => '', 'example' => 'input'], + 'fieldPath' => ['type' => 'string', 'description' => 'The path of the field.', 'title' => '', 'example' => 'mysql.host'], + 'label' => ['description' => 'The display name of the field.', 'type' => 'string', 'title' => '', 'example' => 'mysql'], + 'name' => ['description' => 'The name of the field.', 'type' => 'string', 'title' => '', 'example' => 'host'], + 'placeholder' => ['description' => 'The placeholder text.', 'type' => 'string', 'title' => '', 'example' => 'Please enter the metrics collection interval'], + 'props' => [ + 'description' => 'Other properties of the component.', + 'type' => 'object', + 'properties' => [ + 'dataSource' => [ + 'description' => 'The information about the data source.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the data source.', + 'type' => 'object', + 'properties' => [ + 'label' => ['description' => 'The label.', 'type' => 'string', 'title' => '', 'example' => 'tagKey'], + 'value' => ['description' => 'The value of the label.', 'type' => 'string', 'title' => '', 'example' => 'tagValue'], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', + ], + 'related' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => 'Related data.', 'title' => '', 'example' => 'mysql.host'], + 'description' => 'A collection of related data.', + 'title' => '', + 'example' => '', ], + 'selectMode' => ['type' => 'string', 'description' => 'The mode.', 'title' => '', 'example' => 'single'], ], + 'title' => '', + 'example' => '', + ], + 'type' => ['description' => 'The type of the field.', 'type' => 'string', 'title' => '', 'example' => 'string'], + 'validation' => [ + 'type' => 'object', + 'properties' => [ + 'max' => ['description' => 'The maximum value. The value is inclusive.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2000'], + 'maxLength' => ['description' => 'The maximum length that is supported by the text control.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'], + 'message' => ['description' => 'The details.', 'type' => 'string', 'title' => '', 'example' => 'length limit'], + 'min' => ['description' => 'The minimum value.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'minLength' => ['description' => 'The minimum length.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '16'], + 'regular' => ['type' => 'string', 'description' => 'The regular expression.', 'title' => '', 'example' => '^(http|https)://'], + 'required' => ['description' => 'Specifies whether the parameter is required.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + ], + 'description' => 'The validation rule for the field.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'policyId' => [ - 'description' => 'Policy 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' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'E5B1D3D4-BB28-5996-8AD2-***********'], + 'type' => ['description' => 'The type of the schema.', 'type' => 'string', 'title' => '', 'example' => 'common'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetAddonSchema', + 'description' => 'Retrieves the schema of an add-on.', + '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' => 'Get Custom Service Discovery Rules for Access Center Policy', - 'translator' => 'machine', + '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' => 'Query Access Center Policy List Information', - 'path' => '/integration-policies', - 'methods' => [ - 'get', + 'GetAggTaskGroup' => [ + 'summary' => 'Queries an aggregation task group.', + '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' => 'The ID of the Prometheus instance to which the aggregation task group belongs.', 'type' => 'string', 'required' => true, 'example' => 'rw-xxx'], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => ['title' => '聚合任务组 id', 'description' => 'The ID of the aggregation task group.', 'type' => 'string', 'required' => true, 'example' => 'aggTaskGroup-xxx'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '出参结构体', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'aggTaskGroup' => [ + 'title' => '聚合任务组', + 'description' => 'The aggregation task group.', + 'type' => 'object', + 'properties' => [ + 'aggTaskGroupConfig' => ['title' => '聚合任务组配置', 'description' => 'The configuration of the aggregation task group.', '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' => 'The summary of the aggregation task group configuration.', 'type' => 'string', 'example' => 'a54136xxx'], + 'aggTaskGroupId' => ['title' => '聚合任务组 id', 'description' => 'The ID of the aggregation task group.', 'type' => 'string', 'example' => 'aggTaskGroup-xx'], + 'aggTaskGroupName' => ['title' => '聚合任务组名称', 'description' => 'The name of the aggregation task group.', 'type' => 'string', 'example' => 'pipeline-aggtask-group'], + 'cronExpr' => ['title' => '调度模式选择“Cron”情况下，聚合任务组的调度表达式', 'description' => 'The scheduling expression of the aggregation task group when the scheduling mode is set to Cron.', 'type' => 'string', 'example' => '0 1 3 * * ? *'], + 'delay' => ['title' => '调度的固定延迟时间', 'description' => 'The fixed delay time for scheduling, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'description' => ['title' => '聚合任务组描述'."\n" + ."\n", 'description' => 'The description of the aggregation task group.', 'type' => 'string', 'example' => 'test'], + 'fromTime' => ['title' => '调度开始时间对应的的秒级时间戳', 'description' => 'The UNIX timestamp in seconds that corresponds to the start time of the scheduling. This parameter is not yet in effect.', 'type' => 'integer', 'format' => 'int64', 'example' => '1757409495'], + 'maxRetries' => ['title' => '执行聚合任务的最大重试次数', 'description' => 'The maximum number of retries to execute the aggregation task.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'maxRunTimeInSeconds' => ['title' => '执行聚合任务的最大重试时间', 'description' => 'The maximum runtime of the aggregation task, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '50'], + 'precheckString' => ['title' => '预检测配置', 'description' => 'The dry run configuration.', 'type' => 'string', 'example' => '{"policy":"skip","prometheusId":"rw-xx","query":"noPrecheck","threshold":0.5,"timeout":15,"type":"none"}'], + 'regionId' => ['title' => '地域 id', 'description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-zhangjiakou'], + 'scheduleMode' => ['title' => '调度模式', 'description' => 'The scheduling mode.', 'type' => 'string', 'example' => 'FixedRate'], + 'scheduleTimeExpr' => ['title' => '调度时间表达式', 'description' => 'The scheduling time expression.', 'type' => 'string', 'example' => '@m'], + 'sourcePrometheusId' => ['title' => '聚合任务组的源 Prometheus 实例 id', 'description' => 'The ID of the source Prometheus instance for the aggregation task group.', 'type' => 'string', 'example' => 'rw-xxx'], + 'status' => ['title' => '聚合任务组状态', 'description' => 'The status of the aggregation task group.', 'type' => 'string', 'example' => 'Running'], + 'tags' => [ + 'title' => '资源组标签', + 'description' => 'The tags of the resource group.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.', + 'type' => 'object', + 'properties' => [ + 'key' => ['title' => '资源组标签的键', 'description' => 'The key of the resource group tag.', 'type' => 'string', 'example' => 'key1'], + 'value' => ['title' => '资源组标签的值', 'description' => 'The value of the resource group tag.', 'type' => 'string', 'example' => 'value1'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'targetPrometheusId' => ['title' => '聚合任务组的目标 Prometheus 实例 id', 'description' => 'The ID of the target Prometheus instance for the aggregation task group.', 'type' => 'string', 'example' => 'rw-xxx'], + 'toTime' => ['title' => '调度结束时间对应的秒级时间戳', 'description' => 'The UNIX timestamp in seconds that corresponds to the end time of the scheduling.', 'type' => 'integer', 'format' => 'int64', 'example' => '1757409495'], + 'updateTime' => ['title' => '聚合任务组的更新时间', 'description' => 'The time when the aggregation task group was updated. This is a timestamp.', 'type' => 'string', 'example' => '1757409499000'], + 'userId' => ['title' => '聚合任务组所属用户', 'description' => 'The user to which the aggregation task group belongs.', 'type' => 'string', 'example' => '123xxx'], + ], + 'example' => '', + ], + 'requestId' => ['title' => '请求 id', 'description' => 'The request ID.', 'type' => 'string', 'example' => '68DAF543-35DF-5762-BE90-F5C00B5DC036'], + 'success' => ['title' => '请求是否成功', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True'], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query Aggregation Task Group', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAggTaskGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + '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' => 'Queries a business trace.', + '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' => ['type' => 'string', 'description' => 'The ID of the business trace.', 'required' => false, 'title' => '', 'example' => 'e339260ed64c95d'], + ], ], - 'produces' => [ - 'application/json', + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['type' => 'string', 'description' => 'The request ID.', 'title' => '', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'item' => ['$ref' => '#/components/schemas/BizTraceConfig', 'description' => 'The business trace.', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetBizTrace', + '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' => [ + 'summary' => 'Retrieves information about cloud resources.', + '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' => 'Policy ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'policy-93817a401f78435596d745a97d2e85a1', + 'type' => 'object', + 'properties' => [ + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-heyuan', 'title' => ''], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetCloudResource', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'policyName', - 'in' => 'query', - 'schema' => [ - 'description' => 'Rule name.', - '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' => 'Queries all entity information of a specific cloud service within a specified time range.', + 'path' => '/cloudresource/data', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'policyType', - 'in' => 'query', - 'schema' => [ - 'description' => 'Policy type', - '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 name.', - 'type' => 'string', - 'required' => false, - 'example' => 'cs-default', - ], + 'schema' => ['description' => 'The start of the query time range.'."\n" + ."\n" + .'The value is a UNIX timestamp in seconds, which represents the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1721767203', 'title' => ''], ], [ - 'name' => 'filterRegionIds', + 'name' => 'to', 'in' => 'query', - 'schema' => [ - 'description' => 'Used for Region query, separated by commas', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing,cn-hangzhou', - 'title' => '指定筛选的regionId（目前仅支持单regioinId，暂不支持多值）。', - ], + 'schema' => ['description' => 'The end of the query time range.'."\n" + ."\n" + .'The value is a UNIX timestamp in seconds, which represents the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1721767203', 'title' => ''], ], [ - 'name' => 'resourceGroupId', + 'name' => 'query', 'in' => 'query', - 'schema' => [ - 'description' => 'Resource group ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-xxxxx', - ], + 'schema' => ['description' => 'The query statement.', 'type' => 'string', 'required' => true, 'example' => '.entity with(domain=\'acs\', type=\'acs.k8s.node\') | limit 0, 10', 'title' => ''], ], - [ - 'name' => 'tag', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Tag list.', - 'type' => 'array', - 'items' => [ - 'description' => 'Tag list in JSON format.', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => 'Tag key', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'title' => '', + 'description' => 'The response body that contains the request status, data, and other information.', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => 'The total list of returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data list corresponding to the header.', + 'type' => 'array', + 'items' => ['description' => 'The data corresponding to the request header.', 'type' => 'string', 'example' => 'data1', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'value' => [ - 'description' => 'Tag value', - 'type' => 'string', - 'required' => false, - 'example' => 'value', + 'title' => '', + 'example' => '', + ], + 'header' => [ + 'description' => 'The list of headers.', + 'type' => 'array', + 'items' => ['description' => 'The header.', 'type' => 'string', 'example' => 'headerKey', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'responseStatus' => [ + 'description' => 'The result status.', + 'type' => 'object', + 'properties' => [ + 'result' => ['description' => 'The execution result.', 'type' => 'string', 'example' => 'Success,PartialSuccess,Error', 'title' => ''], + 'retryPolicy' => ['description' => 'The retry policy.', 'type' => 'string', 'example' => 'None,Once,Continuous', 'title' => ''], + 'level' => ['description' => 'The status level.', 'type' => 'string', 'example' => 'Info,Warn,Error', 'title' => ''], + 'statusItem' => [ + 'description' => 'The detailed status information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The detailed status information.', + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'Success,ExecuteTimeout,UModelNotExist', 'title' => ''], + 'level' => ['description' => 'The status level.', 'type' => 'string', 'example' => 'Info,Warn,Error', 'title' => ''], + 'message' => ['description' => 'The message content.', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'suggestion' => ['description' => 'The suggestion when an execution error occurs.', 'type' => 'string', 'example' => 'Try to reduce the query scope or increase timeout limit, then retry', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'executionStates' => ['description' => 'The information during execution.', 'type' => 'string', 'example' => '{}', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'required' => false, ], - 'required' => false, + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve cloud service entity data', + 'description' => '## Operation description'."\n" + .'- This operation queries all entities of a specific cloud service within a specified time range.'."\n" + .'- The `from` and `to` parameters specify the time range of the query in seconds-level timestamps.'."\n" + .'- The `spl` parameter supports entityStore query statements to filter or select the required entities and their properties.'."\n" + .'- If you need only specific fields, use the `project` clause in `spl` to filter them.'."\n" + .'- The response contains the specific property values of each entity and the corresponding list of property names for easy parsing and processing.', + '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' => 'Checks whether a Prometheus service or product is activated.', + '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' => 'Used to return more results. This parameter is not required for the first query. For subsequent queries, use the Token obtained from the response.', 'type' => 'string', + 'enum' => ['prometheus'], + 'title' => '', + 'description' => 'prometheus: Checks the activation status of the Prometheus service. The service is billed by reported data volume or written data volume.', 'required' => false, - 'example' => 'mvnX6zqg3P', + 'enumValueTitles' => ['prometheus' => 'prometheus'], + 'example' => 'prometheus', ], ], [ - 'name' => 'maxResults', + 'name' => 'service', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'Maximum number of results to return. Default is 30, with a maximum of 100.', - 'type' => 'integer', - 'format' => 'int32', + 'type' => 'string', + 'enum' => ['prometheus', 'prometheusgb', 'promethues', 'ackpro'], + 'title' => '', + 'description' => 'prometheus: Checks whether the Prometheus product that is billed by reported data volume is activated.prometheusgb: Checks whether the Prometheus product that is billed by written data volume is activated.', 'required' => false, - 'example' => '30', + 'enumValueTitles' => ['prometheusgb' => 'prometheusgb', 'promethues' => 'prometheus'], + 'example' => 'prometheus', ], ], - [ - 'name' => 'entityGroupIds', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Filter for entity IDs, separated by commas', - 'type' => 'string', - 'required' => false, - 'example' => 'eg-1,eg-2,eg-3', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'enabled' => ['type' => 'boolean', 'description' => 'Indicates whether the service or product is activated.', 'title' => '', 'example' => 'false'], + 'errorCode' => ['type' => 'string', 'title' => '', 'description' => 'PROM\\_NOT\\_OPEN: Prometheus is not activated.SLS\\_NOT\\_OPEN: Simple Log Service (SLS), a dependency of Prometheus, is not activated.CMS\\_SLR\\_NOT\\_EXIST: The service-linked role (SLR) for CloudMonitor does not exist.SLS\\_SLR\\_NOT\\_EXIST: The SLR for SLS does not exist.', 'example' => 'PROM_NOT_OPEN'], + ], + 'title' => '', + 'description' => 'The response schema.', + 'example' => '', ], ], + ], + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetCmsService', + 'description' => 'The product and service request parameters cannot be specified in the same request.', + '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"}]', + 'translator' => 'machine', + ], + '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' => 'Workspace.', - 'type' => 'string', - 'required' => false, - 'example' => 'demo', - ], + 'in' => 'path', + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'query', - 'in' => 'query', - 'schema' => [ - 'description' => 'Used for general queries', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the context store.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-context-store', 'title' => ''], ], [ - 'name' => 'prometheusInstanceId', + 'name' => 'contextId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the context.', 'type' => 'string', 'required' => true, 'minLength' => 1, 'example' => '897294a7-67a4-4f60-976c-e136edc5f97e', 'title' => ''], + ], + [ + 'name' => 'formatted', 'in' => 'query', + 'schema' => ['description' => 'Whether to return the context in a formatted structure. Valid values: `true` and `false`. Default value: `false`.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => ['description' => 'The details of the context.', 'type' => 'object', 'example' => '{}', 'title' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetContext', + 'summary' => 'Retrieves a single context.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + ], + 'GetContextStore' => [ + 'summary' => 'Retrieves the details of a specified context store.', + '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' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The context store name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-context-store', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'cmee-622d27c2e87d49debceeebc7c642610e', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****', 'title' => ''], + 'contextStoreName' => ['description' => 'The context store name.', 'type' => 'string', 'example' => 'test-context-store', 'title' => ''], + 'workspace' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'workspace-test', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'contextType' => ['description' => 'The type of the context store.', 'type' => 'string', 'example' => 'memory', 'title' => ''], + 'description' => ['description' => 'The description of the context store.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'status' => ['description' => 'The status of the context store.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'config' => [ + 'type' => 'object', + 'properties' => [ + 'innerSource' => [ + 'type' => 'object', + 'properties' => [ + 'project' => ['description' => 'The name of the Log Service project.', 'type' => 'string', 'example' => 'sls-test-project', 'title' => ''], + 'logstore' => ['description' => 'The name of the Log Service logstore.', 'type' => 'string', 'example' => 'sls-test-logstore', 'title' => ''], + ], + 'description' => 'The internal source.', + 'title' => '', + 'example' => '', + ], + 'source' => [ + 'type' => 'object', + 'properties' => [ + 'project' => ['description' => 'The name of the Log Service project.', 'type' => 'string', 'example' => 'sls-test-project', 'title' => ''], + 'logstore' => ['description' => 'The name of the Log Service logstore.', 'type' => 'string', 'example' => 'sls-test-logstore', 'title' => ''], + 'startTime' => ['description' => 'The time when the configuration takes effect. This value is a Unix timestamp in milliseconds.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1754962200000', 'title' => ''], + ], + 'description' => 'The configuration source.', + 'title' => '', + 'example' => '', + ], + 'metadataField' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'The key-value pairs that map metadata fields to their source attributes.', 'type' => 'string', 'example' => '{'."\n" + .' "project": "attributes.project",'."\n" + .' "logstore": "attributes.logstore",'."\n" + .' "agentId": "attributes.agent_id",'."\n" + .' "scene": "attributes.scene"'."\n" + .' }', 'title' => ''], + 'description' => 'The metadata fields.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The configuration of the context store.', + 'title' => '', + 'example' => '', + ], + 'dataset' => [ + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the dataset.', 'type' => 'string', 'example' => 'test_dataset', 'title' => ''], + ], + 'description' => 'Information about the associated dataset.', + 'title' => '', + 'example' => '', + ], + 'createTime' => ['description' => 'The creation time of the context store. This value is a Unix timestamp in seconds.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1695090077', 'title' => ''], + 'updateTime' => ['description' => 'The last update time of the context store. This value is a Unix timestamp in seconds.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1695090077', 'title' => ''], + ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetContextStore', + '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' => [ + [ + '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' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], + ], [ - 'name' => 'bindResourceId', - 'in' => 'query', + 'name' => 'datasetName', + 'in' => 'path', + 'schema' => ['description' => 'The dataset name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test_dataset', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '绑定的资源Id', - 'description' => 'Bound resource ID', - 'type' => 'string', - 'required' => false, - 'example' => '622d27c2e87d49debceeebc7c642610e', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'The description of the dataset.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'createTime' => ['description' => 'The time the dataset was created, as a Unix timestamp.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1695090077', 'title' => ''], + 'requestId' => ['description' => 'The unique identifier for the request.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****', 'title' => ''], + 'updateTime' => ['description' => 'The time the dataset was last updated, as a Unix timestamp.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1695090077', 'title' => ''], + 'workspace' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'workspace-test', 'title' => ''], + 'datasetName' => ['description' => 'The name of the dataset.', 'type' => 'string', 'example' => 'test_dataset', 'title' => ''], + 'regionId' => ['description' => 'The ID of the region where the dataset is located.', 'type' => 'string', 'example' => 'cn-heyuan', 'title' => ''], + 'schema' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'The structure of a field within the schema.', '$ref' => '#/components/schemas/IndexKey', 'title' => '', 'example' => ''], + 'description' => 'The data schema of the dataset.', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetDataset', + 'summary' => 'Retrieves the details of a specified dataset.', + '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\\": false,\\n \\"type\\": \\"\\",\\n \\"embedding\\": \\"\\",\\n \\"jsonKeys\\": {\\n \\"key\\": {\\n \\"type\\": \\"\\",\\n \\"chn\\": false\\n }\\n }\\n }\\n }\\n}","type":"json"}]', + ], + 'GetDeliveryTask' => [ + 'summary' => 'Retrieves the details of a data delivery task.', + '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' => 'The delivery task ID.', 'type' => 'string', 'required' => true, 'example' => '98e367d8fb8cc83b', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ - 'maxResults' => [ - 'description' => 'Page size'."\n" - .'Default value:'."\n" - .' 50'."\n" - .'Maximum value:'."\n" - .' 50', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'nextToken' => [ - 'description' => 'Pagination token', - 'type' => 'string', - 'example' => '44ANBjKZmQeKnaB1fXRq06w7sFYK3MUcCALMD9qQbmEiE', - ], - 'policies' => [ - 'description' => 'Access policy list', - 'type' => 'array', - 'items' => [ - 'description' => 'Access policy', - 'type' => 'object', - 'properties' => [ - 'bindResource' => [ - 'description' => 'Bound resource information', - 'type' => 'object', - 'properties' => [ - 'clusterId' => [ - 'description' => 'Cluster ID.', - 'type' => 'string', - 'example' => 'cv68tt87d78vyc89zy9v', - ], - 'clusterType' => [ - 'description' => 'Cluster type.', - 'type' => 'string', - 'example' => 'ManagedKubernetes', - ], - 'vpcCidr' => [ - 'description' => 'VPC CIDR', - 'type' => 'string', - 'example' => '100.100.0.1/16', - ], - 'vpcId' => [ - 'description' => 'Virtual Private Cloud (VPC).', - 'type' => 'string', - 'example' => 'vpc-uf664nyle5khp5d4d7hdo', - ], + 'deliveryTask' => [ + 'description' => 'The delivery task details.', + 'type' => 'object', + 'properties' => [ + 'taskId' => ['description' => 'The delivery task ID.', 'type' => 'string', 'example' => '8b07eeac8249866d', 'title' => ''], + 'taskName' => ['description' => 'The task name.', 'type' => 'string', 'example' => 'test-task', 'title' => ''], + 'taskDescription' => ['description' => 'The task description.', 'type' => 'string', 'example' => 'my delivery task', 'title' => ''], + 'status' => ['description' => 'The current status of the task.', 'type' => 'string', 'example' => 'Enable', 'title' => ''], + 'dataSourceId' => ['description' => 'The data source ID (Managed Service for Prometheus instance ID).', 'type' => 'string', 'example' => 'rw-xxxxxx', 'title' => ''], + 'labelFiltersType' => [ + 'description' => 'The metric filtering mode.', + 'enumValueTitles' => ['Deny' => 'Deny', 'Allow' => 'Allow'], + 'type' => 'string', + 'example' => 'Allow', + 'title' => '', + ], + 'labelFilters' => [ + 'description' => 'The metric filter conditions. Used together with labelFiltersType. The key is the metric label name, and the value is the match value.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'filterKey → filterValue. Example: __name__ → up, job → my_job.', 'type' => 'string', 'example' => '__name__: up', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'externalLabels' => [ + 'description' => 'The additional labels attached to all delivered metrics. The key is the label name, and the value is the label value.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'externalLabelsKey → externalLabelsValue. Example: region → ap-southeast-1.', 'type' => 'string', 'example' => 'region: cn-hangzhou', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'createTime' => ['description' => 'The creation time.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2025-07-24T02:08:27Z', 'title' => ''], + 'updateTime' => ['description' => 'The update time.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2026-01-22T11:50:48Z', 'title' => ''], + 'extraInfo' => [ + 'description' => 'The extended information.', + 'type' => 'object', + 'properties' => [ + 'taskNameList' => [ + 'description' => 'The EventBridge task list.', + 'type' => 'array', + 'items' => ['description' => 'The EventBridge task name.', 'type' => 'string', 'example' => 'prometheus-deliver-98e367d8fb8cc83b-0', 'title' => ''], + 'title' => '', + 'example' => '', ], ], - 'entityGroup' => [ - 'description' => 'Entity group', + 'title' => '', + 'example' => '', + ], + 'sinkList' => [ + 'description' => 'The list of delivery targets.', + 'type' => 'array', + 'items' => [ + 'description' => 'The delivery target configuration.', 'type' => 'object', 'properties' => [ - 'description' => [ - 'description' => 'Description.', - 'type' => 'string', - 'example' => 'xxxx', - ], - 'entityGroupId' => [ - 'description' => 'Entity group ID', - 'type' => 'string', - 'example' => 'eg-b79f65d11fb94e779867cf937c3a3002', - ], - 'entityGroupName' => [ - 'description' => 'Entity group name', + 'sinkType' => [ + 'description' => 'The delivery target type.', + 'enumValueTitles' => ['AcsKafka' => 'AcsKafka', 'Prometheus' => 'Prometheus', 'AcsMaxcompute' => 'AcsMaxcompute'], 'type' => 'string', - 'example' => 'test-eg', + 'example' => 'Prometheus', + 'title' => '', ], - 'entityRules' => [ - 'description' => 'Entity group', + 'sinkConfigs' => [ + 'description' => 'The detailed configuration of the delivery target. The meanings of key/value pairs vary depending on the sinkType. For more information, see CreateDeliveryTask.', 'type' => 'object', - 'properties' => [ - 'annotations' => [ - 'description' => 'Annotations', - 'type' => 'array', - 'items' => [ - 'description' => 'Annotation', - 'type' => 'object', - 'properties' => [ - 'op' => [ - 'description' => 'Operation to be performed.', - 'type' => 'string', - 'example' => 'add', - ], - 'tagKey' => [ - 'description' => 'Tag key.', - 'type' => 'string', - 'example' => 'key', - ], - 'tagValues' => [ - 'description' => 'Tag values', - 'type' => 'array', - 'items' => [ - 'description' => 'Tag value', - 'type' => 'string', - 'example' => 'value', - ], - ], - ], - ], - ], - 'entityTypes' => [ - 'description' => 'List of entity types', - 'type' => 'array', - 'items' => [ - 'description' => 'Entity type', - 'type' => 'string', - 'example' => 'ECS', - ], - ], - 'fieldRules' => [ - 'description' => 'Field rules', - 'type' => 'array', - 'items' => [ - 'description' => 'Field rule', - 'type' => 'object', - 'properties' => [ - 'fieldKey' => [ - 'description' => 'Unique identifier for the field.', - 'type' => 'string', - 'example' => 'test', - ], - 'fieldValues' => [ - 'description' => 'Field content, multiple values separated by English commas.', - 'type' => 'array', - 'items' => [ - 'description' => 'Field content, multiple values separated by English commas.', - 'type' => 'string', - 'example' => 'field1,fieled2', - ], - ], - 'op' => [ - 'description' => 'Operation to be performed.', - 'type' => 'string', - 'example' => 'add', - ], - ], - ], - ], - 'instanceIds' => [ - 'description' => 'Instance IDs.', - 'type' => 'array', - 'items' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'example' => '6fq8fvvcb,owqeq789r', - ], - ], - 'ipMatchRule' => [ - 'description' => 'IP match rule', - 'type' => 'object', - 'properties' => [ - 'ipCidr' => [ - 'description' => 'IP segment', - 'type' => 'string', - 'example' => '100.100.1.0/16', - ], - 'ipFieldKey' => [ - 'description' => 'Key of the IP field', - 'type' => 'string', - 'example' => 'xxxx', - ], - ], - ], - 'labels' => [ - 'description' => 'Labels', - 'type' => 'array', - 'items' => [ - 'description' => 'Label `value` value.', - 'type' => 'object', - 'properties' => [ - 'op' => [ - 'description' => 'Operation to be performed.', - 'type' => 'string', - 'example' => 'add', - ], - 'tagKey' => [ - 'description' => 'Tag key.', - 'type' => 'string', - 'example' => 'test', - ], - 'tagValues' => [ - 'description' => 'Tag values', - 'type' => 'array', - 'items' => [ - 'description' => 'Tag values', - 'type' => 'string', - 'example' => 'value1', - ], - ], - ], - ], - ], - 'regionIds' => [ - 'description' => 'List of region IDs.', - 'type' => 'array', - 'items' => [ - 'description' => 'Region ID', - 'type' => 'string', - 'example' => 'cn-beijing,cn-hangzhou', - ], - ], - 'resourceGroupId' => [ - 'description' => 'Resource group ID.', - 'type' => 'string', - 'example' => 'rg-5i6dbwxfxuqihk7k', - ], - 'tags' => [ - 'description' => 'Instance tag information.', - 'type' => 'array', - 'items' => [ - 'description' => 'Tag value', - 'type' => 'object', - 'properties' => [ - 'op' => [ - 'description' => 'Operation to be performed.', - 'type' => 'string', - 'example' => 'add', - ], - 'tagKey' => [ - 'description' => 'Tag key.', - 'type' => 'string', - 'example' => 'key', - ], - 'tagValues' => [ - 'description' => 'Tag value.', - 'type' => 'array', - 'items' => [ - 'description' => 'Tag value.', - 'type' => 'string', - 'example' => 'value1', - ], - ], - ], - ], - ], - ], - ], - 'query' => [ - 'description' => 'Search keywords, supporting document library name and description', - 'type' => 'string', - 'example' => '哈弗', - ], - 'regionId' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-heyuan', - ], - 'userId' => [ - 'description' => 'User ID', - 'type' => 'string', - 'example' => '1236812738', - ], - 'workspace' => [ - 'description' => 'Workspace.', - 'type' => 'string', - 'example' => 'test-api', - ], - ], - ], - 'managedInfo' => [ - 'description' => 'Policy network management information.', - 'type' => 'object', - 'properties' => [ - 'securityGroupId' => [ - 'description' => 'Security group ID', - 'type' => 'string', - 'example' => 'sg-xxxxx', - ], - 'vswitchId' => [ - 'description' => 'VSwitch ID.', - 'type' => 'string', - 'example' => 'vsw-xxxxxx', - ], - 'eniId' => [ - 'title' => '托管探针的eni网卡id。例如: eni-xxxx。', - 'description' => 'ENI card ID of the managed probe. For example: eni-xxxx.', - 'type' => 'string', - 'example' => 'eni-12345678', + 'additionalProperties' => ['description' => 'The configuration items supported by each sinkType.', 'type' => 'string', 'example' => 'Url: http://xxxx/api/v1/write', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'policyId' => [ - 'description' => 'Policy ID.', - 'type' => 'string', - 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e', - ], - 'policyName' => [ - 'description' => 'Rule name.', - 'type' => 'string', - 'example' => '6f5HSsg3AP', - ], - 'policyType' => [ - 'description' => 'Access center policy type', - 'type' => 'string', - 'example' => 'ECS', - ], - 'regionId' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-heyuan', - ], - 'resourceGroupId' => [ - 'description' => 'Resource group ID.', - 'type' => 'string', - 'example' => 'rg-xxxxx', - ], - 'userId' => [ - 'description' => 'User ID', - 'type' => 'string', - 'example' => '128470923', - ], - 'workspace' => [ - 'description' => 'Workspace.', - 'type' => 'string', - 'example' => 'test-api', - ], - 'feePackage' => [ - 'description' => 'Billing type.', - 'type' => 'string', - 'enumValueTitles' => [ - 'CS_Pro' => 'CS_Pro', - 'CS_Basic' => 'CS_Basic', - ], - 'example' => 'CS_Pro', - ], - 'subAddonRelease' => [ - 'description' => 'Number of sub-releases', + 'title' => '', + 'example' => '', + ], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-chengdu', 'title' => ''], + 'tags' => [ + 'description' => 'The resource group tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag value.', 'type' => 'object', 'properties' => [ - 'total' => [ - 'description' => 'Number of rules.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '278', - ], - 'ready' => [ - 'description' => 'Number of ready sub-releases', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], + 'key' => ['description' => 'The tag key of the resource group.', 'type' => 'string', 'example' => 'sourcetype', 'title' => ''], + 'value' => ['description' => 'The tag value of the resource group.', 'type' => 'string', 'example' => 'production', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'csUmodelStatus' => [ - 'description' => 'Container environment umodel installation status.', - 'type' => 'boolean', - 'example' => 'true', - ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'ID of the request', - 'type' => 'string', - 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5', - ], - 'totalCount' => [ - 'description' => 'Total number of entries', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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' => 'Query Access Center Policy List Information', - 'description' => 'Query integration list', - 'translator' => 'machine', - ], - 'ListAddonReleases' => [ - 'summary' => 'List of addon releases', - 'path' => '/integration-policies/{policyId}/addon-releases', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve data delivery task details', + 'description' => 'Deletes a specified site monitoring task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - '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' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'workspace-test-001'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '策略环境 ID。', - 'description' => 'Policy environment ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-xxxxxxxxxxxx', + 'type' => 'object', + 'properties' => [ + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'title' => '', 'example' => 'cn-heyuan'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'."\n"], + 'workspaceName' => ['description' => 'The name of the workspace.', 'type' => 'string', 'title' => '', 'example' => 'workspace-test-001'], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get EntityStore', + 'summary' => 'Retrieves the storage information of an 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 component name.', - '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' => [ + 'summary' => 'Queries the entity and relational data in a specified workspace to retrieve entity data for a specific time range.', + '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' => 'The content encoding type of the compression algorithm.', 'type' => 'string', 'required' => false, 'default' => 'gzip', 'title' => '', 'example' => 'gzip'], + ], + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'workspace-test-001'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '父级 AddonReleaseId。', - 'description' => 'Parent AddonReleaseId.', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'from' => ['description' => 'The start point in time for the query.'."\n" + ."\n" + .'This is a UNIX timestamp. It represents the number of seconds that have elapsed since 00:00:00 UTC on January 1, 1970.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '1721767203'], + 'query' => ['description' => 'The search statement.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '.entity with(domain=\'acs\', type=\'acs.k8s.node\') | limit 0, 10'], + 'to' => ['description' => 'The end point in time for the query.'."\n" + ."\n" + .'This is a UNIX timestamp. It represents the number of seconds that have elapsed since 00:00:00 UTC on January 1, 1970.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '1721767283'], + ], 'required' => false, - 'example' => 'policy-xxxxxxxxxxxxx', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ - 'releases' => [ - 'description' => 'Set of add-on component information.', + 'data' => [ + 'description' => 'The list of returned data.', 'type' => 'array', 'items' => [ - 'description' => 'Set of add-on component information.', - 'type' => 'object', - 'properties' => [ - 'addonName' => [ - 'title' => 'Addon 名称。', - 'description' => 'Addon name.', - 'type' => 'string', - 'example' => 'cs-gpu', - ], - 'alertRuleCount' => [ - 'title' => '告警规则数量。', - 'description' => 'Number of alert rules.', - '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' => 'Installation phase information.', - 'type' => 'array', - 'items' => [ - 'description' => 'Installation phase information.', - 'type' => 'object', - 'properties' => [ - 'firstTransitionTime' => [ - 'title' => '第一次转换时间。', - 'description' => 'First transition time.', - 'type' => 'string', - 'example' => '2024-11-04T16:10:22+08:00', - ], - 'lastTransitionTime' => [ - 'title' => '最后一次转换时间。', - 'description' => 'Last transition time.', - 'type' => 'string', - 'example' => '2024-11-04T16:10:22+08:00', - ], - 'message' => [ - 'title' => '详细信息。', - 'description' => 'Details.', - 'type' => 'string', - 'example' => 'The addon loaded successfully', - ], - 'status' => [ - 'title' => '阶段状态。', - 'description' => 'Phase status.', - 'type' => 'string', - 'example' => 'True', - ], - 'type' => [ - 'title' => '阶段类型。', - 'description' => 'Phase type.', - 'type' => 'string', - 'example' => 'Loaded', - ], - ], - ], - ], - 'config' => [ - 'title' => '组件配置信息。', - 'description' => 'Component configuration information.', - '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' => 'Access time.', - 'type' => 'string', - 'example' => '2024-11-04T16:10:12+08:00', - ], - 'dashboardCount' => [ - 'title' => '大盘数量。', - 'description' => 'Number of dashboards.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'environmentId' => [ - 'title' => '环境 ID。', - 'description' => 'Environment ID.', - 'type' => 'string', - 'example' => 'policy-xxxxxxxxxxxx', - ], - 'exporterCount' => [ - 'title' => '插件数量。', - 'description' => 'Number of plugins.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'haveConfig' => [ - 'title' => '是否有配置。', - 'description' => 'Whether there is a configuration.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'installUserId' => [ - 'title' => '接入用户 ID。', - 'description' => 'Access user ID.', - 'type' => 'string', - 'example' => '175xxxxxxxxx', - ], - 'language' => [ - 'title' => '语言。', - 'description' => 'Language.', - 'type' => 'string', - 'example' => 'zh', - ], - 'managed' => [ - 'title' => '是否为托管组件。', - 'description' => 'Whether it is a managed component.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'parentAddonReleaseId' => [ - 'title' => '父级 AddonReleaseId。', - 'description' => 'Parent AddonReleaseId.', - 'type' => 'string', - 'example' => 'policy-xxxxxxxxxxxxxx', - ], - 'policyId' => [ - 'title' => '策略 ID。', - 'description' => 'Policy ID.', - 'type' => 'string', - 'example' => 'policy-xxxxxxxxxxxxxx', - ], - 'regionId' => [ - 'title' => '区域 ID。', - 'description' => 'Region 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 name.', - 'type' => 'string', - 'example' => 'test-gpu-integration-name', - ], - 'scene' => [ - 'title' => '组件场景。', - 'description' => 'Component scenario.', - 'type' => 'string', - 'example' => 'container', - ], - 'status' => [ - 'title' => '状态。', - 'description' => 'Status.', - 'type' => 'string', - 'example' => 'running', - ], - 'updateTime' => [ - 'title' => '更新时间。', - 'description' => 'Update time.', - 'type' => 'string', - 'example' => '2024-11-04T16:10:23+08:00', - ], - 'userId' => [ - 'title' => '所属用户 ID。', - 'description' => 'Owner user ID.', - 'type' => 'string', - 'example' => '175xxxxxxxxxxxxx', - ], - 'version' => [ - 'title' => '组件版本。', - 'description' => 'Component version.', - 'type' => 'string', - 'example' => '0.0.2', - ], - 'envType' => [ - 'title' => '环境类型。', - 'description' => 'Environment type.', - 'type' => 'string', - 'example' => 'CS', - ], - 'workspace' => [ - 'title' => '工作空间。', - 'description' => 'Workspace.', - 'type' => 'string', - 'example' => 'default', - ], - 'subAddonRelease' => [ - 'title' => '子AddonRelease的统计信息', - 'description' => 'Sub-AddonRelease statistics.', + 'description' => 'The list of data that corresponds to the request header.', + 'type' => 'array', + 'items' => ['description' => 'The data that corresponds to the request header.', 'type' => 'string', 'title' => '', 'example' => 'data1'], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'header' => [ + 'description' => 'The list of request headers.', + 'type' => 'array', + 'items' => ['description' => 'The request header.', 'type' => 'string', 'title' => '', 'example' => 'headerKey'], + 'title' => '', + 'example' => '', + ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'responseStatus' => [ + 'description' => 'The result status.', + 'type' => 'object', + 'properties' => [ + 'result' => ['description' => 'The execution result.', 'type' => 'string', 'title' => '', 'example' => 'Success,PartialSuccess,Error'], + 'retryPolicy' => ['description' => 'The retry policy.', 'type' => 'string', 'title' => '', 'example' => 'None,Once,Continuous'], + 'level' => ['description' => 'The status level.', 'type' => 'string', 'title' => '', 'example' => 'Info,Warn,Error'], + 'statusItem' => [ + 'description' => 'A list of detailed status information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The detailed status information.', 'type' => 'object', 'properties' => [ - 'ready' => [ - 'title' => '已就绪的子Release数量', - 'description' => 'Number of ready sub-Releases.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'total' => [ - 'title' => '子Release数量', - 'description' => 'Number of sub-Releases.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], + 'code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'Success,ExecuteTimeout,UModelNotExist'], + 'level' => ['description' => 'The status level.', 'type' => 'string', 'title' => '', 'example' => 'Info,Warn,Error'], + 'message' => ['description' => 'The execution information.', 'type' => 'string', 'title' => '', 'example' => 'Query execution timeout after 30 seconds'], + 'suggestion' => ['description' => 'The suggestion provided when an execution fault occurs.', 'type' => 'string', 'title' => '', 'example' => 'Try to reduce the query scope or increase timeout limit, then retry'], ], + 'title' => '', + 'example' => '', ], - 'nextVersion' => [ - 'description' => 'Starting version number for the remaining list.', - 'type' => 'string', - 'example' => 'None', - ], - 'entityRules' => [ - 'title' => '实体详情。', - 'description' => 'Entity details.', - '$ref' => '#/components/schemas/EntityGroupBase', - ], - 'apiVersion' => [ - 'description' => 'API version.', - 'type' => 'string', - 'example' => '2023-03-30', - ], + 'title' => '', + 'example' => '', ], + 'executionStates' => ['description' => 'Information about the execution procedure.', 'type' => 'string', 'title' => '', 'example' => '{}'], ], - ], - 'requestId' => [ - 'title' => '请求 ID。', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5', - ], - 'total' => [ - 'title' => '组件数量。', - 'description' => 'Number of components.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + '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' => 'Query Entity and Relationship Data', + 'changeSet' => [ + ['createdAt' => '2025-09-10T09:49:36.000Z', 'description' => 'Response parameters changed'], + ], + '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 \\"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' => 'View Add-on Component List', - 'description' => 'Query the list of access configurations', - 'translator' => 'machine', ], 'GetIntegrationPolicy' => [ - 'summary' => 'Query the list of access center policies', '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' => 'Policy ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e', - ], + 'schema' => ['description' => 'Policy ID.', 'type' => 'string', 'required' => true, 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e', 'title' => ''], ], ], 'responses' => [ @@ -13676,54 +11670,28 @@ 'type' => 'object', 'properties' => [ 'policy' => [ - 'description' => 'Access policy.', + 'description' => 'Integration policy.', 'type' => 'object', 'properties' => [ 'bindResource' => [ 'description' => 'Bound resource information.', 'type' => 'object', 'properties' => [ - 'clusterId' => [ - 'description' => 'Cluster ID.'."\n", - 'type' => 'string', - 'example' => '00b1630f02814f95a9bce717d8d56bb2 ', - ], - 'clusterType' => [ - 'description' => 'Cluster type.', - 'type' => 'string', - 'example' => 'ManagedKubernetes', - ], - 'vpcCidr' => [ - 'description' => 'VPC CIDR.', - 'type' => 'string', - 'example' => '10.12.0.1/16', - ], - 'vpcId' => [ - 'description' => 'VPC ID.', - 'type' => 'string', - 'example' => 'vpc-2zegqpeyxplhtmdg70xnr', - ], + 'clusterId' => ['description' => 'Cluster ID.', 'type' => 'string', 'example' => '00b1630f02814f95a9bce717d8d56bb2 ', 'title' => ''], + 'clusterType' => ['description' => 'Cluster type.', 'type' => 'string', 'example' => 'ManagedKubernetes', 'title' => ''], + 'vpcCidr' => ['description' => 'VPC CIDR block.', 'type' => 'string', 'example' => '10.12.0.1/16', 'title' => ''], + 'vpcId' => ['description' => 'VPC ID.', 'type' => 'string', 'example' => 'vpc-2zegqpeyxplhtmdg70xnr', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'entityGroup' => [ 'description' => 'Entity group.', 'type' => 'object', 'properties' => [ - 'description' => [ - 'description' => 'Description.', - 'type' => 'string', - 'example' => 'xxxxxx', - ], - 'entityGroupId' => [ - 'description' => 'Entity group ID.', - 'type' => 'string', - 'example' => 'eg-b79f65d11fb94e779867cf937c3a3002', - ], - 'entityGroupName' => [ - 'description' => 'Entity group name.', - 'type' => 'string', - 'example' => 'prod-database', - ], + 'description' => ['description' => 'Description.', 'type' => 'string', 'example' => 'xxxxxx', 'title' => ''], + 'entityGroupId' => ['description' => 'Entity group ID.', 'type' => 'string', 'example' => 'eg-b79f65d11fb94e779867cf937c3a3002', 'title' => ''], + 'entityGroupName' => ['description' => 'Entity group name.', 'type' => 'string', 'example' => 'prod-database', 'title' => ''], 'entityRules' => [ 'description' => 'Entity rules.', 'type' => 'object', @@ -13732,1854 +11700,2512 @@ 'description' => 'Annotations.', 'type' => 'array', 'items' => [ - 'description' => 'Annotations.', + 'description' => 'Annotation.', 'type' => 'object', 'properties' => [ - 'op' => [ - 'description' => 'Operation to be performed.', - 'type' => 'string', - 'example' => 'add', - ], - 'tagKey' => [ - 'description' => 'Tag key.', - 'type' => 'string', - 'example' => 'use', - ], + 'op' => ['description' => 'The operation to perform.', 'type' => 'string', 'example' => 'add', 'title' => ''], + 'tagKey' => ['description' => 'Tag key.', 'type' => 'string', 'example' => 'use', 'title' => ''], 'tagValues' => [ 'description' => 'Tag values.', 'type' => 'array', - 'items' => [ - 'description' => 'Tag values.', - 'type' => 'string', - 'example' => 'db', - ], + 'items' => ['description' => 'Tag value.', 'type' => 'string', 'example' => 'db', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'entityTypes' => [ - 'description' => 'List of entity types.', + 'description' => 'Entity type list.', 'type' => 'array', - 'items' => [ - 'description' => 'Entity type.', - 'type' => 'string', - 'example' => 'CS', - ], + 'items' => ['description' => 'Entity type.', 'type' => 'string', 'example' => 'CS', 'title' => ''], + 'title' => '', + 'example' => '', ], 'fieldRules' => [ - 'description' => 'List of field rules.', + 'description' => 'Field rule list.', 'type' => 'array', 'items' => [ 'description' => 'Field rule.', 'type' => 'object', 'properties' => [ - 'fieldKey' => [ - 'description' => 'Unique identifier for the field.', - 'type' => 'string', - 'example' => 'test', - ], + 'fieldKey' => ['description' => 'Unique identifier of the field.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'fieldValues' => [ - 'description' => 'Field content.', + 'description' => 'Field values.', 'type' => 'array', - 'items' => [ - 'description' => 'Field content.', - 'type' => 'string', - 'example' => 'test-value', - ], - ], - 'op' => [ - 'description' => 'Operation to be performed.', - 'type' => 'string', - 'example' => 'add', + 'items' => ['description' => 'Field value.', 'type' => 'string', 'example' => 'test-value', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'op' => ['description' => 'The operation to perform.', 'type' => 'string', 'example' => 'add', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'instanceIds' => [ - 'description' => 'Instance ID.', + 'description' => 'Instance IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'example' => 'i-uf6bsi1aivfbn581buj6,i-uf6eu25p75drryo4712u', - ], + 'items' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'i-uf6bsi1aivfbn581buj6,i-uf6eu25p75drryo4712u', 'title' => ''], + 'title' => '', + 'example' => '', ], 'ipMatchRule' => [ - 'description' => 'IP matching rule.', + 'description' => 'IP match rule.', 'type' => 'object', 'properties' => [ - 'ipCidr' => [ - 'description' => 'IP segment.', - 'type' => 'string', - 'example' => '10.10.0.1/16', - ], - 'ipFieldKey' => [ - 'description' => 'Key for the IP field.', - 'type' => 'string', - 'example' => 'test-key', - ], + 'ipCidr' => ['description' => 'IP CIDR block.', 'type' => 'string', 'example' => '10.10.0.1/16', 'title' => ''], + 'ipFieldKey' => ['description' => 'Key of the IP field.', 'type' => 'string', 'example' => 'test-key', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'labels' => [ 'description' => 'Labels.', 'type' => 'array', 'items' => [ - 'description' => 'Label `key` value.', + 'description' => 'Label.', 'type' => 'object', 'properties' => [ - 'op' => [ - 'description' => 'The operation to be performed.', - 'type' => 'string', - 'example' => 'add', - ], - 'tagKey' => [ - 'description' => 'The tag key of the instance.', - 'type' => 'string', - 'example' => 'key1', - ], + 'op' => ['description' => 'The operation to perform.', 'type' => 'string', 'example' => 'add', 'title' => ''], + 'tagKey' => ['description' => 'Tag key of the instance.', 'type' => 'string', 'example' => 'key1', 'title' => ''], 'tagValues' => [ - 'description' => 'List of tag values.', + 'description' => 'Tag value list.', 'type' => 'array', - 'items' => [ - 'description' => 'Tag value.', - 'type' => 'string', - 'example' => 'value1', - ], + 'items' => ['description' => 'Tag value.', 'type' => 'string', 'example' => 'value1', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'regionIds' => [ - 'description' => 'List of region IDs.', + 'description' => 'Region ID list.', 'type' => 'array', - 'items' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - ], - 'resourceGroupId' => [ - 'description' => 'Resource group ID.', - 'type' => 'string', - 'example' => 'rg-aek3aqsuvlv3yyq', + 'items' => ['description' => 'Region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'resourceGroupId' => ['description' => 'Resource group ID.', 'type' => 'string', 'example' => 'rg-aek3aqsuvlv3yyq', 'title' => ''], 'tags' => [ - 'description' => 'Tag values.', + 'description' => 'Tags.', 'type' => 'array', 'items' => [ - 'description' => 'Resource tag value.', + 'description' => 'Resource tag.', 'type' => 'object', 'properties' => [ - 'op' => [ - 'description' => 'The operation to be performed.', - 'type' => 'string', - 'example' => 'add', - ], - 'tagKey' => [ - 'description' => 'The tag key of the instance.', - 'type' => 'string', - 'example' => 'key2', - ], + 'op' => ['description' => 'The operation to perform.', 'type' => 'string', 'example' => 'add', 'title' => ''], + 'tagKey' => ['description' => 'Tag key of the instance.', 'type' => 'string', 'example' => 'key2', 'title' => ''], 'tagValues' => [ - 'description' => 'List of tag values.', + 'description' => 'Tag value list.', 'type' => 'array', - 'items' => [ - 'description' => 'Tag value.', - 'type' => 'string', - 'example' => 'values', - ], + 'items' => ['description' => 'Tag value.', 'type' => 'string', 'example' => 'values', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'regionId' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-heyuan', - ], - 'userId' => [ - 'description' => 'User ID.', - 'type' => 'string', - 'example' => 'u123456', - ], - 'workspace' => [ - 'description' => 'Workspace.', - 'type' => 'string', - 'example' => 'test-api', - ], - 'query' => [ - 'description' => 'For querying', - 'type' => 'string', - 'example' => 'status: 200 AND totalTime > 0.5', - ], + 'regionId' => ['description' => 'Region ID.', 'type' => 'string', 'example' => 'cn-heyuan', 'title' => ''], + 'userId' => ['description' => 'User ID.', 'type' => 'string', 'example' => 'u123456', 'title' => ''], + 'workspace' => ['description' => 'Workspace.', 'type' => 'string', 'example' => 'test-api', 'title' => ''], + 'query' => ['description' => 'Used for query.', 'type' => 'string', 'example' => 'status: 200 AND totalTime > 0.5', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'managedInfo' => [ 'description' => 'Policy management information.', 'type' => 'object', 'properties' => [ - 'securityGroupId' => [ - 'description' => 'Security group ID.', - 'type' => 'string', - 'example' => 'sg-xxxxxx', - ], - 'vswitchId' => [ - 'description' => 'VSwitch ID.', - 'type' => 'string', - 'example' => 'vsw-xxxxxxxxx', - ], + 'securityGroupId' => ['description' => 'Security group ID.', 'type' => 'string', 'example' => 'sg-xxxxxx', 'title' => ''], + 'vswitchId' => ['description' => 'VSwitch ID.', 'type' => 'string', 'example' => 'vsw-xxxxxxxxx', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'policyId' => [ - 'description' => 'Policy ID.', - 'type' => 'string', - 'example' => 'policy-c9efed2b99c348d49e589c5f780fc074', - ], - 'policyName' => [ - 'description' => 'Rule name.', - 'type' => 'string', - 'example' => 'ControlPolicy4DetailVportInfo', - ], - 'policyType' => [ - 'description' => 'Access policy type.', - 'type' => 'string', - 'example' => 'CS', - ], - 'regionId' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-heyuan', - ], - 'resourceGroupId' => [ - 'description' => 'Resource group ID.', - 'type' => 'string', - 'example' => 'rg-xxxxx', - ], + 'policyId' => ['description' => 'Policy ID.', 'type' => 'string', 'example' => 'policy-c9efed2b99c348d49e589c5f780fc074', 'title' => ''], + 'policyName' => ['description' => 'Policy name.', 'type' => 'string', 'example' => 'ControlPolicy4DetailVportInfo', 'title' => ''], + 'policyType' => ['description' => 'Integration policy type.', 'type' => 'string', 'example' => 'CS', 'title' => ''], + 'regionId' => ['description' => 'Region ID.', 'type' => 'string', 'example' => 'cn-heyuan', 'title' => ''], + 'resourceGroupId' => ['description' => 'Resource group ID.', 'type' => 'string', 'example' => 'rg-xxxxx', 'title' => ''], 'tags' => [ - 'description' => 'Tag keys.', + 'description' => 'Tags.', 'type' => 'array', 'items' => [ - 'description' => 'Tags.', + 'description' => 'Tag.', 'type' => 'object', 'properties' => [ - 'key' => [ - 'description' => 'Tag key.', - 'type' => 'string', - 'example' => 'use', - ], - 'value' => [ - 'description' => 'Tag value.', - 'type' => 'string', - 'example' => 'db', - ], + 'key' => ['description' => 'Tag key.', 'type' => 'string', 'example' => 'use', 'title' => ''], + 'value' => ['description' => 'Tag value.', 'type' => 'string', 'example' => 'db', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'userId' => [ - 'description' => 'User ID.', - 'type' => 'string', - 'example' => 'u123456', - ], - 'workspace' => [ - 'description' => 'Workspace.', - 'type' => 'string', - 'example' => 'prometheus', - ], - 'csUmodelStatus' => [ - 'type' => 'boolean', - 'description' => 'Cs umodel status', - ], + 'userId' => ['description' => 'User ID.', 'type' => 'string', 'example' => 'u123456', 'title' => ''], + 'workspace' => ['description' => 'Workspace.', 'type' => 'string', 'example' => 'prometheus', 'title' => ''], + 'csUmodelStatus' => ['description' => 'UModel installation status in the container environment.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'ID of the request.', - 'type' => 'string', - 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query Integration Center Policy Details', + 'summary' => 'Query integration center policy information.', + 'changeSet' => [ + ['createdAt' => '2025-10-30T11:46:59.000Z', 'description' => 'Response parameters changed'], + ], + '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' => 'Query Access Center Policy Details', - 'translator' => 'machine', ], - 'GetAddonRelease' => [ - 'summary' => 'Check addon release (view connection status)', - 'path' => '/integration-policies/{policyId}/addon-releases/{releaseName}', - 'methods' => [ - 'get', + 'GetIntegrationVersionForCS' => [ + 'summary' => 'Queries the Integration Center version for a container cluster.', + 'path' => '/integration-version/cs', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'https', + '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' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'c502646fd0d1249baaf792b3a1b589e1b'], + ], + [ + 'name' => 'clusterType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the cluster. Valid values: acs.ack.cluster and acs.asi.cluster.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'acs.ack.cluster'], + ], ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'integrationVersion' => ['description' => 'The version of the Integration Center.', 'type' => 'string', 'title' => '', 'example' => 'V1'], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CD9BCF34-EA09-5643-BC11-AF41C8DFAE5A'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetIntegrationVersionForCS', + 'description' => 'This operation is not available in the API Explorer.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'cms:GetIntegrationVersionForCS', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"integrationVersion\\": \\"V1\\",\\n \\"requestId\\": \\"CD9BCF34-EA09-5643-BC11-AF41C8DFAE5A\\"\\n}","type":"json"}]', + ], + 'GetMemories' => [ + 'summary' => 'Retrieves all memories.', + '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' => [ + 'type' => 'object', + 'properties' => [ + 'userId' => ['description' => 'The User ID.', 'type' => 'string', 'required' => false, 'example' => 'test_user_001', 'title' => ''], + 'agentId' => ['description' => 'The application\'s agent ID.', 'type' => 'string', 'required' => false, 'example' => '952730652285943809', 'title' => ''], + 'appId' => ['description' => 'The Application ID.', 'type' => 'string', 'required' => false, 'example' => '150130323', 'title' => ''], + 'runId' => ['description' => 'The Run ID.', 'type' => 'string', 'required' => false, 'example' => 'jr-80ded1d6953c64ea', 'title' => ''], + 'filters' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'The key-value pairs that define the filter.', 'type' => 'any', 'title' => '', 'example' => '{"__strategy_type__":"Fact"}'], + 'title' => '', + 'description' => 'The filter criteria.', + 'required' => false, + 'example' => '{"__strategy_type__":"Fact"}', + ], + 'pageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', 'title' => ''], + 'page' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + 'description' => 'The request body.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'memoryStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The memory store name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-memory-store', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****', 'title' => ''], + 'results' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'actorId' => ['description' => 'The actor ID.', 'type' => 'string', 'example' => 'test_session_001', 'title' => ''], + 'agentId' => ['description' => 'The agent ID.', 'type' => 'string', 'example' => '980565235819266048', 'title' => ''], + 'createdAt' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '1747623093939', 'title' => ''], + 'hash' => ['description' => 'The memory hash.', 'type' => 'string', 'example' => '73ad89f2d56c2f8615e5dd0cef7b4c41c074277c91fa0e31fc5b41802c0481f2', 'title' => ''], + 'id' => ['description' => 'The memory ID.', 'type' => 'string', 'example' => '019ca1e5-7307-7d50-b943-5e628326a8ed', 'title' => ''], + 'memory' => ['description' => 'The memory content.', 'type' => 'string', 'example' => 'My name is Zhang San and I live in Hangzhou.', 'title' => ''], + 'metadata' => [ + 'description' => 'The metadata.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The custom metadata.', 'type' => 'any', 'title' => '', 'example' => '{"__strategy_type__":"Fact"}'], + 'example' => '{"__strategy_type__":"Fact"}', + 'title' => '', + ], + 'role' => ['description' => 'The role that sent the message.', 'type' => 'string', 'example' => 'user', 'title' => ''], + 'runId' => ['description' => 'The run ID.', 'type' => 'string', 'example' => 'jr-965a0b00cb42a43b', 'title' => ''], + 'score' => ['description' => 'The similarity score.', 'type' => 'number', 'format' => 'double', 'example' => '30.12', 'title' => ''], + 'updatedAt' => ['description' => 'The update time.', 'type' => 'string', 'example' => '1752825865045', 'title' => ''], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => 'test_session_001', 'title' => ''], + 'appId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'test_user_001', 'title' => ''], + ], + 'description' => 'A memory object.', + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of results.', + 'title' => '', + 'example' => '', + ], + 'relations' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'destination' => ['description' => 'The destination of the relation.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'relationship' => ['description' => 'The type of the relation.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'source' => ['description' => 'The source of the relation.', 'type' => 'string', 'example' => 'test_namespace/RegistryModule-test2153b9f3-0be6-455e-9efd-05fd31f62885/alicloud', 'title' => ''], + ], + 'description' => 'A relation object.', + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of relations.', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetMemories', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'produces' => [ - 'application/json', + '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' => 'The workspace name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'default-cms-1793369865235921-cn-shenzhen', 'title' => ''], + ], + [ + 'name' => 'memoryStoreName', 'in' => 'path', + 'schema' => ['description' => 'The memory store name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-memory-store', 'title' => ''], + ], + [ + 'name' => 'memoryId', + 'in' => 'path', + 'schema' => ['description' => 'The memory ID.', 'type' => 'string', 'required' => true, 'minLength' => 1, 'example' => '019ca1e5-7307-7d50-b943-5e628326a8ed', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'AddonRelease 的名称。', - 'description' => 'The name of the AddonRelease.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-gpu-integration-name', + 'type' => 'object', + 'properties' => [ + 'immutable' => ['description' => 'This property is mutable.', 'type' => 'string', 'title' => '', 'example' => 'test'], + 'owner' => ['description' => 'The owner of the memory.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'updatedAt' => ['description' => 'The time when the memory was last updated.', 'type' => 'string', 'example' => '1744428159434', 'title' => ''], + 'organization' => ['description' => 'The organization.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'memory' => ['description' => 'The memory content.', 'type' => 'string', 'example' => 'My name is Zhang San and I live in Hangzhou.', 'title' => ''], + 'metadata' => ['description' => 'The metadata.', 'type' => 'string', 'example' => '{"sessionId":"test_session_001"}', 'title' => ''], + 'id' => ['description' => 'The memory ID.', 'type' => 'string', 'example' => '019ca1e5-7307-7d50-b943-5e628326a8ed', 'title' => ''], + 'expirationDate' => ['description' => 'The expiration time.', 'type' => 'string', 'example' => '1751595283143', 'title' => ''], + 'createdAt' => ['description' => 'The time when the memory was created.', 'type' => 'string', 'example' => '1751595283143', 'title' => ''], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****', 'title' => ''], + 'userId' => ['type' => 'string', 'example' => 'test_user_001', 'description' => '', 'title' => ''], + 'agentId' => ['type' => 'string', 'example' => 'test_user_001', 'description' => '', 'title' => ''], + 'runId' => ['type' => 'string', 'example' => 'test_user_001', 'description' => '', 'title' => ''], + 'appId' => ['type' => 'string', 'example' => 'test_user_001', 'description' => '', 'title' => ''], + ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetMemory', + 'summary' => 'Retrieves a single memory.', + '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' => 'Retrieve memory history.', + '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' => 'Workspace name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'memoryStoreName', + 'in' => 'path', + 'schema' => ['description' => 'Memory store name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-memory-store', 'title' => ''], + ], + [ + 'name' => 'memoryId', 'in' => 'path', + 'schema' => ['description' => 'Memory ID.', 'type' => 'string', 'required' => true, 'minLength' => 1, 'example' => '019ca1e5-7307-7d50-b943-5e628326a8ed', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '环境 ID。', - 'description' => 'Environment ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-xxxxxxxxxxxx', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '3B311FD9-A60B-55E0-A896-A0C73*********', 'title' => ''], + 'results' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'Memory ID.', 'type' => 'string', 'example' => 'b25d6ad7-306f-4040-9890-4dddd2505a2e', 'title' => ''], + 'memoryId' => ['description' => 'Memory ID.', 'type' => 'string', 'example' => '019cacf6-7b39-7f61-8314-548f07ca449a', 'title' => ''], + 'input' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'role' => ['description' => 'Message sender role.', 'type' => 'string', 'example' => 'user', 'title' => ''], + 'content' => ['description' => 'Message content.', 'type' => 'string', 'example' => 'My name is Zhang San and I live in Hangzhou.', 'title' => ''], + ], + 'description' => 'Message.', + 'title' => '', + 'example' => '', + ], + 'description' => 'Original message.', + 'title' => '', + 'example' => '', + ], + 'newMemory' => ['description' => 'New memory.', 'type' => 'string', 'example' => 'I really like Python.', 'title' => ''], + 'userId' => ['description' => 'User ID.', 'type' => 'string', 'example' => 'test_session_001', 'title' => ''], + 'event' => ['description' => 'Event type.', 'type' => 'string', 'example' => 'ADD', 'title' => ''], + 'createdAt' => ['description' => 'Creation time.', 'type' => 'string', 'example' => '1764556182850', 'title' => ''], + 'updatedAt' => ['description' => 'Update time.', 'type' => 'string', 'example' => '1771036123785', 'title' => ''], + 'oldMemory' => ['description' => 'Old memory.', 'type' => 'string', 'example' => 'I really don\'t like Python at all.', 'title' => ''], + 'metadata' => ['description' => 'Metadata.', 'type' => 'object', 'example' => '{"sessionId":"test_session_001"}', 'title' => ''], + ], + 'description' => 'Return value.', + 'title' => '', + 'example' => '', + ], + 'description' => 'Return value.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'Response data.', + 'title' => '', + 'example' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetMemoryHistory', + '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' => 'Queries a memory store.', + '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' => 'The workspace name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'default-cms-1654218965343050-cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'memoryStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The memory store name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-memory-store', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'config' => [ - 'title' => '组件配置。', - 'description' => 'Component configuration.', - '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' => 'The description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'createTime' => ['description' => 'The creation time.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1764556182850', 'title' => ''], + 'updateTime' => ['description' => 'The update time.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1764556182850', 'title' => ''], + 'shortTermTtl' => ['description' => 'The retention period of short-term memory.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'memoryStoreName' => ['description' => 'The memory store name.', 'type' => 'string', 'example' => 'test-memory-store', 'title' => ''], + 'workspace' => ['description' => 'The workspace name.', 'type' => 'string', 'example' => 'default-cms-xxxxxx-cn-beijing', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8', 'title' => ''], + 'extractionStrategies' => [ + 'description' => 'The extraction strategies. Valid values: Episodic, Summary, and Fact.', + 'type' => 'array', + 'items' => ['description' => 'The extraction strategies. Valid values: Episodic, Summary, and Fact.', 'type' => 'string', 'example' => 'Fact', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'release' => [ - 'description' => 'Detailed information.', + 'customExtractionStrategies' => [ + 'description' => 'The custom extraction strategies.', + 'type' => 'array', + 'items' => ['description' => 'The custom extraction strategies.', '$ref' => '#/components/schemas/CustomExtractionStrategy', 'example' => '[{}]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'shortTermStorage' => [ + 'description' => 'The short-term memory storage.', 'type' => 'object', 'properties' => [ - 'addonName' => [ - 'title' => '组件 Addon 名称。', - 'description' => 'Addon component name.', - 'type' => 'string', - 'example' => 'cs-gpu', - ], - 'alertRuleCount' => [ - 'title' => '告警规则数量。', - 'description' => 'Number of alert rules.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', + 'project' => ['description' => 'The Simple Log Service project name.', 'type' => 'string', 'example' => 'wk_cms_data_warehouse', 'title' => ''], + 'logstore' => ['description' => 'The Simple Log Service Logstore name.', 'type' => 'string', 'example' => 'memory-store', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'sourceType' => ['title' => '', 'description' => 'The memory source.', 'type' => 'string', 'example' => 'Trace'], + 'traceSourceConfig' => [ + 'title' => '', + 'description' => 'The configuration used when sourceType is set to Trace.', + 'type' => 'object', + 'properties' => [ + 'workspace' => ['title' => '', 'description' => 'The workspace where the trace resides.', 'type' => 'string', 'example' => 'test-workspace'], + 'includeOutput' => ['title' => '', 'description' => 'Specifies whether to include LLM output in memory extraction.', 'type' => 'boolean', 'example' => ''], + 'query' => ['title' => '', 'description' => 'The Simple Log Service query statement used to filter traces.', 'type' => 'string', 'example' => '(serviceName : "langchain-rag" or serviceName : "agentscope-code-correction") and hostname = frontend-proxy-999c48c8d-hvk6c '], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query a memory store', + 'description' => 'Typically used together with the QueryMetricMeta operation for querying metrics and the QueryMetricList/QueryMetricLast operation for querying monitoring data.'."\n" + .'## Request type '."\n" + .'POST|GET.', + '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\\": false,\\n \\"query\\": \\"(serviceName : \\\\\\"langchain-rag\\\\\\" or serviceName : \\\\\\"agentscope-code-correction\\\\\\") and hostname = frontend-proxy-999c48c8d-hvk6c \\"\\n }\\n}","type":"json"}]', + ], + 'GetPipeline' => [ + 'summary' => 'Query pipeline', + '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' => 'The ID of the workspace.', 'type' => 'string', 'required' => false, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'pipelineName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the pipeline.', 'type' => 'string', 'required' => false, 'example' => 'pipeline-name-1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '3430AE20-AFFF-597C-B553-2DF04B2933AA'], + 'pipelineName' => ['description' => 'The pipeline name.', 'type' => 'string', 'example' => 'pipeline-name-1', 'title' => ''], + 'description' => ['description' => 'The description of the pipeline.', 'type' => 'string', 'example' => 'workspace test', 'title' => ''], + 'createTime' => ['description' => 'The creation time.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2025-03-11T08:21:58Z', 'title' => ''], + 'updateTime' => ['description' => 'The update time.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2026-02-06T14:09:11Z', 'title' => ''], + 'workspace' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'workspace-test', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'source' => [ + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'The type of the data source.', 'type' => 'string', 'example' => 'logstore', 'title' => ''], + 'logstore' => [ + 'type' => 'object', + 'properties' => [ + 'project' => ['description' => 'The name of the Log Service project.', 'type' => 'string', 'example' => 'test-project', 'title' => ''], + 'logstore' => ['description' => 'The name of the Log Service Logstore.', 'type' => 'string', 'example' => 'test-logstore', 'title' => ''], + 'query' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => 'The configuration of the Log Service Logstore.', + 'title' => '', + 'example' => '', ], - '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' => 'Installation phase information.', + ], + 'description' => 'The pipeline\'s data source.', + 'title' => '', + 'example' => '', + ], + 'pipeline' => [ + 'type' => 'object', + 'properties' => [ + 'nodes' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'firstTransitionTime' => [ - 'title' => '第一次转换时间。', - 'description' => 'First transition time.', - 'type' => 'string', - 'example' => '2024-11-04T16:10:22+08:00', - ], - 'lastTransitionTime' => [ - 'title' => '最后一次转换时间。', - 'description' => 'Last transition time.', - 'type' => 'string', - 'example' => '2024-11-04T16:10:22+08:00', - ], - 'message' => [ - 'title' => '详细信息。', - 'description' => 'Details.', - 'type' => 'string', - 'example' => 'The addon loaded successfully', - ], - 'status' => [ - 'title' => '阶段状态。', - 'description' => 'Phase status.', - 'type' => 'string', - 'example' => 'True', - ], - 'type' => [ - 'title' => '阶段类型。', - 'description' => 'Phase type.', - 'type' => 'string', - 'example' => 'Loaded', + 'id' => ['description' => 'The node ID.', 'type' => 'string', 'example' => 'node_1', 'title' => ''], + 'type' => ['description' => 'The node type.', 'type' => 'string', 'example' => 'dedup-fuzzy', 'title' => ''], + 'parameters' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'The node-specific parameters.', '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" + .' }', 'title' => ''], + 'description' => 'The parameters for the node.', + 'title' => '', + 'example' => '', ], ], + 'description' => 'A node in the pipeline.', + 'title' => '', + 'example' => '', ], + 'description' => 'The nodes in the pipeline.', + 'title' => '', + 'example' => '', ], - 'config' => [ - 'title' => '组件配置信息。', - 'description' => 'Component configuration information.', - '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' => 'Connection time.', - 'type' => 'string', - 'example' => '2024-11-04T16:10:12+08:00', - ], - 'dashboardCount' => [ - 'title' => '大盘数量。', - 'description' => 'Number of dashboards.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'environmentId' => [ - 'title' => '环境 ID。', - 'description' => 'Environment ID.', - 'type' => 'string', - 'example' => 'policy-xxxxxxxxxxx', - ], - 'exporterCount' => [ - 'title' => '插件数量。', - 'description' => 'Number of plugins.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'haveConfig' => [ - 'title' => '是否有配置。', - 'description' => 'Whether there is a configuration.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'installUserId' => [ - 'title' => '接入用户 ID。', - 'description' => 'User ID for connection.', - 'type' => 'string', - 'example' => '1707xxxxxxxxxxxx', - ], - 'language' => [ - 'title' => '语言。', - 'description' => 'Language.', - 'type' => 'string', - 'example' => 'zh', - ], - 'managed' => [ - 'title' => '是否为托管组件。', - 'description' => 'Whether it is a managed component.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'parentAddonReleaseId' => [ - 'title' => '父级 AddonReleaseId。', - 'description' => 'Parent AddonRelease ID.', - 'type' => 'string', - 'example' => 'policy-xxxxxxxxxxxxx', - ], - 'policyId' => [ - 'title' => '策略 ID。', - 'description' => 'Policy ID.', - 'type' => 'string', - 'example' => 'policy-xxxxxxxxxxxxx', - ], - 'regionId' => [ - 'title' => '区域 ID。', - 'description' => 'Region 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' => 'The name of the Release.', - 'type' => 'string', - 'example' => 'test-gpu-integration-name', - ], - 'scene' => [ - 'title' => '组件场景。', - 'description' => 'Component scenario.', - 'type' => 'string', - 'example' => 'container', - ], - 'status' => [ - 'title' => '组件状态。', - 'description' => 'Component status.', - 'type' => 'string', - 'example' => 'running', - ], - 'updateTime' => [ - 'title' => '更新时间。', - 'description' => 'Update time.', - 'type' => 'string', - 'example' => '2024-11-04T16:10:12+08:00', - ], - 'userId' => [ - 'title' => '所属用户 ID。', - 'description' => 'Owner user ID.', - 'type' => 'string', - 'example' => '1707xxxxxxxxxxxx', - ], - 'version' => [ - 'title' => '组件版本。', - 'description' => 'Component version.', - 'type' => 'string', - 'example' => '0.0.2', - ], - 'envType' => [ - 'title' => '环境类型。', - 'description' => 'Environment type.', - 'type' => 'string', - 'example' => 'CS', + ], + 'description' => 'The pipeline configuration.', + 'title' => '', + 'example' => '', + ], + 'sink' => [ + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'The sink type.', 'type' => 'string', 'example' => 'dataset', 'title' => ''], + 'dataset' => [ + 'type' => 'object', + 'properties' => [ + 'workspace' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'workspace-test', 'title' => ''], + 'dataset' => ['description' => 'The dataset name.', 'type' => 'string', 'example' => 'dataset_1', 'title' => ''], + ], + 'description' => 'The dataset configuration.', + 'title' => '', + 'example' => '', ], - 'workspace' => [ - 'title' => '工作空间。', - 'description' => 'Workspace.', - 'type' => 'string', - 'example' => 'default', + ], + 'description' => 'The pipeline\'s data sink.', + 'title' => '', + 'example' => '', + ], + 'executePolicy' => [ + 'type' => 'object', + 'properties' => [ + 'mode' => ['description' => 'The execution mode.', 'type' => 'string', 'example' => 'runOnce', 'title' => ''], + 'runOnce' => [ + 'type' => 'object', + 'properties' => [ + 'fromTime' => ['description' => 'The start time of the execution, as a Unix timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1772519013', 'title' => ''], + 'toTime' => ['description' => 'The end time of the execution, as a Unix timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1772519013', 'title' => ''], + ], + 'description' => 'The configuration for a one-time execution.', + 'title' => '', + 'example' => '', ], - 'entityRules' => [ - 'title' => '实体详情。', - 'description' => 'Entity details.', - '$ref' => '#/components/schemas/EntityGroupBase', + 'scheduled' => [ + 'type' => 'object', + 'properties' => [ + 'interval' => ['description' => 'The execution interval in seconds.', 'type' => 'string', 'example' => '86400', 'title' => ''], + 'fromTime' => ['description' => 'The start time of the execution, as a Unix timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1772519013', 'title' => ''], + ], + 'description' => 'The configuration for a scheduled execution.', + 'title' => '', + 'example' => '', ], ], - ], - 'requestId' => [ - 'title' => '请求 ID。', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8', + 'description' => 'The execution policy.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The returned data.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetPipeline', + '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' => 'View Add-on Component Information', - 'translator' => 'machine', - ], - 'DeleteAddonRelease' => [ - 'summary' => 'Delete addon release information', - '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' => 'Queries the details of a specified Managed Service for Prometheus instance.', + '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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'rw-abc123', 'title' => ''], + ], + [ + 'name' => 'resourceGroupId', 'in' => 'query', - 'schema' => [ - 'title' => 'AddonRelease 的名称。', - 'description' => 'The name of the AddonRelease.', - 'type' => 'string', - 'required' => false, - 'example' => 'test-gpu-integration-name', - ], + 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2bhocin5e2na', 'title' => ''], ], [ - 'name' => 'force', + 'name' => 'aliyunLang', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The language. Default value: zh. Valid values: zh, en.', 'type' => 'string', 'default' => 'zh', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '是否硬性删除，默认 false。', - 'description' => 'Whether to force deletion, default is false.', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '是', - 'false' => '否', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'prometheusInstance' => [ + 'description' => 'The details of the Prometheus instance.', + 'type' => 'object', + 'properties' => [ + 'accessType' => ['title' => '', 'description' => 'The access type. Valid values:'."\n" + .'- readWrite'."\n" + .'- readOnly'."\n" + .'- httpReadOnly', 'type' => 'string', 'example' => 'readOnly'], + 'archiveDuration' => ['title' => '', 'description' => 'The number of days that data is automatically archived after the storage period expires. A value of 0 indicates that data is not archived. A value of 3650 indicates that data is permanently retained.', 'type' => 'integer', 'format' => 'int32', 'example' => '90'], + 'authFreeReadPolicy' => ['title' => '', 'description' => 'The authentication-free read policy. IP CIDR blocks and VPC IDs are supported.', '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' => 'The authentication-free write policy. IP CIDR blocks and VPC IDs are supported.', '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' => '', 'description' => 'The authentication token.', 'type' => 'string', 'example' => 'eJwixxxxx'], + 'createTime' => ['title' => '', 'description' => 'The time when the instance was created. The time is in UTC+0 and in the yyyy-MM-ddTHH:mmZ format.', 'type' => 'string', 'example' => '2025-08-10T02:07:53Z'], + 'enableAuthFreeRead' => ['title' => '', 'description' => 'Indicates whether authentication-free read is enabled.', 'type' => 'boolean', 'example' => 'true'], + 'enableAuthFreeWrite' => ['title' => '', 'description' => 'Indicates whether authentication-free write is enabled.', 'type' => 'boolean', 'example' => 'true'], + 'enableAuthToken' => ['description' => 'Indicates whether the authentication token is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'extraInfo' => [ + 'title' => '', + 'description' => 'The extended information.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The additional extended information.', 'type' => 'string', 'example' => 'value', 'title' => ''], + 'example' => '', + ], + 'httpApiInterUrl' => ['description' => 'The HTTP public endpoint.', 'type' => 'string', 'example' => ' http://workspace-default-cms-xxxxxxx', 'title' => ''], + 'httpApiIntraUrl' => ['description' => 'The HTTP private endpoint.', 'type' => 'string', 'example' => ' http://workspace-default-cms-xxxxxxx', 'title' => ''], + 'httpApiInternalUrl' => ['description' => 'The HTTP internal endpoint.', 'type' => 'string', 'example' => ' http://workspace-default-cms-xxxxxxx', 'title' => ''], + 'instanceType' => ['title' => '', 'description' => 'The Prometheus instance type.', 'type' => 'string', 'example' => 'remote-write'], + 'paymentType' => ['title' => '', 'description' => 'The billing method. Valid values:'."\n" + .'- POSTPAY: pay-as-you-go based on the number of reported metrics.'."\n" + .'- POSTPAY_GB: pay-as-you-go based on the volume of written metrics.', 'type' => 'string', 'example' => 'POSTPAY'], + 'product' => ['title' => '', 'description' => 'The product to which the Prometheus instance belongs (arms or cms).', 'type' => 'string', 'example' => 'cms'], + 'prometheusInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'rw-524ada714221af267c73122af2e1', 'title' => ''], + 'prometheusInstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'test-prom-name', 'title' => ''], + 'pushGatewayInterUrl' => ['description' => 'The PushGateway public endpoint.', 'type' => 'string', 'example' => ' http://workspace-default-cms-xxxxxxx', 'title' => ''], + 'pushGatewayIntraUrl' => ['description' => 'The PushGateway private endpoint.', 'type' => 'string', 'example' => ' http://workspace-default-cms-xxxxxxx'."\n", 'title' => ''], + 'pushGatewayInternalUrl' => ['description' => 'The PushGateway internal endpoint.', 'type' => 'string', 'example' => ' http://workspace-default-cms-xxxxxxx', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-heyuan', 'title' => ''], + 'remoteReadInterUrl' => ['description' => 'The public read endpoint.', 'type' => 'string', 'example' => ' http://workspace-default-cms-xxxxxxx', 'title' => ''], + 'remoteReadIntraUrl' => ['description' => 'The private read endpoint.', 'type' => 'string', 'example' => 'https://workspace-default-cms-1xxxxxxxxxx', 'title' => ''], + 'remoteReadInternalUrl' => ['description' => 'The RemoteRead internal endpoint.', 'type' => 'string', 'example' => 'https://workspace-default-cms-1xxxxxxxxxx', 'title' => ''], + 'remoteWriteInterUrl' => ['description' => 'The public write endpoint.', 'type' => 'string', 'example' => 'https://workspace-default-cms-xxxxxxxxxx', 'title' => ''], + 'remoteWriteIntraUrl' => ['description' => 'The private write endpoint.', 'type' => 'string', 'example' => 'https://workspace-default-cms-xxxxxxxxxx', 'title' => ''], + 'remoteWriteInternalUrl' => ['description' => 'The RemoteWrite internal endpoint.', 'type' => 'string', 'example' => 'https://workspace-default-cms-xxxxxxxxxx', 'title' => ''], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-acfm3gn5i6bigbi', 'title' => ''], + 'resourceType' => ['title' => '', 'description' => 'Fixed value: PrometheusInstance.', 'type' => 'string', 'example' => 'Prometheus'], + 'status' => ['title' => '', 'description' => 'The instance status.', 'type' => 'string', 'example' => 'Running'], + 'storageDuration' => ['title' => '', 'description' => 'The storage duration, in days.', 'type' => 'integer', 'format' => 'int32', 'example' => '90'], + 'supportAuthTypes' => [ + 'title' => '', + 'description' => 'The supported authentication types.', + 'type' => 'array', + 'items' => [ + 'description' => 'The authentication type.', + 'enumValueTitles' => ['BasicAuth' => 'HTTP basic authentication.', 'AuthFree' => 'Authentication-free.', 'AuthToken' => 'Token-based authentication.'], + 'type' => 'string', + 'enum' => ['BasicAuth', 'AuthFree', 'AuthToken'], + 'example' => 'BasicAuth', + 'title' => '', + ], + 'example' => '', + ], + 'tags' => [ + 'description' => 'The list of tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'openStorage', 'title' => ''], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => '130303196111114281', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '170731234567', 'title' => ''], + 'version' => ['title' => '', 'description' => 'The version.', 'type' => 'string', 'example' => 'V1'], + 'workspace' => ['title' => '', 'description' => 'The workspace to which the Prometheus instance belongs.', 'type' => 'string', 'example' => 'ws1'], + 'folderUrl' => ['title' => '', 'description' => 'The dashboard directory URL.', 'type' => 'string', 'example' => 'https://gnew.console.aliyun.com/dashboards/f/c49a80d2a551d4a20a8c4b996b0be4e52/xxxxxxx'], + 'grafanaInstanceId' => ['title' => '', 'description' => 'The instance ID of the attached managed Grafana instance.', 'type' => 'string', 'example' => 'SHARED'], + 'grafanaInstanceName' => ['title' => '', 'description' => 'The name of the associated managed Grafana instance.', 'type' => 'string', 'example' => '共享版'], + 'paymentTypeUpdateTime' => ['title' => '', 'description' => 'The time when the billing method of the instance was last modified, in UTC format.', 'type' => 'string', 'example' => '2025-08-10T02:07:53Z'], + ], + 'title' => '', + 'example' => '', + ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], ], - 'example' => 'false', + 'example' => '', ], ], + ], + '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' => 'Get prometheus instance details', + 'description' => 'Retrieves the details of a Managed Service for Prometheus instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '40', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPrometheusInstance'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'policyId', - 'in' => 'path', - 'schema' => [ - 'title' => '环境 ID。', - 'description' => 'Environment 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 name. When AddonName is provided, it will ignore the ReleaseName parameter and batch uninstall all AddonReleases belonging to the same Addon.', - 'type' => 'string', - 'required' => false, - 'example' => 'cs-gpu', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values: zh and en. Default value: zh.', 'type' => 'string', 'required' => false, 'default' => 'zh', 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求 ID。', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '264C3E89-BE6E-5F82-A484-CE9C2196C7DC', + 'prometheusUserSetting' => [ + 'description' => 'The details of the user settings for Prometheus.', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => 'The value of the configuration item.', 'title' => '', 'example' => 'value1'], + 'title' => '', + 'example' => '', ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '058550FA-DDBE-519E-9C6D-93521B9A5E90'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetPrometheusUserSetting', + 'summary' => 'Retrieves the user settings for Prometheus.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-BE6E-5F82-A484-CE9C2196C7DC\\"\\n}","type":"json"}]', - 'title' => 'Uninstall Access Component', - 'translator' => 'machine', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusUserSetting\\": {\\n \\"key\\": \\"value1\\"\\n },\\n \\"requestId\\": \\"058550FA-DDBE-519E-9C6D-93521B9A5E90\\"\\n}","type":"json"}]', ], - 'CreateAddonRelease' => [ - 'summary' => 'Install the access component, representing a single access attempt', - 'path' => '/integration-policies/{policyId}/addon-releases', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetPrometheusView' => [ + 'summary' => 'Queries the details of a specified Prometheus view instance.', + '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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rw-xxxxxx', 'title' => ''], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2bhocin5e2na', 'title' => ''], + ], + [ + 'name' => 'aliyunLang', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The language. Default value: zh. Valid values: zh and en.', 'type' => 'string', 'default' => 'zh', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '请求体参数。', - 'description' => 'Request body parameters.', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'addonName' => [ - 'title' => '需要接入监控的组件 Addon 名称。', - 'description' => 'The Addon name of the component that needs to be monitored.', - 'type' => 'string', - 'required' => true, - 'example' => 'cs-gpu', - ], - 'aliyunLang' => [ - 'title' => '组件的语言类型。', - 'description' => 'The language type of the component.', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'en' => '英语', - 'zh' => '中文', - ], - 'example' => 'zh', - ], - 'dryRun' => [ - 'title' => '是否试运行，默认为 false。', - 'description' => 'Whether it is a dry run, default is false.', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '试运行', - 'false' => '不试运行', - ], - 'example' => 'false', - ], - 'envType' => [ - 'title' => '环境类型。如果 Policy 类型为 CS 和 ECS，对应使用，其他类型统一为 Cloud。', - 'description' => 'Environment type. If the Policy type is CS and ECS, use accordingly; otherwise, it is unified as Cloud.', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'CS' => '容器环境', - 'ECS' => 'ECS环境', - 'Cloud' => '云服务环境', + 'prometheusView' => [ + 'description' => 'The view instance.', + 'type' => 'object', + 'properties' => [ + 'authFreeReadPolicy' => ['title' => '', 'description' => 'The authentication-free read policy. IP CIDR blocks and VPC IDs are supported.', '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' => '', 'description' => 'The authentication token string.', 'type' => 'string', 'example' => 'eJxxxxxx'], + 'createTime' => ['title' => '', 'description' => 'The time when the instance was created. The time is in UTC+0 and in the yyyy-MM-ddTHH:mmZ format.', 'type' => 'string', 'example' => '2025-08-10T02:07:53Z'], + 'enableAuthFreeRead' => ['title' => '', 'description' => 'Indicates whether authentication-free read is enabled.', 'type' => 'boolean', 'example' => 'true'], + 'enableAuthToken' => ['title' => '', 'description' => 'Indicates whether the authentication token is enabled.', 'type' => 'boolean', 'example' => 'true'], + 'httpApiInterUrl' => ['description' => 'The public HTTP URL.', 'type' => 'string', 'example' => 'http://xxxxxxxx', 'title' => ''], + 'httpApiIntraUrl' => ['description' => 'The internal HTTP URL.', 'type' => 'string', 'example' => 'http://xxxxxxxx', 'title' => ''], + 'httpApiInternalUrl' => ['description' => 'The internal HTTP URL.', 'type' => 'string', 'example' => 'https://workspace-xxx.cn-hangzhou-internal.log.aliyuncs.com/prometheus/workspace-xxx/aliyun-prom-rw-xxx', 'title' => ''], + 'instanceType' => ['title' => '', 'description' => 'The instance type. The value is fixed as prom-view.', 'type' => 'string', 'example' => 'prom-view'], + 'paymentType' => ['title' => '', 'description' => 'The billing type. The value is currently fixed as FREE.', 'type' => 'string', 'example' => 'FREE'], + 'product' => ['title' => '', 'description' => 'The product to which the Prometheus instance belongs.', 'type' => 'string', 'example' => 'cms'], + 'prometheusInstances' => [ + 'description' => 'The list of Prometheus instances.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of Prometheus instances.', + 'type' => 'object', + 'properties' => [ + 'prometheusInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'rw-63549e054ff596a4149927961dff', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-north-2-gov-1', 'title' => ''], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '122xxxxx', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'prometheusViewId' => ['description' => 'The Prometheus view ID.', 'type' => 'string', 'example' => 'view-xxx', 'title' => ''], + 'prometheusViewName' => ['description' => 'The Prometheus view name.', 'type' => 'string', 'example' => 'view1', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], + 'remoteReadInterUrl' => ['description' => 'The public URL for remote read.', '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', 'title' => ''], + 'remoteReadIntraUrl' => ['description' => 'The internal URL for remote read.', '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', 'title' => ''], + 'remoteReadInternalUrl' => ['description' => 'The internal endpoint for remote read.', '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', 'title' => ''], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-acfm3gn5i6bigbi', 'title' => ''], + 'resourceType' => ['title' => '', 'description' => 'The resource type. The value is fixed as PrometheusView.', 'type' => 'string', 'example' => 'RegistryModule'], + 'status' => ['title' => '', 'description' => 'The status of the backend data storage.', 'type' => 'string', 'example' => 'Pending2Running'], + 'supportAuthTypes' => [ + 'description' => 'The supported authentication types.', + 'type' => 'array', + 'items' => ['description' => 'The supported authentication types.', 'type' => 'string', 'example' => 'BasicAuth', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'tags' => [ + 'description' => 'The tag keys of the instance.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The integration key of PagerDuty.', 'type' => 'string', 'example' => 'global_score_series', 'title' => ''], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => '371293199010092839', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '11222', 'title' => ''], + 'version' => ['title' => '', 'description' => 'The version.', 'type' => 'string', 'example' => 'V1'], + 'workspace' => ['title' => '', 'description' => 'The workspace to which the environment belongs.', 'type' => 'string', 'example' => 'cms-monitor-test-aysls-pub-cn-fuzhou-monitor'], + 'folderUrl' => ['title' => '', 'description' => 'The dashboard URL.', 'type' => 'string', 'example' => 'https://xxxx'], + 'grafanaInstanceId' => ['title' => '', 'description' => 'The instance ID of the attached managed Grafana instance.', 'type' => 'string', 'example' => 'g-xxx '], + 'grafanaInstanceName' => ['title' => '', 'description' => 'The name of the associated managed Grafana instance.', 'type' => 'string', 'example' => 'gxxx'], ], - 'example' => 'CS', - ], - 'parentAddonReleaseId' => [ - 'title' => '父级 AddonReleaseId。', - 'description' => 'Parent AddonReleaseId.', - 'type' => 'string', - 'required' => false, - 'example' => 'policy-xxxxxxxxxxx', - ], - 'releaseName' => [ - 'title' => '接入后的插件名称，如果不指定则生成默认规则名称。', - 'description' => 'The plugin name after access. If not specified, a default rule name will be generated.', - 'type' => 'string', - 'required' => false, - 'example' => 'test-gpu-integration-name', - ], - 'values' => [ - 'title' => '输入的元数据。', - 'description' => 'Input metadata.', - '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' => 'The version of the Addon component that needs to be monitored.', - 'type' => 'string', - 'required' => true, - 'example' => '0.0.2', - ], - 'workspace' => [ - 'title' => '安装组件资源的工作空间名称。'."\n", - 'description' => 'The workspace name for installing the component resources.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - 'entityRules' => [ - 'title' => '实体发现规则。', - 'description' => 'Field rules', - 'required' => false, - '$ref' => '#/components/schemas/EntityDiscoverRule', + 'title' => '', + 'example' => '', ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8'], ], - 'required' => false, + 'example' => '', ], ], + ], + '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' => 'Query the details of a specified prometheus view instance', + 'description' => 'Queries a specified Prometheus view instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPrometheusView'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'policyId', - 'in' => 'path', - 'schema' => [ - 'title' => '环境策略 ID。', - 'description' => 'Environment policy ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-yyyyyyyyyy', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetPrometheusView', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'PrometheusView', 'arn' => 'acs:cms:{#regionId}:{#accountId}:prometheusview/{#prometheusViewId}'], + ], ], ], ], + ], + 'GetService' => [ + 'summary' => 'Retrieves the details of an Application Monitoring service.', + 'path' => '/workspace/{workspace}/service/{serviceId}', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + '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' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'serviceId', + 'in' => 'path', + 'schema' => ['description' => 'The service ID.', 'type' => 'string', 'required' => true, 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '返回数据。', - 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ - 'release' => [ - 'title' => '接入组件信息。', - 'description' => 'Accessed component information.', + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '264C3E89-BE6E-5F82-A484-CE9C2196C7DC', 'title' => ''], + 'service' => [ + 'description' => 'The service object.', 'type' => 'object', 'properties' => [ - 'addonName' => [ - 'title' => '接入监控的组件 Addon 名称。', - 'description' => 'The Addon name of the component being monitored.', + 'serviceId' => ['description' => 'The service ID.', 'type' => 'string', 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb'."\n", 'title' => ''], + 'serviceName' => ['description' => 'The service name.', 'type' => 'string', 'example' => 'demo-app', 'title' => ''], + 'createTime' => ['description' => 'The time when the service was created.', 'type' => 'string', 'example' => '2025-05-13T03:32:55Z', 'title' => ''], + 'serviceType' => [ + 'description' => 'The service type.', + 'enumValueTitles' => ['TRACE' => 'TRACE', 'RUM' => 'RUM', 'XTRACE' => 'XTRACE'], 'type' => 'string', - 'example' => 'cs-gpu', - ], - 'alertRuleCount' => [ - 'title' => '告警组数量。', - 'description' => 'Number of alert groups.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', + 'example' => 'TRACE', + 'title' => '', ], - 'conditions' => [ - 'title' => '组件安装阶段信息。', - 'description' => 'Component installation phase information.', + 'serviceStatus' => ['description' => 'The service status. This parameter is valid only when serviceType is set to RUM.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'displayName' => ['description' => 'The display name. This parameter is valid only when serviceType is set to RUM.', 'type' => 'string', 'example' => 'demo应用', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-heyuan', 'title' => ''], + 'workspace' => ['description' => 'The workspace name.', 'type' => 'string', 'example' => 'default-cms-1106439496876715-cn-hangzhou', 'title' => ''], + 'pid' => ['description' => 'The ID of the ARMS application that is compatible with earlier versions.', 'type' => 'string', 'example' => 'by6rjzro2j@0fe8dfa799e5906', 'title' => ''], + 'description' => ['description' => 'The description. This parameter is valid only when serviceType is set to RUM.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'attributes' => ['description' => 'The extended information.', 'type' => 'string', 'example' => '{"language":"java"}', 'title' => ''], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-aekxxzuad5zzzz', 'title' => ''], + 'tags' => [ 'type' => 'array', 'items' => [ - 'description' => 'Operator, supporting exact match, prefix match, and regular expression three methods.', 'type' => 'object', 'properties' => [ - 'firstTransitionTime' => [ - 'title' => '第一次转换时间。', - 'description' => 'First transition time.', - 'type' => 'string', - 'example' => '2024-11-04T16:10:22+08:00', - ], - 'lastTransitionTime' => [ - 'title' => '最后一次转换时间。', - 'description' => 'Last transition time.', - 'type' => 'string', - 'example' => '2024-11-04T16:10:22+08:00', - ], - 'message' => [ - 'title' => '详细信息。', - 'description' => 'Detailed information.', - 'type' => 'string', - 'example' => 'The addon loaded successfully', - ], - 'status' => [ - 'title' => '阶段状态。', - 'description' => 'Phase status.', - 'type' => 'string', - 'example' => '{\'phase\': \'Created\', \'executionDetails\': [], \'invocations\': [], \'latestExecError\': {\'message\': \'\', \'code\': \'\', \'requestId\': \'\', \'extraInfo\': \'\', \'title\': \'\'}}', - ], - 'type' => [ - 'title' => '阶段类型。', - 'description' => 'Phase type.', - 'type' => 'string', - 'example' => 'Loaded', - ], + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'env', 'title' => ''], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'prod', 'title' => ''], ], + 'description' => 'The tag.', + 'title' => '', + 'example' => '', ], - ], - 'config' => [ - 'title' => '组件配置。', - 'description' => 'Component configuration.', - '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' => 'Connection time.', - 'type' => 'string', - 'example' => '2024-11-05T15:21:30+08:00', - ], - 'dashboardCount' => [ - 'title' => '大盘数量。', - 'description' => 'Number of dashboards.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'environmentId' => [ - 'title' => '环境 ID。', - 'description' => 'Environment ID.', - 'type' => 'string', - 'example' => 'policy-xxxxxxxxxxx', - ], - 'exporterCount' => [ - 'title' => '插件数量。', - 'description' => 'Number of plugins.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'haveConfig' => [ - 'title' => '是否有配置。', - 'description' => 'Whether it has configuration.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'installUserId' => [ - 'title' => '安装的用户 ID。', - 'description' => 'ID of the user who installed it.', - 'type' => 'string', - 'example' => '1654218965xxxxxx', - ], - 'language' => [ - 'title' => '语言。', - 'description' => 'Language.', - 'type' => 'string', - 'example' => 'zh', - ], - 'managed' => [ - 'title' => '是否为托管组件。', - 'description' => 'Whether it is a managed component.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'parentAddonReleaseId' => [ - 'title' => '父级 AddonReleaseId。', - 'description' => 'Parent AddonReleaseId.', - 'type' => 'string', - 'example' => 'policy-xxxxxxxxxxx', - ], - 'policyId' => [ - 'title' => '策略环境 ID。', - 'description' => 'Policy environment ID.', - 'type' => 'string', - 'example' => 'policy-xxxxxxxxxx', - ], - 'regionId' => [ - 'title' => '地域 ID。', - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'releaseId' => [ - 'title' => '安装后的 ReleaseID。', - 'description' => 'ReleaseID after installation.', - 'type' => 'string', - 'example' => '2e898e60-5e6a-46d1-a994-xxxxxxxxxx', - ], - 'releaseName' => [ - 'title' => 'Release 的名称。', - 'description' => 'Name of the Release.', - 'type' => 'string', - 'example' => 'test-gpu-integration-name', - ], - 'scene' => [ - 'title' => '组件场景。', - 'description' => 'Component scenario.', - 'type' => 'string', - 'example' => '1', - ], - 'status' => [ - 'title' => '组件状态。', - 'description' => 'Component status.', - 'type' => 'string', - 'example' => '200', - ], - 'updateTime' => [ - 'title' => '更新时间。', - 'description' => 'Update time.', - 'type' => 'string', - 'example' => '2024-09-13T02:21:02Z', - ], - 'userId' => [ - 'title' => '所属用户 ID。', - 'description' => 'ID of the owner user.', - 'type' => 'string', - 'example' => '165421896xxxxxx', - ], - 'version' => [ - 'title' => '组件版本。', - 'description' => 'Component version.', - 'type' => 'string', - 'example' => '1.0.0', - ], - 'envType' => [ - 'title' => '环境类型。', - 'description' => 'Environment type.', - 'type' => 'string', - 'example' => 'CS', - ], - 'workspace' => [ - 'title' => '工作空间。', - 'description' => 'Workspace.', - 'type' => 'string', - 'example' => 'default', - ], - 'entityRules' => [ - 'title' => '实体详情。', - 'description' => 'Entity details.', - '$ref' => '#/components/schemas/EntityGroupBase', + 'description' => 'The array of tags.', + 'title' => '', + 'example' => '', ], ], - ], - 'requestId' => [ - 'title' => '请求 ID。', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidService.NotFound', 'errorMessage' => 'The specified Service does not exist.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + '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' => 'Query Application Observability Service', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '40', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetService'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + '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 \\"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' => 'Install Access Component', - 'description' => 'Used to create a site monitoring task', - 'translator' => 'machine', ], 'GetServiceObservability' => [ - 'summary' => 'Get Application Observability Instance', '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 Workspace', - 'type' => 'string', - 'required' => true, - 'example' => 'my-test-ws', - ], + 'schema' => ['description' => 'The Cloud Monitor 2.0 workspace.', 'type' => 'string', 'required' => true, 'example' => 'my-test-ws', 'title' => ''], ], [ 'name' => 'type', 'in' => 'path', 'schema' => [ - 'description' => 'Application Observability Type', + 'description' => 'The application observability type.', + 'enumValueTitles' => ['rum' => 'Real User Monitoring (RUM).', 'apm' => 'Application Performance Monitoring (APM).'], 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'rum' => '用户体验监控', - 'apm' => '应用性能监控', - ], 'example' => 'apm', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '4852B9B5-345C-5CBC-A15F-786D83ECCBBA', - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4852B9B5-345C-5CBC-A15F-786D83ECCBBA'], 'type' => [ - 'description' => 'Application Observability Type', + 'description' => 'The type of application observability.', + 'enumValueTitles' => ['rum' => 'RUM', 'apm' => 'APM'], 'type' => 'string', - 'enumValueTitles' => [ - 'rum' => 'rum', - 'apm' => 'apm', - ], 'example' => 'apm', + 'title' => '', ], - 'regionId' => [ - 'description' => 'Region', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'workspace' => [ - 'description' => 'Workspace Name', - 'type' => 'string', - 'example' => 'default-cms-1654218***343050-cn-hangzhou', - ], + 'regionId' => ['description' => 'The region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'workspace' => ['description' => 'The workspace name.', 'type' => 'string', 'example' => 'default-cms-1654218***343050-cn-hangzhou', 'title' => ''], 'status' => [ - 'description' => 'Resource Initialization Status', + 'description' => 'The resource initialization status.', + 'enumValueTitles' => ['Running' => 'normal'], 'type' => 'string', - 'enumValueTitles' => [ - 'Running' => '正常', - ], 'example' => 'Running', + 'title' => '', ], 'entryPointInfo' => [ - 'description' => 'Endpoint and Authentication Information', + 'description' => 'The endpoint and authentication information.', 'type' => 'object', 'properties' => [ - 'authToken' => [ - 'description' => 'Authentication Token for Data Reporting', - 'type' => 'string', - 'example' => 'gaddp****@de20f2***1ce***', - ], - 'publicDomain' => [ - 'description' => 'Public Network Access Address', - 'type' => 'string', - 'example' => 'project-xtrace-xxxx-cn-hangzhou.cn-hangzhou.log.aliyuncs.com', - ], - 'privateDomain' => [ - 'description' => 'Private Network Access Address', - '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' => 'The authentication token for reporting data.', 'type' => 'string', 'example' => 'gaddp****@de20f2***1ce***', 'title' => ''], + 'publicDomain' => ['description' => 'The public endpoint.', 'type' => 'string', 'example' => 'project-xtrace-xxxx-cn-hangzhou.cn-hangzhou.log.aliyuncs.com', 'title' => ''], + 'privateDomain' => ['description' => 'The internal endpoint.', 'type' => 'string', 'example' => 'project-xtrace-xxxx-cn-hangzhou.cn-hangzhou-intranet.log.aliyuncs.com', 'title' => ''], + 'project' => ['description' => 'The Simple Log Service project.', 'type' => 'string', 'example' => 'proj-xtrace-xxxxx', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'feeType' => [ - 'description' => 'Billing Type', - 'type' => 'string', - 'example' => 'arms=serverless;xtrace=serverless', - ], + 'feeType' => ['description' => 'The billing type.', 'type' => 'string', 'example' => 'arms=serverless;xtrace=serverless', 'title' => ''], 'settings' => [ - 'description' => 'System Configuration', + 'description' => 'The system configuration.', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{"trace_aggregate":"enable"}', - 'description' => 'Configuration Key-Value Pairs', - ], + 'additionalProperties' => ['description' => 'The configuration key-value pairs.', 'type' => 'string', 'example' => '{"trace_aggregate":"enable"}', 'title' => ''], + 'title' => '', + 'example' => '', ], 'quotas' => [ - 'description' => 'Quota Configuration', + 'description' => 'The quota configuration.', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{"arms_agent_hour": "48"}', - 'description' => 'Quota Configuration Keys', - ], + 'additionalProperties' => ['description' => 'The quota configuration key-value pairs.', 'type' => 'string', 'example' => '{"arms_agent_hour": "48"}', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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' => 'Get Application Observability', + 'summary' => 'Retrieves an application observability instance.', 'extraInfo' => 'settIngs系统配置支持如下：'."\n" .'* trace_aggregate : enable / disable，用于开源探针接入场景控制是否关闭指标生成', - 'translator' => 'machine', - ], - 'DeleteService' => [ - 'summary' => 'Delete Service', - 'path' => '/workspace/{workspace}/service/{serviceId}', - 'methods' => [ - 'delete', + 'changeSet' => [ + ['createdAt' => '2025-07-23T04:58:08.000Z', 'description' => 'Response parameters changed'], ], - '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' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - 'title' => '工作空间', - ], + 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'title' => ''], ], [ 'name' => 'serviceId', 'in' => 'path', + 'schema' => ['description' => 'The service ID.', 'type' => 'string', 'required' => true, 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', 'title' => ''], + ], + [ + 'name' => 'recordType', + 'in' => 'query', 'schema' => [ - 'description' => 'Service ID', + 'title' => '', + 'description' => 'The type of the linked entry. Currently supported values:'."\n" + .'logCorrelation: indicates application log association.', 'type' => 'string', 'required' => true, - 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', - 'title' => '应用服务id', + 'enum' => ['logCorrelation'], + 'example' => 'logCorrelation', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '51B6A3E8-EA9E-5143-BE11-8E5F83474C95', - 'title' => '请求id', + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'record' => [ + 'description' => 'The record.', + 'type' => 'object', + 'properties' => [ + 'workspace' => ['title' => '', 'description' => 'The workspace.', 'type' => 'string', 'example' => 'default-cms-1610600919225911-cn-beijing'], + 'serviceId' => ['title' => '', 'description' => 'The unique identifier of the service.', 'type' => 'string', 'example' => 'ckj0xn6ma3@b96491402f8e1f15a8c79'], + 'recordType' => ['title' => '', 'description' => 'The type of the linked entry. Currently supported values:'."\n" + .'logCorrelation: indicates application log association.', 'type' => 'string', 'example' => 'logCorrelation'], + 'recordContent' => ['title' => '', 'description' => 'The entry content in JSON string format. The returned content varies depending on the recordType.', 'type' => 'string', 'example' => '{"project":"proj-xtrace-16c988dcfe21fcb73c5e6f234927d998-cn-hangzhou","storeName":"app-biz-log","regionId":"cn-hangzhou","bindType":"logstore","traceIdRelateField":""}'], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get a service-linked entry', + 'summary' => 'Queries a service-linked entry.', + 'description' => 'Retrieves a service-linked entry.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"51B6A3E8-EA9E-5143-BE11-8E5F83474C95\\"\\n}","type":"json"}]', - 'title' => 'Delete Application Observability Service', - 'translator' => 'machine', + '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' => 'Update Service', - 'path' => '/workspace/{workspace}/service/{serviceId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'GetUmodel' => [ + 'summary' => 'Retrieves the configuration of a Umodel.', + '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' => 'The workspace name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'workspace-test'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - 'title' => '工作空间', + 'type' => 'object', + 'properties' => [ + 'commonSchemaRef' => [ + 'description' => 'This parameter is reserved.', + 'type' => 'array', + 'items' => [ + 'description' => 'This parameter is reserved.', + 'type' => 'object', + 'properties' => [ + 'group' => ['description' => 'The public Umodel schema group.', 'type' => 'string', 'title' => '', 'example' => 'test-job-123123'], + 'version' => ['description' => 'The version.', 'type' => 'string', 'title' => '', 'example' => '5'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'description' => ['description' => 'The Umodel description.', 'type' => 'string', 'title' => '', 'example' => 'workspace test'], + 'regionId' => ['description' => 'The region of the resource.', 'type' => 'string', 'title' => '', 'example' => 'cn-heyuan'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '123-123123-sdf-435-3123'], + 'workspace' => ['description' => 'The workspace name.', 'type' => 'string', 'title' => '', 'example' => 'workspace-test'], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + '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' => 'Get Umodel', + 'description' => 'Retrieves the configuration of a Umodel.', + 'changeSet' => [ + ['createdAt' => '2025-08-12T02:41:41.000Z', 'description' => 'Response parameters changed'], + ], + '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'], + ], + ], + ], + ], + ], + 'GetUmodelCommonSchemaRef' => [ + 'summary' => 'Retrieves the referenced common Umodel schema.', + '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' => 'The workspace name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'workspace-test'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Service ID', - 'type' => 'string', - 'required' => true, - 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', - 'title' => '应用资源id', + 'type' => 'object', + 'properties' => [ + 'commonSchemaRef' => [ + 'description' => 'The referenced common Umodel Schema.', + 'type' => 'array', + 'items' => [ + 'description' => 'The referenced common Umodel Schema.', + 'type' => 'object', + 'properties' => [ + 'group' => ['description' => 'The common Umodel Schema group.', 'type' => 'string', 'title' => '', 'example' => 'apm-common'], + 'version' => ['description' => 'The version.', 'type' => 'string', 'title' => '', 'example' => '0.1.0'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"commonSchemaRef\\": [\\n {\\n \\"group\\": \\"apm-common\\",\\n \\"version\\": \\"0.1.0\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'GetUmodelCommonSchemaRef', + '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'], + ], ], ], + ], + ], + 'GetUmodelData' => [ + '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' => 'The workspace name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'workspace-test'], + ], + [ + 'name' => 'method', + 'in' => 'query', + 'schema' => ['description' => 'The method.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ListData'], + ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'Request body parameters.', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'displayName' => [ - 'description' => 'Display name, only valid when serviceType=RUM.', - 'type' => 'string', - 'required' => false, - 'example' => 'api-monitor-test', - 'title' => '别名', - ], - 'description' => [ - 'description' => 'Service description, only valid when serviceType=RUM.', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - 'title' => '应用描述信息。', - ], - 'attributes' => [ - 'description' => 'Extended attributes.', - 'type' => 'string', - 'required' => false, - 'example' => '{"language":"java"}', - 'title' => '特征信息，key:value格式', - ], - 'serviceStatus' => [ - 'description' => 'Service status, only valid when serviceType=RUM.', - 'type' => 'string', - 'required' => false, - 'example' => 'Stopped', - 'title' => '应用体验监控的服务状态，Running/Stopped/Created/Suspend', - ], + 'content' => ['description' => 'The query conditions.', 'type' => 'any', 'required' => false, 'title' => '', 'example' => '{'."\n" + .' "filter": {'."\n" + .' "domains": []'."\n" + .' },'."\n" + .' "offset": 0,'."\n" + .' "size": 100000'."\n" + .'}'], ], 'required' => false, - 'title' => '应用服务', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '123-0F43-23423-AC43-34234', - 'title' => '请求id', + 'nodes' => [ + 'description' => 'The list of nodes.', + 'type' => 'array', + 'items' => ['description' => 'A node.', 'type' => 'any', 'title' => '', 'example' => '{}'], + 'title' => '', + 'example' => '', ], - 'serviceId' => [ - 'description' => 'Service ID.', - 'type' => 'string', - 'example' => 'em87vd@c2e25bcfe0e21ce0***', - 'title' => '应用服务id', + 'links' => [ + 'description' => 'The list of links between nodes.', + 'type' => 'array', + 'items' => ['description' => 'A link between nodes.', 'type' => 'any', 'title' => '', 'example' => '{}'], + 'title' => '', + 'example' => '', + ], + 'totalNodesCount' => ['description' => 'The total number of nodes.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'totalLinksCount' => ['description' => 'The total number of links between nodes.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'errors' => [ + 'description' => 'The error messages.', + 'type' => 'array', + 'items' => [ + 'description' => 'The error message.', + 'type' => 'object', + 'properties' => [ + 'message' => ['description' => 'The detailed information.', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'type' => ['description' => 'The type of the error.', 'type' => 'string', 'title' => '', 'example' => 'external'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '123-123-234-345-123'], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"123-0F43-23423-AC43-34234\\",\\n \\"serviceId\\": \\"em87vd@c2e25bcfe0e21ce0***\\"\\n}","type":"json"}]', - 'title' => 'Update Application Observability Service', - 'translator' => 'machine', - ], - 'GetService' => [ - 'summary' => 'Query Service', - 'path' => '/workspace/{workspace}/service/{serviceId}', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get Umodel Data', + 'summary' => 'Retrieves graph data associated with a Umodel.', + 'description' => 'This operation retrieves the graph data associated with a 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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'workspace-test-001'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - 'title' => '工作空间', + 'title' => 'Schema of Response', + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'createTime' => ['description' => 'The time when the workspace was created.', 'type' => 'string', 'format' => 'iso8601_normal', 'title' => '', 'example' => '2025-03-11T08:21:58Z'], + 'description' => ['title' => '工作空间描述', 'description' => 'The description of the workspace.', 'type' => 'string', 'pattern' => '', 'default' => '', 'example' => 'workspace test'], + 'lastModifyTime' => ['description' => 'The time when the workspace was last modified.', 'type' => 'string', 'format' => 'iso8601_normal', 'title' => '', 'example' => '2025-03-11T08:21:58Z'], + 'regionId' => ['title' => '地域ID', 'description' => 'The region ID.', 'type' => 'string', 'pattern' => '', 'default' => '', 'example' => 'cn-heyuan'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'slsProject' => ['title' => '日志服务项目名称', 'description' => 'The name of the Simple Log Service project.', 'type' => 'string', 'pattern' => '', 'default' => '', 'example' => 'sls-project-test-001'], + 'workspaceName' => ['title' => '工作空间名称', 'description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'pattern' => '', 'default' => '', 'example' => 'workspace-test-001'], + 'displayName' => ['description' => 'The display name of the workspace.', 'type' => 'string', 'title' => '', 'example' => 'workspace-test'], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get Workspace', + 'summary' => 'Retrieves a workspace.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWorkspace'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'serviceId', - 'in' => 'path', - 'schema' => [ - 'description' => 'Service ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', - 'title' => '应用服务id', + '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' => 'The policy environment ID.', 'type' => 'string', 'required' => true, 'example' => 'policy-xxxxxxxxxxxx'], + ], + [ + 'name' => 'addonName', + 'in' => 'query', + 'schema' => ['title' => '组件 Addon 名称。', 'description' => 'The name of the add-on.', 'type' => 'string', 'required' => false, 'example' => 'cs-gpu'], + ], + [ + 'name' => 'parentAddonReleaseId', + 'in' => 'query', + 'schema' => ['title' => '父级 AddonReleaseId。', 'description' => 'The parent AddonRelease ID.', 'type' => 'string', 'required' => false, 'example' => 'policy-xxxxxxxxxxxxx'], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '264C3E89-BE6E-5F82-A484-CE9C2196C7DC', - 'title' => '请求id', - ], - 'service' => [ - 'description' => 'Service object.', - 'type' => 'object', - 'properties' => [ - 'serviceId' => [ - 'description' => 'Service ID.', - 'type' => 'string', - 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb'."\n", - 'title' => '应用服务id', - ], - 'serviceName' => [ - 'description' => 'Service name', - 'type' => 'string', - 'example' => 'demo-app', - 'title' => '应用资源名称', - ], - 'createTime' => [ - 'description' => 'Creation time', - 'type' => 'string', - 'example' => '2025-05-13T03:32:55Z', - 'title' => '创建时间', - ], - 'serviceType' => [ - 'description' => 'Service type.', - 'type' => 'string', - 'enumValueTitles' => [ - 'TRACE' => 'TRACE', - 'RUM' => 'RUM', - 'XTRACE' => 'XTRACE', + 'releases' => [ + 'description' => 'The list of add-on releases.', + 'type' => 'array', + 'items' => [ + 'description' => 'An add-on release.', + 'type' => 'object', + 'properties' => [ + 'addonName' => ['title' => 'Addon 名称。', 'description' => 'The name of the add-on.', 'type' => 'string', 'example' => 'cs-gpu'], + 'alertRuleCount' => ['title' => '告警规则数量。', 'description' => 'The number of alert rules.', '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' => 'The conditions of the release.', + 'type' => 'array', + 'items' => [ + 'description' => 'A condition of the release.', + 'type' => 'object', + 'properties' => [ + 'firstTransitionTime' => ['title' => '第一次转换时间。', 'description' => 'The timestamp of the first status transition.', 'type' => 'string', 'example' => '2024-11-04T16:10:22+08:00'], + 'lastTransitionTime' => ['title' => '最后一次转换时间。', 'description' => 'The timestamp of the last status transition.', 'type' => 'string', 'example' => '2024-11-04T16:10:22+08:00'], + 'message' => ['title' => '详细信息。', 'description' => 'A detailed message about the status.', 'type' => 'string', 'example' => 'The addon loaded successfully'], + 'status' => ['title' => '阶段状态。', 'description' => 'The status of the condition.', 'type' => 'string', 'example' => 'True'], + 'type' => ['title' => '阶段类型。', 'description' => 'The type of the condition.', 'type' => 'string', 'example' => 'Loaded'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], - 'example' => 'TRACE', - 'title' => '类型：TRACE（应用监控）/ RUM（用户体验监控）/ XTRACE（OT版）', - ], - 'serviceStatus' => [ - 'description' => 'Service status, only valid when serviceType=RUM.', - 'type' => 'string', - 'example' => 'Running', - 'title' => '应用体验监控的服务状态，Running/Stopped/Created/Suspend', - ], - 'displayName' => [ - 'description' => 'Display name, only valid when serviceType=RUM.', - 'type' => 'string', - 'example' => 'demo应用', - 'title' => '别名', - ], - 'regionId' => [ - 'description' => 'Region ID', - 'type' => 'string', - 'example' => 'cn-heyuan', - 'title' => '地域 ID。', - ], - 'workspace' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'example' => 'default-cms-1106439496876715-cn-hangzhou', - 'title' => '工作空间', - ], - 'pid' => [ - 'description' => 'Legacy ARMS application ID', - 'type' => 'string', - 'example' => 'by6rjzro2j@0fe8dfa799e5906', - 'title' => '对应ARMS应用pid', - ], - 'description' => [ - 'description' => 'Description, only valid when serviceType=RUM.', - 'type' => 'string', - 'example' => 'test', - 'title' => '应用描述信息。', - ], - 'attributes' => [ - 'description' => 'Extended information.', - 'type' => 'string', - 'example' => '{"language":"java"}', - 'title' => '特征信息，key:value格式', - ], - 'resourceGroupId' => [ - 'title' => '资源组id', - 'type' => 'string', - 'example' => 'rg-aekxxzuad5zzzz', - ], - 'tags' => [ - 'title' => '标签数组', - 'type' => 'array', - 'items' => [ - 'title' => '标签', + 'config' => ['title' => '组件配置信息。', 'description' => 'The configuration of the add-on.', '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' => 'The installation time of the add-on.', 'type' => 'string', 'example' => '2024-11-04T16:10:12+08:00'], + 'dashboardCount' => ['title' => '大盘数量。', 'description' => 'The number of dashboards.', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'environmentId' => ['title' => '环境 ID。', 'description' => 'The environment ID.', 'type' => 'string', 'example' => 'policy-xxxxxxxxxxxx'], + 'exporterCount' => ['title' => '插件数量。', 'description' => 'The number of exporters.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'haveConfig' => ['title' => '是否有配置。', 'description' => 'Indicates whether a configuration exists.', 'type' => 'boolean', 'example' => 'true'], + 'installUserId' => ['title' => '接入用户 ID。', 'description' => 'The ID of the user who installed the add-on.', 'type' => 'string', 'example' => '175xxxxxxxxx'], + 'language' => ['title' => '语言。', 'description' => 'The language.', 'type' => 'string', 'example' => 'zh'], + 'managed' => ['title' => '是否为托管组件。', 'description' => 'Indicates whether the add-on is managed.', 'type' => 'boolean', 'example' => 'true'], + 'parentAddonReleaseId' => ['title' => '父级 AddonReleaseId。', 'description' => 'The ID of the parent release.', 'type' => 'string', 'example' => 'policy-xxxxxxxxxxxxxx'], + 'policyId' => ['title' => '策略 ID。', 'description' => 'The policy ID.', 'type' => 'string', 'example' => 'policy-xxxxxxxxxxxxxx'], + 'regionId' => ['title' => '区域 ID。', 'description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'releaseId' => ['title' => 'Release ID。', 'description' => 'The release ID.', 'type' => 'string', 'example' => '7339d808-66f9-4d40-83fa-xxxxxxxxxxx'], + 'releaseName' => ['title' => 'Release 名称。', 'description' => 'The release name.', 'type' => 'string', 'example' => 'test-gpu-integration-name'], + 'scene' => ['title' => '组件场景。', 'description' => 'The usage scenario of the add-on.', 'type' => 'string', 'example' => 'container'], + 'status' => ['title' => '状态。', 'description' => 'The status of the release.', 'type' => 'string', 'example' => 'running'], + 'updateTime' => ['title' => '更新时间。', 'description' => 'The last update time.', 'type' => 'string', 'example' => '2024-11-04T16:10:23+08:00'], + 'userId' => ['title' => '所属用户 ID。', 'description' => 'The ID of the owner.', 'type' => 'string', 'example' => '175xxxxxxxxxxxxx'], + 'version' => ['title' => '组件版本。', 'description' => 'The version of the add-on.', 'type' => 'string', 'example' => '0.0.2'], + 'envType' => ['title' => '环境类型。', 'description' => 'The environment type.', 'type' => 'string', 'example' => 'CS'], + 'workspace' => ['title' => '工作空间。', 'description' => 'The name of the workspace.', 'type' => 'string', 'example' => 'default'], + 'subAddonRelease' => [ + 'title' => '子AddonRelease的统计信息', + 'description' => 'Statistics about sub-releases.', 'type' => 'object', 'properties' => [ - 'key' => [ - 'title' => '标签key', - 'type' => 'string', - 'example' => 'env', - ], - 'value' => [ - 'title' => '标签value', - 'type' => 'string', - 'example' => 'prod', - ], + 'ready' => ['title' => '已就绪的子Release数量', 'description' => 'The number of ready sub-releases.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'total' => ['title' => '子Release数量', 'description' => 'The total number of sub-releases.', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], ], + 'example' => '', ], + 'nextVersion' => ['description' => 'The next available version of the add-on.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'entityRules' => ['title' => '实体详情。', 'description' => 'Details of the entity rules.', '$ref' => '#/components/schemas/EntityGroupBase', 'example' => ''], + 'apiVersion' => ['description' => 'The API version.', 'type' => 'string', 'example' => '2023-03-30', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'title' => '应用服务', + 'title' => '', + 'example' => '', ], + 'requestId' => ['title' => '请求 ID。', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5'], + 'total' => ['title' => '组件数量。', 'description' => 'The total number of add-on releases that match the query.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'nextToken' => ['description' => 'A pagination token to retrieve the next page of results. If this field is empty, no more results are available.', 'type' => 'string', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidService.NotFound', - 'errorMessage' => 'The specified Service does not exist.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'View Add-on Component List', + 'summary' => 'Lists the releases for an add-on.', + 'description' => 'This operation retrieves a list of integration configurations.', + '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' => 'Query Application Observability Service', - 'translator' => 'machine', + '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' => 'Create Service', - 'path' => '/workspace/{workspace}/service', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListAddons' => [ + 'summary' => 'Lists the products in the new Integration Center by group.', + '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' => ['description' => 'The language. Valid values: zh and en. The default value is zh.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'zh'], + ], + [ + 'name' => 'category', + 'in' => 'query', + 'schema' => ['description' => 'Tag filtering.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'database'], + ], + [ + 'name' => 'search', + 'in' => 'query', + 'schema' => ['description' => 'The search keyword. You can search for add-ons by name, description, or keyword.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '105095'], + ], + [ + 'name' => 'regexp', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to use regular expressions for the search. The default value is false.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Request body.', 'type' => 'object', 'properties' => [ - 'serviceName' => [ - 'description' => 'Service name', - 'type' => 'string', - 'required' => true, - 'example' => 'mag_test', - 'title' => '应用资源名称', - ], - 'serviceType' => [ - 'description' => 'Service type', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'TRACE' => '应用性能监控', - 'RUM' => '用户体验监控', - 'XTRACE' => 'OpenTelemtry链路追踪', - ], - 'example' => 'TRACE', - 'title' => '类型：TRACE（应用监控）/ RUM（用户体验监控）/ XTRACE（OT版）', - ], - 'displayName' => [ - 'description' => 'Display name, only valid when `serviceType=RUM`.', - 'type' => 'string', - 'required' => false, - 'example' => 'mag测试应用', - 'title' => '别名', - ], - 'description' => [ - 'description' => 'Service description, only valid when `serviceType=RUM`.', - 'type' => 'string', - 'required' => false, - 'example' => 'mag测试应用', - 'title' => '应用描述信息。', - ], - 'attributes' => [ - 'description' => 'Extended attributes.', - 'type' => 'string', - 'required' => false, - 'example' => '{"language":"java"}', - 'title' => '特征信息，key:value格式', - ], - 'serviceStatus' => [ - 'description' => 'Service status, not required for service creation.', - 'type' => 'string', - 'required' => false, - 'example' => 'Created', - 'title' => '应用体验监控的服务状态，Running/Stopped/Created/Suspend', - ], - 'pid' => [ - 'description' => 'Application ID, generally not required to be specified.', - 'type' => 'string', - 'required' => false, - 'example' => 'bx3udsi5ie@ed2ba6beebdb6de', - 'title' => '对应ARMS应用pid', - ], - 'resourceGroupId' => [ - 'title' => '资源组id', - 'type' => 'string', - 'example' => 'rg-xxekxxzuad5zzzz', - ], - 'tags' => [ - 'title' => '标签数组', + 'addons' => [ 'type' => 'array', 'items' => [ - 'title' => '标签', 'type' => 'object', 'properties' => [ - 'key' => [ - 'title' => '标签key', - 'type' => 'string', - 'example' => 'env', + 'alias' => ['description' => 'The alias of the add-on.', 'type' => 'string', 'example' => 'resume_vector_alias', 'title' => ''], + 'categories' => [ + 'type' => 'array', + 'items' => ['description' => 'Tag.', 'type' => 'string', 'example' => 'middleware', 'title' => ''], + 'description' => 'A list of tags for the add-on.', + 'title' => '', + 'example' => '', ], - 'value' => [ - 'title' => '标签value', - 'type' => 'string', - 'example' => 'prod', + 'dashboards' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'Dashboard description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'name' => ['description' => 'Dashboard name.', 'type' => 'string', 'example' => 'rum_view_link_rum_api', 'title' => ''], + 'url' => ['description' => 'The URL of the dashboard\'s preview image.', 'type' => 'string', 'example' => 'http://xxxxxxx', 'title' => ''], + ], + 'description' => 'Dashboard information.', + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of dashboards.', + 'title' => '', + 'example' => '', + ], + 'description' => ['description' => 'Description', 'type' => 'string', 'example' => 'workspace api monitor test', 'title' => ''], + 'environments' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'dependencies' => [ + 'type' => 'object', + 'properties' => [ + 'clusterTypes' => [ + 'type' => 'array', + 'items' => ['description' => 'Cluster type.', 'type' => 'string', 'example' => 'ManagedKubernetes/Default', 'title' => ''], + 'description' => 'Supported cluster types.', + 'title' => '', + 'example' => '', + ], + 'features' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'Indicates whether the feature is supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'description' => 'The probes on which the integration depends.', + 'title' => '', + 'example' => '', + ], + 'services' => [ + 'type' => 'array', + 'items' => ['description' => 'Service name.', 'type' => 'string', 'example' => 'Prometheus', 'title' => ''], + 'description' => 'A list of dependent services.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'A list of dependencies for the add-on.', + 'title' => '', + 'example' => '', + ], + 'description' => ['description' => 'The description of the integration policy type.', 'type' => 'string', 'example' => 'o11y-demo-cn-heyuan', 'title' => ''], + 'enable' => ['description' => 'Indicates whether the add-on is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'label' => ['description' => 'The label of the integration policy type.', 'type' => 'string', 'example' => '容器环境', 'title' => ''], + 'name' => ['description' => 'The name of the integration policy type.', 'type' => 'string', 'example' => 'CS', 'title' => ''], + 'policies' => [ + 'type' => 'object', + 'properties' => [ + 'alertDefaultStatus' => ['description' => 'The default status of the alert rule policy.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], + 'defaultInstall' => ['description' => 'Indicates whether the add-on is installed by default.', 'type' => 'boolean', 'example' => 'true'."\n", 'title' => ''], + 'enableServiceAccount' => ['description' => 'Indicates whether to assign a Service Account to communicate with the Console API.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'metricCheckRule' => [ + 'type' => 'object', + 'properties' => [ + 'promQL' => [ + 'type' => 'array', + 'items' => ['description' => 'A PromQL statement.', 'type' => 'string', 'example' => 'scraper_up{scraper=\\"ecs\\"}==1', 'title' => ''], + 'description' => 'A list of Prometheus Query Language (PromQL) statements.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'Metric check rule.', + 'title' => '', + 'example' => '', + ], + 'needRestartAfterIntegration' => ['description' => 'Indicates whether to guide the user to restart pods after the add-on is installed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'protocols' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'Protocol description.', 'type' => 'string', 'example' => 'Support OpenTelemetry Protocal', 'title' => ''], + 'icon' => ['description' => 'Icon URL.', 'type' => 'string', 'example' => 'http://xxxxxxx', 'title' => ''], + 'label' => ['description' => 'Protocol display name.', 'type' => 'string', 'example' => 'OpenTelemetry', 'title' => ''], + 'name' => ['description' => 'Protocol name.', 'type' => 'string', 'example' => 'openTelemetry', 'title' => ''], + ], + 'description' => 'The details of a supported protocol type.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The supported protocol types.', + 'title' => '', + 'example' => '', + ], + 'targetAddonName' => ['description' => 'The name of the target add-on.', 'type' => 'string', 'example' => 'cloud-acs-ecs', 'title' => ''], + ], + 'description' => 'Integration policy configuration.', + 'title' => '', + 'example' => '', + ], + 'policyType' => ['description' => 'Integration Center policy type.', 'type' => 'string', 'example' => 'CS', 'title' => ''], + 'commonSchemaRefs' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'group' => ['description' => 'The group name of the Common Schema.', 'type' => 'string', 'example' => 'acs-ecs', 'title' => ''], + 'version' => ['description' => 'The version of the Common Schema.', 'type' => 'string', 'example' => '0.1.4', 'title' => ''], + ], + 'description' => 'The information about an associated Common Schema.', + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of associated Common Schemas.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'Integration policy type information.', + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of supported integration policy types.', + 'title' => '', + 'example' => '', + ], + 'icon' => ['description' => 'The URL of the icon.', 'type' => 'string', 'example' => 'http://xxxxxxx', 'title' => ''], + 'keywords' => [ + 'type' => 'array', + 'items' => ['description' => 'Keyword.', 'type' => 'string', 'example' => 'Container', 'title' => ''], + 'description' => 'A list of keywords.', + 'title' => '', + 'example' => '', ], + 'language' => ['description' => 'Language.', 'type' => 'string', 'example' => 'zh', 'title' => ''], + 'latestReleaseCreateTime' => ['description' => 'The time when the latest version was created.', 'type' => 'string', 'example' => '2025-09-03T03:15:56Z', 'title' => ''], + 'name' => ['description' => 'The name of the add-on.', 'type' => 'string', 'example' => 'rum_api_dashboard_explorer_link_metric_set', 'title' => ''], + 'once' => ['description' => 'Indicates whether the add-on can be installed only once.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'scene' => ['description' => 'The scenario of the component.', 'type' => 'string', 'example' => 'middleware', 'title' => ''], + 'version' => ['description' => 'The version of the component.', 'type' => 'string', 'example' => '*', 'title' => ''], + 'weight' => ['description' => 'The display weight of the add-on.', 'type' => 'string', 'example' => '99', 'title' => ''], ], + 'description' => 'The details of the add-on.', + 'title' => '', + 'example' => '', ], + 'description' => 'A list of available add-ons.', + 'title' => '', + 'example' => '', ], + 'requestId' => ['description' => 'Id of the request', 'type' => 'string', 'title' => '', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], - 'required' => false, - ], - ], - [ - 'name' => 'workspace', - 'in' => 'path', - 'schema' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'required' => true, - 'example' => 'default-cms-1793369865235921-cn-shenzhen', - 'title' => '工作空间', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '3A2FA9E9-9CF1-5CB1-A808-52828F14310D', - 'title' => '请求id', - ], - 'serviceId' => [ - 'description' => 'Service ID', - 'type' => 'string', - 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', - 'title' => '应用服务id', - ], - 'pid' => [ - 'description' => 'Historical compatible ARMS application ID', - 'type' => 'string', - 'example' => 'cwzxvuc6uo@d60088ad4797d26', - 'title' => '对应ARMS应用pid', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListAddons', + 'description' => 'Creates a site monitoring job.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'cms:ListAddons', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - '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' => 'Create Application Observability Service', - 'requestParamsDescription' => 'Extended attributes `attributes`,'."\n" - .'when `serviceType=TRACE`, optional attribute `language` with possible values being java/python/golang;'."\n" - .'when `serviceType=XTRACE`, optional attribute `language` with possible values referring to open-source values at https://opentelemetry.io/docs/specs/semconv/registry/attributes/telemetry/.', - 'translator' => 'machine', + '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"}]', ], - 'ListServices' => [ - 'summary' => 'List Resource Services', - 'path' => '/workspace/{workspace}/services', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListAggTaskGroups' => [ + 'summary' => 'Queries the list of aggregation task groups.', + 'path' => '/prometheus-instances/{instanceId}/agg-task-groups', + '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' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'nextToken', + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The instance ID of the Managed Service for Prometheus instance to which the aggregation node group belongs. The aggregation node reads data from this instance.', 'type' => 'string', 'required' => true, 'example' => 'rw-pq4apob9jm'], + ], + [ + 'name' => 'filterAggTaskGroupIds', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The list of aggregation task group IDs. The value must be a JSON-parsable string.', 'type' => 'string', 'example' => '["aggTaskGroup-xxx"]', 'required' => false], + ], + [ + 'name' => 'filterAggTaskGroupNames', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The list of aggregation task group names. The value must be a JSON-parsable string.', 'type' => 'string', 'example' => '["apiserver_request_total"]', 'required' => false], + ], + [ + 'name' => 'status', 'in' => 'query', 'schema' => [ - 'description' => 'Token for the next query, an empty value indicates the last page.', + 'title' => '', + 'description' => 'The status of the aggregation task group. Valid values:'."\n" + ."\n" + .'- Running'."\n" + .'- Stopped'."\n" + ."\n" + .'Default value: Running.', + 'enumValueTitles' => ['Stopped' => 'Disabled.', 'Running' => 'Enabled.'], 'type' => 'string', + 'example' => 'Running', + 'enum' => ['Running', 'Stopped'], 'required' => false, - 'example' => '7-b81a-4bc9-bbfa-a50cc6988667', - 'title' => '翻页的 token，从 NextToken 开始按字典序返回文件信息列表。第一次调用此接口时，设置为空。', ], ], [ - 'name' => 'maxResults', + 'name' => 'targetPrometheusId', 'in' => 'query', - 'allowEmptyValue' => false, + 'schema' => ['title' => '', 'description' => 'The instance ID of the target Managed Service for Prometheus instance for the aggregation node group.', 'type' => 'string', 'example' => 'rw-pq4apob9jm', 'required' => false], + ], + [ + 'name' => 'tags', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The maximum number of records to return in this request.', - 'type' => 'integer', - 'format' => 'int32', + 'title' => '', + 'description' => 'The resource group tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The resource group tags.', + 'type' => 'object', + 'properties' => [ + 'key' => ['title' => '', 'description' => 'The key of the resource group tag.', 'type' => 'string', 'required' => false, 'example' => 'key1'], + 'value' => ['title' => '', 'description' => 'The value of the resource group tag.', 'type' => 'string', 'required' => false, 'example' => 'value1'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '10', - 'title' => '查询一页数量，最大500。', - 'maximum' => '500', - 'minimum' => '0', - 'exclusiveMinimum' => false, + 'example' => '', ], ], [ - 'name' => 'workspace', - 'in' => 'path', - 'schema' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - 'title' => '工作空间', - ], + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The maximum number of records to return.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '0', 'example' => '20', 'default' => '20', 'required' => false], ], [ - 'name' => 'serviceType', + 'name' => 'nextToken', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The query token.', 'type' => 'string', 'maxLength' => 128, 'required' => false, 'example' => '28036394xxx'], + ], + [ + 'name' => 'query', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name to search for. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Service type', - 'type' => 'string', - 'required' => false, - 'example' => 'apm', - 'enum' => [ - 'TRACE', - 'XTRACE', - 'RUM', + 'title' => '', + 'description' => 'The response struct.', + 'type' => 'object', + 'properties' => [ + 'aggTaskGroups' => [ + 'title' => '', + 'description' => 'The list of aggregation task groups.', + 'type' => 'array', + 'items' => [ + 'description' => 'The aggregation task.', + 'type' => 'object', + 'properties' => [ + 'aggTaskGroupConfigHash' => ['title' => '', 'description' => 'The hash of the aggregation task group configuration.', 'type' => 'string', 'example' => 'a54136014xxx'], + 'aggTaskGroupId' => ['title' => '', 'description' => 'The ID of the aggregation task group.', 'type' => 'string', 'example' => 'aggTaskGroup-xxxx'], + 'aggTaskGroupName' => ['title' => '', 'description' => 'The name of the aggregation task group.', 'type' => 'string', 'example' => 'pipeline-aggtask-group'], + 'cronExpr' => ['title' => '', 'description' => 'The cron expression of the aggregation task group when the scheduling mode is set to Cron.', 'type' => 'string', 'example' => '0 10 8 1 * ? *'], + 'delay' => ['title' => '', 'description' => 'The fixed scheduling delay, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'description' => ['title' => '', 'description' => 'The description of the aggregation task group.', 'type' => 'string', 'example' => 'workspace api monitor update test'], + 'fromTime' => ['title' => '', 'description' => 'The UNIX timestamp that indicates the scheduling start time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1757409499000'], + 'interval' => ['title' => '', 'description' => 'The scheduling interval.', 'type' => 'string', 'example' => '2025-04-24 00:00:00,2025-04-24 00:00:00'], + 'maxRetries' => ['title' => '', 'description' => 'The maximum number of retries for executing the aggregation task.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'maxRunTimeInSeconds' => ['title' => '', 'description' => 'The maximum retry time for executing the aggregation task, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'regionId' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'scheduleMode' => ['title' => '', 'description' => 'The scheduling mode.', 'type' => 'string', 'example' => 'FixedRate'], + 'scheduleTimeExpr' => ['title' => '', 'description' => 'The schedule time expression.', 'type' => 'string', 'example' => '@m'], + 'sourcePrometheusId' => ['title' => '', 'description' => 'The instance ID of the source Managed Service for Prometheus instance for the aggregation node group.', 'type' => 'string', 'example' => 'rw-xxx'], + 'status' => ['title' => '', 'description' => 'The status of the aggregation task group.', 'type' => 'string', 'example' => 'Running'], + 'targetPrometheusId' => ['title' => '', 'description' => 'The instance ID of the target Managed Service for Prometheus instance for the aggregation node group.', 'type' => 'string', 'example' => 'rw-xxx'], + 'toTime' => ['title' => '', 'description' => 'The UNIX timestamp that indicates the scheduling end time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'updateTime' => ['title' => '', 'description' => 'The time when the aggregation task group was last updated, in UNIX timestamp format.', 'type' => 'string', 'example' => '1757409499000'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'maxResults' => ['title' => '', 'description' => 'The maximum number of records to return.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'default' => '0'], + 'nextToken' => ['title' => '', 'description' => 'The token for the next query.', 'type' => 'string', 'maxLength' => 128, 'example' => 'aa9d0e569b880xxx'], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7BF1F4D6-B9A8-5F0B-8C1D-4347FFCB798E'], + 'totalCount' => ['title' => '', 'description' => 'The total number of instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], ], - 'title' => '类型：TRACE（应用监控）/ RUM（用户体验监控）/ XTRACE（OT版）', + 'example' => '', ], ], + ], + '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' => [], + ], + 'title' => 'Query aggregation task groups', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAggTaskGroups'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + ], + 'ListAlertActions' => [ + 'path' => '/alertActions', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'serviceName', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'high', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'alertActionIds', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '应用服务名称', - 'type' => 'string', - 'example' => 'app-demo', + 'description' => 'The unique IDs of the alert action integrations.', + 'type' => 'array', + 'items' => ['description' => 'The unique ID of the alert action integration.', 'type' => 'string', 'required' => false, 'example' => 'testId', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'resourceGroupId', + 'name' => 'type', 'in' => 'query', 'schema' => [ - 'title' => '资源组id', + 'description' => 'The type of the alert action integration.', 'type' => 'string', - 'example' => 'rg-aekxxzuad5zzzz', + 'enum' => ['FC', 'MNS', 'OPEN_API', 'SLS', 'ESS', 'PAGER_DUTY', 'WEBHOOK', 'EB', 'FC3'], + 'required' => false, + 'example' => 'FC', + 'title' => '', ], ], [ - 'name' => 'tags', + 'name' => 'alertActionName', 'in' => 'query', - 'allowEmptyValue' => true, - 'style' => 'json', - 'schema' => [ - 'title' => '标签数组', - 'type' => 'array', - 'items' => [ - 'title' => '标签', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'title' => '标签key', - 'type' => 'string', - 'example' => 'evn', - ], - 'value' => [ - 'title' => '标签value', - 'type' => 'string', - 'example' => 'prod', - ], - ], - ], - ], + 'schema' => ['description' => 'The name of the alert action integration.', 'type' => 'string', 'required' => false, 'example' => 'testName', 'title' => ''], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], ], 'responses' => [ @@ -15587,1890 +14213,2100 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', - 'title' => '请求 ID。', - ], - 'nextToken' => [ - 'description' => 'Pagination token', - 'type' => 'string', - 'example' => '2-ba4d-4b9f-aa24-dcb067a30f1c', - 'title' => '分页标识。返回值 nextToken 非空代表还有剩余数据。把 nextToken 作为参数继续查询会获得下一页。', - ], - 'totalCount' => [ - 'description' => 'Total count', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '66', - 'title' => '总应用服务数量', - ], - 'maxResults' => [ - 'description' => 'Maximum number of results to return, with a maximum value of 200', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '查询一页数量。', - ], - 'services' => [ - 'description' => 'List of service information.', + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****', 'title' => ''], + 'total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '9', 'title' => ''], + 'pageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'pageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'alertActions' => [ + 'description' => 'The list of alert action integration configurations.', 'type' => 'array', 'items' => [ - 'description' => 'Service information.', + 'description' => 'The list of alert action integration configurations.', 'type' => 'object', 'properties' => [ - 'serviceId' => [ - 'description' => 'Service ID', - 'type' => 'string', - 'example' => 'jm2pl0yoqf@d4905cb11a4f218dfb0a8', - 'title' => '应用服务id', - ], - 'serviceName' => [ - 'description' => 'Service name', - 'type' => 'string', - 'example' => 'demo-app', - 'title' => '应用资源名称', - ], - 'createTime' => [ - 'description' => 'Creation time', - 'type' => 'string', - 'example' => '2025-07-01T02:23:59Z', - 'title' => '创建时间', - ], - 'serviceType' => [ - 'description' => 'Service type', - 'type' => 'string', - 'example' => 'TRACE', - 'title' => '类型：TRACE（应用监控）/ RUM（用户体验监控）/ XTRACE（OT版）', + 'alertActionId' => ['description' => 'The unique ID of the alert action integration.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'mnsParam' => [ + 'description' => 'The parameters of Simple Message Queue (formerly MNS).', + 'type' => 'object', + 'properties' => [ + 'mnsType' => ['description' => 'The resource type of Simple Message Queue (formerly MNS).', 'type' => 'string', 'example' => 'queue', 'title' => ''], + 'name' => ['description' => 'The name of the resource.'."\n" + ."\n" + .'- If the resource type is \\`queue\\`, this parameter specifies the queue name.'."\n" + ."\n" + .'- If the resource type is \\`topic\\`, this parameter specifies the topic name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'serviceStatus' => [ - 'description' => 'Service status, valid only when serviceType=RUM.', - 'type' => 'string', - 'example' => 'Running', - 'title' => '应用体验监控的服务状态，running/stopped/created/suspend', + 'type' => ['description' => 'The type of the alert action integration.', 'type' => 'string', 'example' => 'FC', 'title' => ''], + 'slsParam' => [ + 'description' => 'The parameters of Simple Log Service.', + 'type' => 'object', + 'properties' => [ + 'logstore' => ['description' => 'The name of the Simple Log Service Logstore.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'project' => ['description' => 'The name of the Simple Log Service project.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'displayName' => [ - 'description' => 'Display name, valid only when serviceType=RUM.', - 'type' => 'string', - 'example' => 'test', - 'title' => '别名', + 'alertActionName' => ['description' => 'The name of the alert action integration.', 'type' => 'string', 'example' => 'testName', 'title' => ''], + 'essParam' => [ + 'description' => 'The parameters of Auto Scaling.', + 'type' => 'object', + 'properties' => [ + 'essGroupId' => ['description' => 'The ID of the Auto Scaling group.', 'type' => 'string', 'example' => 'testId', 'title' => ''], + 'essRuleId' => ['description' => 'The ID of the scaling rule.', 'type' => 'string', 'example' => 'testId', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'pid' => [ - 'description' => 'Historical compatible ARMS application ID', - 'type' => 'string', - 'example' => 'kgcsf@192197e828d51aa', - 'title' => '对应ARMS应用pid', + 'fcParam' => [ + 'description' => 'The parameters of Function Compute.', + 'type' => 'object', + 'properties' => [ + 'function' => ['description' => 'The function name of the Function Compute service.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'service' => ['description' => 'The service name of Function Compute.', 'type' => 'string', 'example' => 'test', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'description' => [ - 'description' => 'Service description, valid only when serviceType=RUM.', - 'type' => 'string', - 'example' => 'workspace api monitor test', - 'title' => '应用描述信息。', + 'pagerDutyParam' => [ + 'description' => 'The PagerDuty parameters.', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The integration key of PagerDuty.', 'type' => 'string', 'example' => 'fsfer4543t5t65g4t4', 'title' => ''], + 'url' => ['description' => 'The integration webhook of PagerDuty. Versions 1 and 2 are supported.', 'type' => 'string', 'example' => 'https://events.pagerduty.com/v2/enqueue', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'attributes' => [ - 'description' => 'Extended information.', - 'type' => 'string', - 'example' => '{"language":"java"}', - 'title' => '特征信息，key:value格式', + 'webhookParam' => [ + 'description' => 'The webhook parameters.', + 'type' => 'object', + 'properties' => [ + 'method' => ['description' => 'The request method of the webhook.', 'type' => 'string', 'example' => 'GET', 'title' => ''], + 'url' => ['description' => 'The callback URL for alerts.', 'type' => 'string', 'example' => 'http://www.test.com', 'title' => ''], + 'contentType' => ['description' => 'The data format. This parameter is valid only when the request method is POST.', 'type' => 'string', 'example' => 'JSON', 'title' => ''], + 'headers' => [ + 'description' => 'The request headers.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The request headers.', 'type' => 'string', 'example' => '{\'X-Total-Count\': 0}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], - 'workspace' => [ - 'description' => 'Workspace.', - 'type' => 'string', - 'example' => 'default-cms-1192928460540589-cn-hangzhou', - 'title' => '工作空间', + 'fc3Param' => [ + 'description' => 'The parameters of Function Compute 3.0.', + 'type' => 'object', + 'properties' => [ + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-qingdao', 'title' => ''], + 'function' => ['description' => 'The function name of the Function Compute service.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'qualifier' => ['description' => 'The version or alias of the function.', 'type' => 'string', 'example' => 'test', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'resourceGroupId' => [ - 'title' => '资源组id', - 'type' => 'string', - 'example' => 'rg-aekxxzuad5zzzz', + 'ebParam' => [ + 'description' => 'Specifies the event bus.', + 'type' => 'object', + 'properties' => [ + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-heyuan', 'title' => ''], + 'eventBusName' => ['description' => 'The name of the event bus.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'subject' => ['description' => 'The subject.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'ebSource' => ['description' => 'The event provider.', 'type' => 'string', 'example' => 'test', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], - 'title' => '应用服务', + 'title' => '', + 'example' => '', ], - 'title' => '应用服务列表', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query Alert Action Integration', + 'summary' => 'Queries alert action integrations.', + 'changeSet' => [ + ['createdAt' => '2025-07-01T06:49:23.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-11-04T06:29:21.000Z', 'description' => 'OpenAPI offline'], ], - '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' => 'Batch Query Application Observability Services', - 'translator' => 'machine', - ], - 'CreatePrometheusVirtualInstance' => [ - 'summary' => 'Create Prometheus Monitoring Instance', - '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' => 'Queries alert chatbots.', + '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' => 'The number of entries per page. Default value: 100.', 'type' => 'integer', 'format' => 'int64', 'default' => '100', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'robotIds', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'Request body', - 'type' => 'object', - 'properties' => [ - 'namespace' => [ - 'title' => '每个云产品在每个Regin只能创建一个虚拟实例', - 'description' => 'Each cloud product can only create one virtual instance in each region.', - 'type' => 'string', - 'required' => true, - 'example' => 'cms_prometheus', - ], + 'description' => 'The chatbot ID.', + 'type' => 'array', + 'items' => ['description' => 'The chatbot ID.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => ['description' => 'The chatbot name. Prefix fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'types', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The chatbot type.', + 'type' => 'array', + 'items' => [ + 'description' => 'The chatbot type.', + 'type' => 'string', + 'enum' => ['DING', 'WEIXIN', 'FEISHU', 'SLACK'], + 'required' => false, + 'example' => 'DING', + 'title' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'workspace', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response body structure.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'ID of the request', - 'type' => 'string', - 'example' => '0B9377D9-C56B-5C2E-A8A4-************', - ], - 'instance' => [ - 'title' => '实例ID', - 'description' => 'Instance ID', - 'type' => 'object', - 'properties' => [ - 'instanceId' => [ - 'title' => '地域ID', - 'description' => 'Region ID', - 'type' => 'string', - 'example' => 'rw-e815960b4c9ebc5c3d89790c7e82', - ], - 'regionId' => [ - 'title' => '用户ID', - 'description' => 'User ID', - 'type' => 'string', - 'example' => 'cn-zhengzhou-jva', - ], - 'userId' => [ - 'title' => '用户ID', - 'description' => 'User ID', - 'type' => 'string', - 'example' => '167212345678', - ], - 'namespace' => [ - 'title' => '云产品', - 'description' => 'Cloud product', - 'type' => 'string', - 'example' => 'ack-csi-fuse', - ], - 'httpApiUrl' => [ - 'title' => 'HTTP API查询地址', - 'description' => 'HTTP API query address', - 'type' => 'string', - 'example' => 'http://xxxxxxx', - ], - 'createdAt' => [ - 'title' => '创建时间', - 'description' => 'Creation time', - 'type' => 'string', - 'example' => '1751520976660', + 'pageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'pageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'robots' => [ + 'description' => 'The chatbot ID.', + 'type' => 'array', + 'items' => [ + 'description' => 'The chatbot ID.', + 'type' => 'object', + 'properties' => [ + 'lang' => ['description' => 'The language.', 'type' => 'string', 'example' => 'zh_CN', 'title' => ''], + 'name' => ['description' => 'The chatbot name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'robotId' => ['description' => 'The unique ID of the chatbot.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'type' => ['description' => 'The chatbot type.', 'type' => 'string', 'example' => 'DING', 'title' => ''], + 'url' => ['description' => 'The webhook URL of the chatbot.', 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=*******', 'title' => ''], + 'workspace' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'digitalEmployeeName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'robotSignKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.', 'description' => ''], + ], + 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' => 'Create Prometheus Monitoring Virtual Instance', - 'description' => 'Create a Prometheus monitoring virtual instance.', - 'translator' => 'machine', - ], - 'ListPrometheusVirtualInstances' => [ - 'summary' => 'Get Prometheus Virtual Instance', - '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' => 'Query alert chatbots', + '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' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'default' => '100', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'webhookIds', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '可选云产品', - 'description' => 'Optional cloud product', - 'type' => 'string', + 'description' => 'The unique ID of the webhook.', + 'type' => 'array', + 'items' => ['description' => 'The unique ID of the webhook.', 'type' => 'string', 'required' => false, 'example' => 'wh-def456uvw012', 'title' => ''], 'required' => false, - 'example' => 'ack-csi-fuse', + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the webhook.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'workspace', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The structure of the response.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'ID of the request', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'instances' => [ - 'description' => 'Instance information.', + 'pageNumber' => ['description' => 'The page number. The default value is 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'pageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8A33DBEA-*****-*****-*****-*****'], + 'total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''], + 'webhooks' => [ + 'description' => 'The webhooks.', 'type' => 'array', 'items' => [ - 'description' => 'Instance information.', + 'description' => 'The webhook.', 'type' => 'object', 'properties' => [ - 'instanceId' => [ - 'description' => 'Applicable data source type: PROMETHEUS_DS'."\n" - ."\n" - .'Prometheus instance ID', - 'type' => 'string', - 'example' => 'rw-b8cfbbe94194ac37fe83f3d2d16a', - ], - 'httpApiUrl' => [ - 'description' => 'HTTP API URL.', - 'type' => 'string', - 'example' => 'http://xxxxxxxx', - ], - 'userId' => [ - 'description' => 'User ID.', - 'type' => 'string', - 'example' => '17073812345', - ], - 'regionId' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-shanghai-cloudspe', - ], - 'namespace' => [ - 'description' => 'Applicable query type: CMS_BASIC_QUERY.'."\n" - ."\n" - .'Namespace of the metric', - 'type' => 'string', - 'example' => 'arms-prom', - ], - 'createdAt' => [ - 'description' => 'Creation time', - 'type' => 'string', - 'example' => '1750315319946', - ], + 'contentType' => ['description' => 'The content type of the data. Valid values:'."\n" + ."\n" + .'- JSON'."\n" + ."\n" + .'- FORM', 'type' => 'string', 'example' => 'JSON', 'title' => ''], + 'headers' => ['description' => 'The headers.', 'type' => 'object', 'example' => 'key', 'title' => ''], + 'lang' => ['description' => 'The language. Valid values:'."\n" + ."\n" + .'- zh\\_CN'."\n" + ."\n" + .'- en\\_US', 'type' => 'string', 'example' => 'zh_CN', 'title' => ''], + 'method' => ['description' => 'The request method. Valid values:'."\n" + ."\n" + .'- GET'."\n" + ."\n" + .'- POST', 'type' => 'string', 'example' => 'GET', 'title' => ''], + 'name' => ['description' => 'The name of the webhook.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'url' => ['description' => 'The URL of the alert callback.', 'type' => 'string', 'example' => 'http://aliyun.com/test', 'title' => ''], + 'webhookId' => ['description' => 'The unique ID of the webhook.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'workspace' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], ], - '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' => 'Get Prometheus Virtual Instance List', - 'description' => 'Used for creating a site monitoring task', - 'translator' => 'machine', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListAlertWebhooks', + 'summary' => 'Query webhooks', + '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"}]', ], - 'GetAggTaskGroup' => [ - 'summary' => 'Describes the aggregation task group', - 'path' => '/prometheus-instances/{instanceId}/agg-task-groups/{groupId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListBizTraces' => [ + 'summary' => 'Lists business traces.', + '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', + 'name' => 'workspace', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => 'The name of the workspace.', 'required' => false, 'title' => '', 'example' => 'default-cms-xxxxxx-cn-beijing'], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The maximum number of results to return. The maximum value is 100.', 'required' => false, 'title' => '', 'example' => '20'], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => 'The token for the next page of results.', 'required' => false, 'title' => '', 'example' => 'aa9d0e569b88098a0e3155c29b473201a'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '聚合任务组所属的 Prometheus 实例的 id，聚合任务从这个实例中读取数据', - 'description' => 'The ID of the Prometheus instance to which the aggregation task group belongs.', - 'type' => 'string', - 'required' => true, - 'example' => 'rw-xxx', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['type' => 'string', 'description' => 'The request ID.', 'title' => '', 'example' => '0CEC5375-C554-562B-A65F-*****'], + 'maxResults' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The maximum number of results returned. The maximum value is 100.', 'title' => '', 'example' => '20'], + 'nextToken' => ['type' => 'string', 'description' => 'The token to use to retrieve the next page of results.', 'title' => '', 'example' => 'aa9d0e569b88098a0e3155c29b473201a'], + 'totalCount' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The total number of entries.', 'title' => '', 'example' => '66'], + 'items' => [ + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/BizTraceConfig', 'description' => 'The business trace.', 'title' => '', 'example' => ''], + 'description' => 'The list of business traces.', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListBizTraces', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', '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"}]', + ], + 'ListContactGroups' => [ + 'summary' => 'Queries contact groups.', + 'path' => '/contactGroups', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'groupId', - 'in' => 'path', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return per page. The default is 100.', 'type' => 'integer', 'format' => 'int64', 'default' => '100', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. The default is 1.', 'type' => 'integer', 'format' => 'int64', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'contactGroupIds', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '聚合任务组 id', - 'description' => 'The ID of the aggregation task group.', - 'type' => 'string', - 'required' => true, - 'example' => 'aggTaskGroup-xxx', + 'description' => 'The contact group IDs.', + 'type' => 'array', + 'items' => ['description' => 'A contact group ID.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the contact group.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'workspace', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '出参结构体', - 'description' => 'Output parameter structure.', + 'title' => 'Schema of Response', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'aggTaskGroup' => [ - 'title' => '聚合任务组', - 'description' => 'Aggregation task group.', - 'type' => 'object', - 'properties' => [ - 'aggTaskGroupConfig' => [ - 'title' => '聚合任务组配置', - 'description' => 'Aggregation task group configuration.', - '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' => 'Summary of the aggregation task group configuration.', - 'type' => 'string', - 'example' => 'a54136xxx', - ], - 'aggTaskGroupId' => [ - 'title' => '聚合任务组 id', - 'description' => 'ID of the aggregation task group.', - 'type' => 'string', - 'example' => 'aggTaskGroup-xx', - ], - 'aggTaskGroupName' => [ - 'title' => '聚合任务组名称', - 'description' => 'Name of the aggregation task group.', - 'type' => 'string', - 'example' => 'pipeline-aggtask-group', - ], - 'cronExpr' => [ - 'title' => '调度模式选择“Cron”情况下，聚合任务组的调度表达式', - 'description' => 'Scheduling expression for the aggregation task group when the scheduling mode is \'Cron\'.', - 'type' => 'string', - 'example' => '0 1 3 * * ? *', - ], - 'delay' => [ - 'title' => '调度的固定延迟时间', - 'description' => 'Fixed delay time (in seconds) for scheduling.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'description' => [ - 'title' => '聚合任务组描述'."\n" - ."\n", - 'description' => 'Description of the aggregation task group.', - 'type' => 'string', - 'example' => 'test', - ], - 'fromTime' => [ - 'title' => '调度开始时间对应的的秒级时间戳', - 'description' => 'Second-level timestamp corresponding to the start time of scheduling (not yet effective).', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1757409495', - ], - 'maxRetries' => [ - 'title' => '执行聚合任务的最大重试次数', - 'description' => 'Maximum number of retries for executing the aggregation task.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'maxRunTimeInSeconds' => [ - 'title' => '执行聚合任务的最大重试时间', - 'description' => 'Maximum retry time for executing the aggregation task.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'precheckString' => [ - 'title' => '预检测配置', - 'description' => 'Pre-check configuration.', - 'type' => 'string', - 'example' => '{"policy":"skip","prometheusId":"rw-xx","query":"noPrecheck","threshold":0.5,"timeout":15,"type":"none"}', - ], - 'regionId' => [ - 'title' => '地域 id', - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-zhangjiakou', - ], - 'scheduleMode' => [ - 'title' => '调度模式', - 'description' => 'Scheduling mode.', - 'type' => 'string', - 'example' => 'FixedRate', - ], - 'scheduleTimeExpr' => [ - 'title' => '调度时间表达式', - 'description' => 'Scheduling time expression.', - 'type' => 'string', - 'example' => '@m', - ], - 'sourcePrometheusId' => [ - 'title' => '聚合任务组的源 Prometheus 实例 id', - 'description' => 'ID of the source Prometheus instance for the aggregation task group.', - 'type' => 'string', - 'example' => 'rw-xxx', - ], - 'status' => [ - 'title' => '聚合任务组状态', - 'description' => 'Status of the aggregation task group.', - 'type' => 'string', - 'example' => 'Running', - ], - 'tags' => [ - 'title' => '资源组标签', - 'description' => 'Resource group tags', - 'type' => 'array', - 'items' => [ - 'description' => 'Tags.', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'title' => '资源组标签的键', - 'description' => 'Key of the resource group tag.', - 'type' => 'string', - 'example' => 'key1', - ], - 'value' => [ - 'title' => '资源组标签的值', - 'description' => 'The value of the resource group tag.', - 'type' => 'string', - 'example' => 'value1', - ], - ], + 'contactGroups' => [ + 'description' => 'A list of contact groups.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a contact group.', + 'type' => 'object', + 'properties' => [ + 'contactGroupId' => ['description' => 'The contact group ID.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'contactIds' => [ + 'type' => 'array', + 'items' => ['description' => 'A contact ID.', 'type' => 'string', 'example' => '[\\"演示会议\\"]', 'title' => ''], + 'description' => 'The contact IDs in the group.', + 'title' => '', + 'example' => '["Demo meeting"]', ], + 'name' => ['description' => 'The name of the contact group.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'workspace' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], - 'targetPrometheusId' => [ - 'title' => '聚合任务组的目标 Prometheus 实例 id', - 'description' => 'The target Prometheus instance ID of the aggregation task group.', - 'type' => 'string', - 'example' => 'rw-xxx', - ], - 'toTime' => [ - 'title' => '调度结束时间对应的秒级时间戳', - 'description' => 'The second-level timestamp corresponding to the end time of the scheduling.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1757409495', - ], - 'updateTime' => [ - 'title' => '聚合任务组的更新时间', - 'description' => 'The update time (timestamp) of the aggregation task group.', - 'type' => 'string', - 'example' => '1757409499000', - ], - 'userId' => [ - 'title' => '聚合任务组所属用户', - 'description' => 'The user to whom the aggregation task group belongs.', - 'type' => 'string', - 'example' => '123xxx', - ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'requestId' => [ - 'title' => '请求 id', - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '68DAF543-35DF-5762-BE90-F5C00B5DC036', - ], - 'success' => [ - 'title' => '请求是否成功', - 'description' => 'Whether the request was successful', - 'type' => 'boolean', - 'example' => 'True', - ], + 'pageNumber' => ['description' => 'The returned page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'pageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '15', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], ], - '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' => 'Query Aggregation Task Group', - 'translator' => 'machine', - ], - 'CreateAggTaskGroup' => [ - 'summary' => 'Create Aggregation Task Group', - 'path' => '/prometheus-instances/{instanceId}/agg-task-groups', - 'methods' => [ - 'post', + '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' => 'ListContactGroups', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:ListContactGroups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'ContactGroup', 'arn' => 'acs:cms:{#regionId}:{#accountId}:contactgroup/{#contactGroupId}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'ListContacts' => [ + 'summary' => 'Query contacts', + 'path' => '/contact', + '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', + 'operationType' => 'list', + 'riskType' => 'high', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcmsOZILZ5'], ], 'parameters' => [ [ - 'name' => 'instanceId', - 'in' => 'path', + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page. Default value: 100.', 'type' => 'integer', 'format' => 'int64', 'default' => '100', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'contactIds', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '聚合任务组的源 Prometheus 实例 id', - 'description' => 'The source Prometheus instance ID of the aggregation task group.', - 'type' => 'string', - 'required' => true, - 'example' => 'pq4apob9jm', + 'description' => 'The contact IDs.', + 'type' => 'array', + 'items' => ['description' => 'The contact ID.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'name', + 'in' => 'query', + 'schema' => ['description' => 'The contact name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'phone', + 'in' => 'query', + 'schema' => ['description' => 'The mobile number of the contact.', 'type' => 'string', 'required' => false, 'example' => '15012345678', 'title' => ''], + ], + [ + 'name' => 'email', + 'in' => 'query', + 'schema' => ['description' => 'The email address of the contact.', 'type' => 'string', 'required' => false, 'example' => 'test@aliyun.com', 'title' => ''], + ], + [ + 'name' => 'groupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the contact group.', 'type' => 'string', 'required' => false, 'example' => 'group-id-123', 'title' => ''], + ], + [ + 'name' => 'queryUngroupedContacts', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to query only ungrouped contacts.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'workspace', + 'in' => 'query', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '入参结构体', - 'description' => 'Input parameter structure.', + 'title' => 'Schema of Response', + 'description' => 'The structure of the response body.', 'type' => 'object', 'properties' => [ - 'aggTaskGroupConfig' => [ - 'title' => '聚合任务组配置。目前仅支持 “RecordingRuleYaml” 格式，要求符合开源 Prometheus 的 RecordingRule 的格式要求', - 'description' => 'Aggregation task group configuration.'."\n" - .'Currently, only the “RecordingRuleYaml” format is supported, which must comply with the format requirements of open-source Prometheus RecordingRules.', - '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' => 'Aggregation task group configuration type, default is “RecordingRuleYaml” (open-source Prometheus RecordingRule format).', - 'type' => 'string', - 'required' => false, - 'example' => 'RecordingRuleYaml', - 'default' => 'RecordingRuleYaml', - ], - 'aggTaskGroupName' => [ - 'title' => '聚合任务组名称', - 'description' => 'Aggregation task group name.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-group', - ], - 'cronExpr' => [ - 'title' => '调度模式选择“Cron”情况下，具体的调度表达式。例如“0/1 * * * *”，表示从 0 分开始，每隔 1 分钟调度一次', - 'description' => 'When the scheduling mode is selected as “Cron”, this is the specific scheduling expression. For example, “0/1 * * * *” means starting from 0 minutes and scheduling every 1 minute.', - 'type' => 'string', - 'required' => false, - 'example' => '0/1 * * * *', - ], - 'delay' => [ - 'title' => '调度的固定延迟时间，单位：秒，默认 30 ', - 'description' => 'Fixed delay time for scheduling, in seconds, default is 30.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '120', - 'minimum' => '0', - 'example' => '30', - 'default' => '30', - ], - 'description' => [ - 'title' => '聚合任务组描述', - 'description' => 'Description of the aggregation task group.', - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], - 'fromTime' => [ - 'title' => '调度开始时间对应的的秒级时间戳', - 'description' => 'The second-level timestamp corresponding to the start time of the schedule.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1724996015', - ], - 'maxRetries' => [ - 'title' => '执行聚合任务的最大重试次数，默认 20', - 'description' => 'Maximum number of retries for executing the aggregation task, default is 20.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - 'default' => '20', - ], - 'maxRunTimeInSeconds' => [ - 'title' => '执行聚合任务的最大重试时间，单位：秒，默认 600', - 'description' => 'Maximum retry time for executing the aggregation task, in seconds, default is 600.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '600', - 'default' => '600', - ], - 'precheckString' => [ - 'title' => '预检测配置，默认不配置。输入的字符串需要能被正确 JSON 解析', - 'description' => 'Pre-check configuration, no configuration by default. The input string needs to be correctly parsed as 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' => 'Scheduling mode, either “Cron” or “FixedRate”, default is “FixedRate”.', - 'type' => 'string', - 'required' => false, - 'example' => 'FixedRate', - 'default' => 'FixedRate', - 'enum' => [ - 'FixedRate', - 'Cron', - ], - ], - 'scheduleTimeExpr' => [ - 'title' => '调度时间表达式，推荐 “@s” 或者 “@m”，表示调度时间窗口对齐的粒度，默认 “@m”', - 'description' => 'Scheduling time expression, recommended “@s” or “@m”, indicating the alignment granularity of the scheduling time window, default is “@m”.', - 'type' => 'string', - 'required' => false, - 'example' => '@m', - 'default' => '@m', - ], - 'status' => [ - 'title' => '聚合任务组状态，“Running” 或者 “Stopped”。默认 Running', - 'description' => 'Status of the aggregation task group, either “Running” or “Stopped”. Default is Running.', - 'type' => 'string', - 'required' => false, - 'example' => 'Running', - 'default' => 'Running', - 'enum' => [ - 'Running', - 'Stopped', - ], - ], - 'tags' => [ - 'title' => '资源组标签', - 'description' => 'Resource group tags.', + 'contacts' => [ + 'description' => 'The list of contacts.', 'type' => 'array', 'items' => [ - 'description' => 'Value of the resource tag.', + 'description' => 'The details of a contact.', 'type' => 'object', 'properties' => [ - 'key' => [ - 'title' => '资源组标签的键', - 'description' => 'Key of the resource group tag.', - 'type' => 'string', - 'required' => false, - 'example' => 'key1', + 'contactId' => ['description' => 'The ID of the contact.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'email' => ['description' => 'The email address of the contact.', 'type' => 'string', 'example' => 'test@aliyun.com', 'title' => ''], + 'emailVerify' => ['description' => 'Indicates whether the email address is verified.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'groupList' => [ + 'description' => 'A list of contact group IDs to which the contact belongs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the contact group.', 'type' => 'string', 'example' => 'groupId', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'value' => [ - 'title' => '资源组标签的值', - 'description' => 'Value of the resource group tag.', - 'type' => 'string', - 'required' => false, - 'example' => 'value1', + 'lang' => ['description' => 'The language preference for notifications. Valid values: zh-CN and en-US.', 'type' => 'string', 'example' => 'zh_CN', 'title' => ''], + 'name' => ['description' => 'The name of the contact.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'phone' => ['description' => 'The phone number of the contact.', 'type' => 'string', 'example' => '130123456789', 'title' => ''], + 'phoneVerify' => ['description' => 'Indicates whether the phone number is verified.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'updateTime' => ['description' => 'The last time the contact was updated.', 'type' => 'string', 'example' => '2024-10-22 02:21:51', 'title' => ''], + 'imUserIds' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'The user ID for an instant messaging tool. The key indicates the tool, such as `dingtalk`, and the value is the user ID.', 'type' => 'string', 'example' => '{"dingtalk": "abc123", "wechat": "def456"}', 'title' => ''], + 'description' => 'A map of user IDs for various instant messaging (IM) tools.', + 'title' => '', + 'example' => '', ], + 'workspace' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], - 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => false, - ], - 'targetPrometheusId' => [ - 'title' => '聚合任务组的目标 Prometheus 实例 id', - 'description' => 'The target Prometheus instance ID of the aggregation task group.', - 'type' => 'string', - 'required' => true, - 'example' => 'rw-pq4apob9jm', - ], - 'toTime' => [ - 'title' => '调度结束时间对应的秒级时间戳，0 表示不停止调度', - 'description' => 'The second-level timestamp corresponding to the end time of the schedule, 0 indicates that the scheduling does not stop.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', + 'title' => '', + 'example' => '', ], + 'pageNumber' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'pageSize' => ['description' => 'The number of entries per page. Default value: 100.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '56', 'title' => ''], ], - 'required' => false, + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListContacts', + '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' => [ [ - 'name' => 'overrideIfExists', + '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' => 'The ID of the workspace.', 'type' => 'string', 'required' => false, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the context store.', 'type' => 'string', 'required' => false, 'example' => 'test-context-Store', 'title' => ''], + ], + [ + 'name' => 'nextToken', 'in' => 'query', - 'schema' => [ - 'title' => '创建聚合任务组时，存在同名资源是否覆盖更新', - 'description' => 'Whether to overwrite and update if a resource with the same name exists when creating an aggregation task group.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], + 'schema' => ['description' => 'The pagination token used to retrieve the next page of results. Leave this parameter empty to retrieve the first page.', 'type' => 'string', 'required' => false, 'example' => '615dfe7fd00f699ea94d5e63ba564aaf22450858c58f1387cc78f883b2254ab47232ce40fa95d9cb', 'title' => ''], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of entries to return in a single request. If this parameter is not specified, the service returns a default number of entries.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '出参结构体', - 'description' => 'Output parameter structure.', 'type' => 'object', 'properties' => [ - 'aggTaskGroupConfigHash' => [ - 'title' => '聚合任务组配置的摘要', - 'description' => 'Summary of the aggregation task group configuration.', - 'type' => 'string', - 'example' => 'a54136014dc386a92c83a6ef1e97ff22', - ], - 'aggTaskGroupId' => [ - 'title' => '聚合任务组 id', - 'description' => 'Aggregation task group ID.', - 'type' => 'string', - 'example' => 'aggTaskGroup-f4b8e50525cf41c894488c0c71ec483f', - ], - 'aggTaskGroupName' => [ - 'title' => '聚合任务组名称', - 'description' => 'Aggregation task group name.', - 'type' => 'string', - 'example' => 'pipeline-aggtask-group', - ], - 'requestId' => [ - 'title' => '请求 id', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '16C0A6D6-C3E7-511D-A60B-A87FD85F5BA7', - ], - 'sourcePrometheusId' => [ - 'title' => '聚合任务组的源 Prometheus 实例 id', - 'description' => 'Source Prometheus instance ID of the aggregation task group.', - 'type' => 'string', - 'example' => 'rw-ecc04af14729b1a16e40a0d10068', - ], - 'status' => [ - 'title' => '聚合任务组的当前状态', - 'description' => 'Current status of the aggregation task group.', - 'type' => 'string', - 'example' => 'Pending2Running', + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'nextToken' => ['description' => 'A pagination token. To retrieve the next page of results, include this value in the `nextToken` parameter of your next request. If this parameter is not returned, there are no more results.', 'type' => 'string', 'example' => 'xCs4wJD41qEejNkappMSJ1OL2Ky2GeKLqmBLJrC61WrgUOj9F-31jHbo5Kgqzifv', 'title' => ''], + 'maxResults' => ['description' => 'The maximum number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'total' => ['description' => 'The total count of entries that match the query.', 'type' => 'integer', 'format' => 'int32', 'example' => '454', 'title' => ''], + 'results' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The display name of the API key. This name helps you identify the purpose of the key.', 'type' => 'string', 'example' => 'Production Service Key', 'title' => ''], + 'apiKey' => ['description' => 'The complete API key value.', 'type' => 'string', 'example' => 'sk-3ac8d45d741e4f31b81aa6ee984ce9fd', 'title' => ''], + 'createTime' => ['description' => 'The time when the API key was created, represented as a Unix timestamp.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1778205145', 'title' => ''], + 'workspace' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'example' => 'test-workspace', 'title' => ''], + 'contextStoreName' => ['description' => 'The name of the context store.', 'type' => 'string', 'example' => 'test-context-Store', 'title' => ''], + ], + 'description' => 'An object containing the details of an API key.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The list of API keys.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListContextStoreAPIKeys', + 'summary' => 'Lists API keys.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - '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' => 'Create Aggregation Task Group', - 'translator' => 'machine', + '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"}]', ], - 'DeleteAggTaskGroup' => [ - 'summary' => 'Delete Aggregation Task Group', - 'path' => '/prometheus-instances/{instanceId}/agg-task-groups/{groupId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'ListContextStores' => [ + 'summary' => 'Retrieves a list of context stores.', + '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' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'instanceId', + 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'title' => '聚合任务组所属的 Prometheus 实例的 id，聚合任务从这个实例中读取数据', - 'description' => 'The ID of the Prometheus instance to which the aggregation task group belongs. The aggregation tasks read data from this instance.', - 'type' => 'string', - 'required' => true, - 'example' => 'rw-pq4apob9jm', - ], + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'groupId', - 'in' => 'path', - 'schema' => [ - 'title' => '聚合任务组 id', - 'description' => 'Aggregation task group ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'aggTaskGroup-xxx', - ], + 'name' => 'contextStoreName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the context store.', 'type' => 'string', 'required' => false, 'example' => 'test-context-store', 'title' => ''], + ], + [ + 'name' => 'contextType', + 'in' => 'query', + 'schema' => ['description' => 'The context type.', 'type' => 'string', 'required' => false, 'example' => 'memory', 'title' => ''], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of results to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token for the next page of results.', 'type' => 'string', 'required' => false, 'example' => 'OCAQV0pBqldexv7EidbIZw==', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '出参结构体', - 'description' => 'Output parameter structure', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求 id', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', + 'requestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****', 'title' => ''], + 'nextToken' => ['description' => 'The token to retrieve the next page of results. If this field is empty, all results have been returned.', 'type' => 'string', 'example' => '2-ba4d-4b9f-aa24-dcb067a30f1c', 'title' => ''], + 'maxResults' => ['description' => 'The maximum number of results returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'total' => ['description' => 'The total number of context stores.', 'type' => 'integer', 'format' => 'int32', 'example' => '56', 'title' => ''], + 'results' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'contextStoreName' => ['description' => 'The name of the context store.', 'type' => 'string', 'example' => 'test-context-store', 'title' => ''], + 'workspace' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'example' => 'workspace-test', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-heyuan', 'title' => ''], + 'contextType' => ['description' => 'The context type.', 'type' => 'string', 'example' => 'memory', 'title' => ''], + 'description' => ['description' => 'The description of the context store.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'status' => ['description' => 'The status of the context store.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'createTime' => ['description' => 'The creation time of the context store. The value is a Unix timestamp in milliseconds.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '173847364841938', 'title' => ''], + 'updateTime' => ['description' => 'The last update time of the context store. The value is a Unix timestamp in milliseconds.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '173847364841938', 'title' => ''], + ], + 'description' => 'The details of a context store.', + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of context stores.', + 'title' => '', + 'example' => '', ], ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListContextStores', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', - 'title' => 'Delete Aggregation Task Group', - 'translator' => 'machine', + '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"}]', ], - 'UpdateAggTaskGroupStatus' => [ - 'summary' => 'Update Aggregation Task Group Status', - 'path' => '/prometheus-instances/{instanceId}/agg-task-groups/{groupId}/status', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'ListDatasets' => [ + 'summary' => 'Retrieves a list of datasets in a specified workspace.', + 'path' => '/workspace/{workspace}/dataset', + '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', 'autoTest' => true], 'parameters' => [ [ - 'name' => 'instanceId', + 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'title' => '聚合任务组所属的 Prometheus 实例的 id，聚合任务从这个实例中读取数据', - 'description' => 'The ID of the Prometheus instance to which the aggregation task group belongs. The aggregation tasks read data from this instance.', - 'type' => 'string', - 'required' => true, - 'example' => 'rw-pq4apob9jm', - ], + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'groupId', - 'in' => 'path', - 'schema' => [ - 'title' => '聚合任务组 id', - 'description' => 'Aggregation task group ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'aggTaskGroup-xxx', - ], + 'name' => 'datasetName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the dataset.', 'type' => 'string', 'required' => false, 'example' => 'test_dataset', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => '入参结构体', - 'description' => 'Input parameter structure.', - 'type' => 'object', - 'properties' => [ - 'status' => [ - 'title' => '聚合任务组状态，“Running” 或者 “Stopped”。默认 Running', - 'description' => 'Status of the aggregation task group, either “Running” or “Stopped”. Default is Running.', - 'type' => 'string', - 'required' => true, - 'example' => 'Running', - 'enum' => [ - 'Running', - 'Stopped', - ], - ], - ], - 'required' => false, - ], + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of results to return per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token for retrieving the next page of results. A `nextToken` is included in the response when the result set is truncated. To continue pagination, provide the `nextToken` from the previous response.', 'type' => 'string', 'required' => false, 'example' => 'd9a48d977f45aa6fcf6981ed13b885b3fab0b124c12dcbbe70edce5d81ba****************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '出参结构体', - 'description' => 'Output parameter structure.', 'type' => 'object', 'properties' => [ - 'aggTaskGroupConfigHash' => [ - 'title' => '聚合任务组配置的摘要', - 'description' => 'Summary of the aggregation task group configuration.', - 'type' => 'string', - 'example' => 'a54136014dc386a92c83a6ef1e97ff22', - ], - 'aggTaskGroupId' => [ - 'title' => '聚合任务组 id', - 'description' => 'Aggregation task group ID.', - 'type' => 'string', - 'example' => 'aggTaskGroup-xxx', - ], - 'aggTaskGroupName' => [ - 'title' => '聚合任务组名称', - 'description' => 'Aggregation task group name.', - 'type' => 'string', - 'example' => 'pipeline-aggtask-group', - ], - 'requestId' => [ - 'title' => '请求 id', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-***', - ], - 'sourcePrometheusId' => [ - 'title' => '聚合任务组的源 Prometheus 实例 id', - 'description' => 'Source Prometheus instance ID of the aggregation task group.', - 'type' => 'string', - 'example' => 'rw-xxx', - ], - 'status' => [ - 'title' => '聚合任务组的当前状态', - 'description' => 'The current status of the aggregated task group.', - 'type' => 'string', - 'example' => 'Running', + 'nextToken' => ['description' => 'A token to retrieve the next page of results. This element is returned only when the result set is truncated.', 'type' => 'string', 'example' => 'd9a48d977f45aa6fcf6981ed13b885b3fab0b124c12dcbbe70edce5d81ba****************', 'title' => ''], + 'maxResults' => ['description' => 'The maximum number of results returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****', 'title' => ''], + 'total' => ['description' => 'The total number of datasets that match the query.', 'type' => 'integer', 'format' => 'int32', 'example' => '96', 'title' => ''], + 'datasets' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'The description of the dataset.', 'type' => 'string', 'example' => 'test dataset', 'title' => ''], + 'createTime' => ['description' => 'The time the dataset was created, as a UNIX timestamp.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1695090077', 'title' => ''], + 'updateTime' => ['description' => 'The time the dataset was last updated, as a UNIX timestamp.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1695090077', 'title' => ''], + 'datasetName' => ['description' => 'The name of the dataset.', 'type' => 'string', 'example' => 'test_dataset', 'title' => ''], + 'workspace' => ['description' => 'The ID of the workspace that contains the dataset.', 'type' => 'string', 'example' => 'workspace-test', 'title' => ''], + 'regionId' => ['description' => 'The ID of the region where the dataset resides.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'description' => 'An object that represents a dataset.', + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of dataset objects.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The object containing the response data.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListDatasets', + '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' => 'Update Aggregation Task Group Status', - 'translator' => 'machine', + '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' => 'Apply Aggregation Task Group', - 'path' => '/prometheus-instances/{instanceId}/agg-task-groups/{groupId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'ListDeliveryTasks' => [ + 'summary' => 'Retrieves the list of data delivery tasks.', + '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' => 'The ID of the Prometheus instance to which the aggregation task group belongs. The aggregation tasks read data from this instance.', - 'type' => 'string', - 'required' => true, - 'example' => 'rw-pq4apob9jm', - ], + 'name' => 'keyWords', + 'in' => 'query', + 'schema' => ['description' => 'Fuzzy search by task name or task ID (LIKE semantics).', 'type' => 'string', 'required' => false, 'example' => 'test-task', 'title' => ''], ], [ - 'name' => 'groupId', - 'in' => 'path', - 'schema' => [ - 'title' => '聚合任务组 id', - 'description' => 'Aggregation task group ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'aggTaskGroup-xxxx', - ], + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2bhocin5e2na', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token. Leave this parameter empty for the first request. For subsequent requests, pass the nextToken value returned in the previous response.', 'type' => 'string', 'required' => false, 'example' => 'sjC5rekx93Ew7K7VcmI3wkBZBYQ-GphB2ilQu3zJCGxoZuicwyJznfo2riTjr-lq', 'title' => ''], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 20. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'tag', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '入参结构体', - 'description' => 'Input parameter structure.', + 'description' => 'The list of tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of tags.', + 'type' => 'object', + 'properties' => [ + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''], + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'testKey', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ - 'aggTaskGroupConfig' => [ - 'title' => '聚合任务组配置。目前仅支持 “RecordingRuleYaml” 格式，要求符合开源 Prometheus 的 RecordingRule 的格式要求', - 'description' => 'Aggregation task group configuration. Currently, only the “RecordingRuleYaml” format is supported, and it must comply with the format requirements of open-source Prometheus RecordingRules.', - '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' => 'Aggregation task group configuration type, default is “RecordingRuleYaml” (open-source Prometheus RecordingRule format).', - 'type' => 'string', - 'required' => false, - 'example' => 'RecordingRuleYaml', - 'default' => 'RecordingRuleYaml', - ], - 'aggTaskGroupName' => [ - 'title' => '聚合任务组名称', - 'description' => 'Aggregation task group name.', - 'type' => 'string', - 'required' => false, - 'example' => 'test-group', - ], - 'cronExpr' => [ - 'title' => '调度模式选择“Cron”情况下，具体的调度表达式。例如“0/1 * * * *”，表示从 0 分开始，每隔 1 分钟调度一次', - 'description' => 'When the scheduling mode is set to “Cron”, this is the specific scheduling expression. For example, “0/1 * * * *” means starting from 0 minutes, schedule every 1 minute.', - 'type' => 'string', - 'required' => false, - 'example' => '0/1 * * * *', - ], - 'delay' => [ - 'title' => '调度的固定延迟时间，单位：秒，默认 30', - 'description' => 'Fixed delay time for scheduling, in seconds, default is 30.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '120', - 'minimum' => '0', - 'example' => '30', - 'default' => '30', - ], - 'description' => [ - 'title' => '聚合任务组描述', - 'description' => 'Description of the aggregation task group.', - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], - 'fromTime' => [ - 'title' => '调度开始时间对应的的秒级时间戳', - 'description' => 'The second-level timestamp corresponding to the start time of the scheduling.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1724996015', - ], - 'maxRetries' => [ - 'title' => '执行聚合任务的最大重试次数，默认 20', - 'description' => 'Maximum number of retries for executing the aggregation task, default is 20.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - 'default' => '20', - ], - 'maxRunTimeInSeconds' => [ - 'title' => '执行聚合任务的最大重试时间，单位：秒，默认 600', - 'description' => 'Maximum retry time for executing the aggregation task, in seconds, default is 600.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '600', - 'default' => '600', - ], - 'precheckString' => [ - 'title' => '预检测配置，默认不配置。输入的字符串需要能被正确 JSON 解析', - 'description' => 'Pre-check configuration, no configuration by default. The input string needs to be correctly parsed as 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' => 'Scheduling mode, either “Cron” or “FixedRate”, default is “FixedRate”.', - 'type' => 'string', - 'required' => false, - 'example' => 'FixedRate', - 'default' => 'FixedRate', - 'enum' => [ - 'FixedRate', - 'Cron', - ], - ], - 'scheduleTimeExpr' => [ - 'title' => '调度时间表达式，推荐 “@s” 或者 “@m”，表示调度时间窗口对齐的粒度，默认 “@m”', - 'description' => 'Scheduling time expression, recommended values are “@s” or “@m”, indicating the granularity of the scheduling time window alignment, default is “@m”.', - 'type' => 'string', - 'required' => false, - 'example' => '@m', - 'default' => '@m', - ], - 'status' => [ - 'title' => '聚合任务组状态，“Running” 或者 “Stopped”。默认 Running', - 'description' => 'Status of the aggregation task group, either “Running” or “Stopped”. Default is Running.', - 'type' => 'string', - 'required' => false, - 'example' => 'Running', - 'default' => 'Running', - 'enum' => [ - 'Running', - 'Stopped', - ], - ], - 'tags' => [ - 'title' => '资源组标签', - 'description' => 'Resource group tags.', + 'maxResults' => ['description' => 'The maximum number of entries returned. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'nextToken' => ['description' => 'The pagination token for the next page.', 'type' => 'string', 'example' => '2-ba4d-4b9f-aa24-dcb067a30f1c', 'title' => ''], + 'totalCount' => ['description' => 'The total number of tasks.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'deliveryTasks' => [ + 'description' => 'The list of delivery tasks.', 'type' => 'array', 'items' => [ - 'description' => 'Tags.', + 'description' => 'The delivery task.', 'type' => 'object', 'properties' => [ - 'key' => [ - 'title' => '资源组标签的键', - 'description' => 'Key of the resource group tag.', + 'labelFiltersType' => [ + 'description' => 'The metric filtering mode.', + 'enumValueTitles' => ['Deny' => 'Deny', 'Allow' => 'Allow'], 'type' => 'string', - 'required' => false, - 'example' => 'key1', + 'example' => 'Allow', + 'title' => '', + ], + 'externalLabels' => [ + 'description' => 'The additional labels attached to all delivered metrics. The key is the label name and the value is the label value.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'externalLabelsKey → externalLabelsValue. Example: region → ap-southeast-1.', 'type' => 'string', 'example' => 'region: cn-hangzhou', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'sinkList' => [ + 'description' => 'The list of delivery targets. Multiple sinks can be configured.', + 'type' => 'array', + 'items' => [ + 'description' => 'The delivery target configuration.', + 'type' => 'object', + 'properties' => [ + 'sinkConfigs' => [ + 'description' => 'The detailed configuration of the delivery target. The meanings of key/value pairs vary depending on the sinkType.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The configuration items supported by each sinkType.', 'type' => 'string', 'example' => 'Url: http://xxxx/api/v1/write', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'sinkType' => [ + 'description' => 'The type of the delivery target.', + 'enumValueTitles' => ['AcsKafka' => 'AcsKafka', 'Prometheus' => 'Prometheus', 'AcsMaxcompute' => 'AcsMaxcompute'], + 'type' => 'string', + 'example' => 'Prometheus', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'taskDescription' => ['description' => 'The task description.', 'type' => 'string', 'example' => 'my delivery task', 'title' => ''], + 'updateTime' => ['description' => 'The update time.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2026-01-22T09:02:01Z', 'title' => ''], + 'tags' => [ + 'description' => 'The tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tags.', + 'type' => 'object', + 'properties' => [ + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'value', 'title' => ''], + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'key', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'value' => [ - 'title' => '资源组标签的值', - 'description' => 'Value of the resource group tag.', + 'dataSourceId' => ['description' => 'The data source ID (Prometheus instance ID).', 'type' => 'string', 'example' => 'rw-5f2b4c7e66342s', 'title' => ''], + 'createTime' => ['description' => 'The creation time.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2026-01-22T09:02:01Z', 'title' => ''], + 'labelFilters' => [ + 'description' => 'The metric filter conditions. Used together with labelFiltersType. The key is the metric label name and the value is the match value.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'filterKey → filterValue. Example: __name__ → up, job → my_job.', 'type' => 'string', 'example' => '__name__: up', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'taskName' => ['description' => 'The task name.', 'type' => 'string', 'example' => 'test-task', 'title' => ''], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-acfm3gn5i6bigbi', 'title' => ''], + 'taskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'db21f8a126d96953', 'title' => ''], + 'status' => [ + 'description' => 'The current status of the task.', + 'enumValueTitles' => ['Enable' => 'Enable', 'Disable' => 'Disable'], 'type' => 'string', - 'required' => false, - 'example' => 'value1', + 'example' => 'Enable', + 'title' => '', + ], + 'extraInfo' => [ + 'description' => 'The extended information.', + 'type' => 'object', + 'properties' => [ + 'taskNameList' => [ + 'description' => 'The list of EventBridge tasks.', + 'type' => 'array', + 'items' => ['description' => 'The EventBridge task.', 'type' => 'string', 'example' => 'prometheus-deliver-98e367d8fb8cc83b-0', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => false, - ], - 'targetPrometheusId' => [ - 'title' => '聚合任务组的目标 Prometheus 实例 id', - 'description' => 'Target Prometheus instance ID of the aggregation task group.', - 'type' => 'string', - 'required' => true, - 'example' => 'rw-pq4apob9jm', - ], - 'toTime' => [ - 'title' => '调度结束时间对应的秒级时间戳，0 表示不停止调度', - 'description' => 'The second-level timestamp corresponding to the end time of the scheduling, 0 indicates that the scheduling does not stop.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', + 'title' => '', + 'example' => '', ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7D7DF334-B2F2-5453-AD51-A27B337E3191', 'title' => ''], ], - 'required' => false, + 'example' => '', ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '出参结构体', - 'description' => 'Output parameter structure.', - 'type' => 'object', - 'properties' => [ - 'aggTaskGroupConfigHash' => [ - 'title' => '聚合任务组配置的摘要', - 'description' => 'Summary of the aggregation task group configuration.', - 'type' => 'string', - 'example' => 'a54136014dc386a92c83a6ef1e97ff22', - ], - 'aggTaskGroupId' => [ - 'title' => '聚合任务组 id', - 'description' => 'Aggregation task group ID', - 'type' => 'string', - 'example' => 'aggTaskGroup-5fb2c3ade63a4709bcb059d13493b7b8', - ], - 'aggTaskGroupName' => [ - 'title' => '聚合任务组名称', - 'description' => 'Aggregation task group name', - 'type' => 'string', - 'example' => 'pipeline-aggtask-group', - ], - 'requestId' => [ - 'title' => '请求 id', - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], - 'sourcePrometheusId' => [ - 'title' => '聚合任务组的源 Prometheus 实例 id', - 'description' => 'Source Prometheus instance ID of the aggregation task group', - 'type' => 'string', - 'example' => 'rw-083e17834e279f8c627fe91a2d72', - ], - 'status' => [ - 'title' => '聚合任务组的当前状态', - 'description' => 'Current status of the aggregation task group', - 'type' => 'string', - 'example' => 'Running', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve data delivery task list', + 'description' => 'Deletes a specified site monitoring task.', + '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' => 'Update Aggregation Task Group', - 'translator' => 'machine', + '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' => 'List Aggregation Task Groups', - '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' => 'The ID of the Prometheus instance to which the aggregation task group belongs. The aggregation tasks read data from this instance.', - 'type' => 'string', - 'required' => true, - 'example' => 'rw-pq4apob9jm', - ], + 'name' => 'policyId', + 'in' => 'query', + 'schema' => ['description' => 'The policy ID.', 'type' => 'string', 'required' => false, 'example' => 'policy-93817a401f78435596d745a97d2e85a1', 'title' => ''], ], [ - 'name' => 'filterAggTaskGroupIds', + 'name' => 'policyName', 'in' => 'query', - 'schema' => [ - 'title' => '聚合任务组的 id 列表，需要能被 JSON 解析', - 'description' => 'List of IDs for the aggregation task groups, which must be JSON parseable.', - 'type' => 'string', - 'required' => false, - 'example' => '["aggTaskGroup-xxx"]', - ], + 'schema' => ['description' => 'The rule name.', 'type' => 'string', 'required' => false, 'example' => 'prod-database', 'title' => ''], ], [ - 'name' => 'filterAggTaskGroupNames', + 'name' => 'policyType', 'in' => 'query', - 'schema' => [ - 'title' => '聚合任务组名称列表，需要能被 JSON 解析', - 'description' => 'List of names for the aggregation task groups, which must be JSON parseable.', - 'type' => 'string', - 'required' => false, - 'example' => '["apiserver_request_total"]', - ], + 'schema' => ['description' => 'The policy type.', 'type' => 'string', 'required' => false, 'example' => 'CS', 'title' => ''], ], [ - 'name' => 'status', + 'name' => 'addonName', 'in' => 'query', - 'schema' => [ - 'title' => '聚合任务组状态，“Running” 或者 “Stopped”。默认 Running', - 'description' => 'Status of the aggregation task group, either \'Running\' or \'Stopped\'. Default is Running.', - 'type' => 'string', - 'required' => false, - 'example' => 'Running', - 'enum' => [ - 'Running', - 'Stopped', - ], - ], + 'schema' => ['description' => 'The addon name.', 'type' => 'string', 'required' => false, 'example' => 'cs-default', 'title' => ''], ], [ - 'name' => 'targetPrometheusId', + 'name' => 'filterRegionIds', 'in' => 'query', - 'schema' => [ - 'title' => '聚合任务组的目标 Prometheus 实例 id', - 'description' => 'The target Prometheus instance ID for the aggregation task group.', - 'type' => 'string', - 'required' => false, - 'example' => 'rw-pq4apob9jm', - ], + 'schema' => ['description' => 'The region IDs used for filtering, separated by commas.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing,cn-hangzhou', 'title' => ''], ], [ - 'name' => 'tags', + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-xxxxx', 'title' => ''], + ], + [ + 'name' => 'tag', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '资源组标签'."\n" - ."\n", - 'description' => 'Resource group tags.', + 'description' => 'The tags.', 'type' => 'array', 'items' => [ - 'description' => 'Resource group tags.', + 'description' => 'The tags in JSON format.', 'type' => 'object', 'properties' => [ - 'key' => [ - 'title' => '资源组标签的键'."\n" - ."\n", - 'description' => 'Key of the resource group tag.', - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], - 'value' => [ - 'title' => '资源组标签的值'."\n" - ."\n", - 'description' => 'Value of the resource group tag.', - 'type' => 'string', - 'required' => false, - 'example' => 'value1', - ], + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'value', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token used to retrieve more results. You do not need to specify this parameter for the first request. Use the token returned from the previous query for subsequent requests.', 'type' => 'string', 'required' => false, 'example' => 'mvnX6zqg3P', 'title' => ''], + ], + [ 'name' => 'maxResults', 'in' => 'query', - 'schema' => [ - 'title' => '返回的最多记录数', - 'description' => 'Maximum number of records to return.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '20', - 'default' => '20', - ], + 'schema' => ['description' => 'The maximum number of results to return. Default value: 30. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ - 'name' => 'nextToken', + 'name' => 'entityGroupIds', 'in' => 'query', - 'schema' => [ - 'title' => '查询令牌', - 'description' => 'Query token.', - 'type' => 'string', - 'required' => false, - 'example' => '28036394xxx', - 'maxLength' => 128, - ], + 'schema' => ['description' => 'The entity IDs used for filtering, separated by commas.', 'type' => 'string', 'required' => false, 'example' => 'eg-1,eg-2,eg-3', 'title' => ''], + ], + [ + 'name' => 'workspace', + 'in' => 'query', + 'schema' => ['description' => 'The workspace.', 'type' => 'string', 'required' => false, 'example' => 'demo', 'title' => ''], ], [ 'name' => 'query', 'in' => 'query', - 'schema' => [ - 'title' => '名称搜索，支持模糊匹配', - 'description' => 'Name search, supports fuzzy matching.', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The keyword used for general queries.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'prometheusInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'cmee-622d27c2e87d49debceeebc7c642610e', 'title' => ''], + ], + [ + 'name' => 'bindResourceId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the bound resource.', 'type' => 'string', 'required' => false, 'example' => '622d27c2e87d49debceeebc7c642610e'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '出参结构体', - 'description' => 'Output structure.', 'type' => 'object', 'properties' => [ - 'aggTaskGroups' => [ - 'title' => '聚合任务组列表', - 'description' => 'List of aggregation task groups.', + 'maxResults' => ['description' => 'The page size.'."\n" + .'Default value:'."\n" + .' 50'."\n" + .'Maximum value:'."\n" + .' 50.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'nextToken' => ['description' => 'The pagination token.', 'type' => 'string', 'example' => '44ANBjKZmQeKnaB1fXRq06w7sFYK3MUcCALMD9qQbmEiE', 'title' => ''], + 'policies' => [ + 'description' => 'The list of access policies.', 'type' => 'array', 'items' => [ - 'description' => 'Aggregation task.', + 'description' => 'The access policy.', 'type' => 'object', 'properties' => [ - 'aggTaskGroupConfigHash' => [ - 'title' => '聚合任务组配置的摘要'."\n" - ."\n", - 'description' => 'Hash of the aggregation task group configuration.', - 'type' => 'string', - 'example' => 'a54136014xxx', - ], - 'aggTaskGroupId' => [ - 'title' => '聚合任务组 id'."\n" - ."\n", - 'description' => 'ID of the aggregation task group.', - 'type' => 'string', - 'example' => 'aggTaskGroup-xxxx', - ], - 'aggTaskGroupName' => [ - 'title' => '聚合任务组名称'."\n" - ."\n", - 'description' => 'Name of the aggregation task group.', - 'type' => 'string', - 'example' => 'pipeline-aggtask-group', - ], - 'cronExpr' => [ - 'title' => '调度模式选择“Cron”情况下，聚合任务组的调度表达式', - 'description' => 'Cron expression for the aggregation task group when the scheduling mode is set to \'Cron\'.', - 'type' => 'string', - 'example' => '0 10 8 1 * ? *', - ], - 'delay' => [ - 'title' => '调度的固定延迟时间'."\n" - ."\n", - 'description' => 'Fixed delay time (in seconds) for scheduling.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'description' => [ - 'title' => '聚合任务组描述'."\n" - ."\n", - 'description' => 'Description of the aggregation task group.', - 'type' => 'string', - 'example' => 'workspace api monitor update test', - ], - 'fromTime' => [ - 'title' => '调度开始时间对应的的秒级时间戳', - 'description' => 'Start time of the schedule in seconds since epoch.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1757409499000', - ], - 'interval' => [ - 'title' => '调度间隔', - 'description' => 'Scheduling interval.', - 'type' => 'string', - 'example' => '2025-04-24 00:00:00,2025-04-24 00:00:00', - ], - 'maxRetries' => [ - 'title' => '执行聚合任务的最大重试次数'."\n" - ."\n", - 'description' => 'Maximum number of retries for the aggregation task.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'maxRunTimeInSeconds' => [ - 'title' => '执行聚合任务的最大重试时间'."\n" - ."\n", - 'description' => 'Maximum retry time (in seconds) for the aggregation task.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'bindResource' => [ + 'description' => 'The bound resource information.', + 'type' => 'object', + 'properties' => [ + 'clusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'cv68tt87d78vyc89zy9v', 'title' => ''], + 'clusterType' => ['description' => 'The cluster type.', 'type' => 'string', 'example' => 'ManagedKubernetes', 'title' => ''], + 'vpcCidr' => ['description' => 'The VPC CIDR block.', 'type' => 'string', 'example' => '100.100.0.1/16', 'title' => ''], + 'vpcId' => ['description' => 'The virtual private cloud (VPC) ID.', 'type' => 'string', 'example' => 'vpc-uf664nyle5khp5d4d7hdo', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'regionId' => [ - 'title' => '地域 id'."\n" - ."\n", - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-hangzhou', + 'entityGroup' => [ + 'description' => 'The entity group.', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'entityGroupId' => ['description' => 'The entity group ID.', 'type' => 'string', 'example' => 'eg-b79f65d11fb94e779867cf937c3a3002', 'title' => ''], + 'entityGroupName' => ['description' => 'The entity group name.', 'type' => 'string', 'example' => 'test-eg', 'title' => ''], + 'entityRules' => [ + 'description' => 'The entity group.', + 'type' => 'object', + 'properties' => [ + 'annotations' => [ + 'description' => 'The annotations.', + 'type' => 'array', + 'items' => [ + 'description' => 'The annotations.', + 'type' => 'object', + 'properties' => [ + 'op' => ['description' => 'The operation to perform.', 'type' => 'string', 'example' => 'add', 'title' => ''], + 'tagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'key', 'title' => ''], + 'tagValues' => [ + 'description' => 'The tag values.', + 'type' => 'array', + 'items' => ['description' => 'The tag values.', 'type' => 'string', 'example' => 'value', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'entityTypes' => [ + 'description' => 'The list of entity types.', + 'type' => 'array', + 'items' => ['description' => 'The entity type.', 'type' => 'string', 'example' => 'ECS', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'fieldRules' => [ + 'description' => 'The field rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The field rules.', + 'type' => 'object', + 'properties' => [ + 'fieldKey' => ['description' => 'The unique identifier of the field.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'fieldValues' => [ + 'description' => 'The field values. Multiple values are separated by commas.', + 'type' => 'array', + 'items' => ['description' => 'The field values. Multiple values are separated by commas.', 'type' => 'string', 'example' => 'field1,fieled2', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'op' => ['description' => 'The operation to perform.', 'type' => 'string', 'example' => 'add', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'instanceIds' => [ + 'description' => 'The instance IDs.', + 'type' => 'array', + 'items' => ['description' => 'The instance IDs.', 'type' => 'string', 'example' => '6fq8fvvcb,owqeq789r', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ipMatchRule' => [ + 'description' => 'The IP match rule.', + 'type' => 'object', + 'properties' => [ + 'ipCidr' => ['description' => 'The IP CIDR block.', 'type' => 'string', 'example' => '100.100.1.0/16', 'title' => ''], + 'ipFieldKey' => ['description' => 'The key of the IP field.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'labels' => [ + 'description' => 'The labels.', + 'type' => 'array', + 'items' => [ + 'description' => 'The label value.', + 'type' => 'object', + 'properties' => [ + 'op' => ['description' => 'The operation to perform.', 'type' => 'string', 'example' => 'add', 'title' => ''], + 'tagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'tagValues' => [ + 'description' => 'The tag values.', + 'type' => 'array', + 'items' => ['description' => 'The tag values.', 'type' => 'string', 'example' => 'value1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'regionIds' => [ + 'description' => 'The list of region IDs.', + 'type' => 'array', + 'items' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing,cn-hangzhou', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-5i6dbwxfxuqihk7k', 'title' => ''], + 'tags' => [ + 'description' => 'The tag information of the instance.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag value.', + 'type' => 'object', + 'properties' => [ + 'op' => ['description' => 'The operation to perform.', 'type' => 'string', 'example' => 'add', 'title' => ''], + 'tagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'key', 'title' => ''], + 'tagValues' => [ + 'description' => 'The tag values.', + 'type' => 'array', + 'items' => ['description' => 'The tag values.', 'type' => 'string', 'example' => 'value1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'query' => ['description' => 'The search keyword. Document library names and descriptions are supported.', 'type' => 'string', 'example' => 'Haval', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-heyuan', 'title' => ''], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '1236812738', 'title' => ''], + 'workspace' => ['description' => 'The workspace.', 'type' => 'string', 'example' => 'test-api', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'scheduleMode' => [ - 'title' => '调度模式'."\n" - ."\n", - 'description' => 'Scheduling mode.', - 'type' => 'string', - 'example' => 'FixedRate', + 'managedInfo' => [ + 'description' => 'The policy network management information.', + 'type' => 'object', + 'properties' => [ + 'securityGroupId' => ['description' => 'The security group ID.', 'type' => 'string', 'example' => 'sg-xxxxx', 'title' => ''], + 'vswitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-xxxxxx', 'title' => ''], + 'eniId' => ['title' => '', 'description' => 'The ENI ID of the managed probe. Example: eni-xxxx.', 'type' => 'string', 'example' => 'eni-12345678'], + ], + 'title' => '', + 'example' => '', ], - 'scheduleTimeExpr' => [ - 'title' => '调度时间表达式'."\n" - ."\n", - 'description' => 'Scheduling time expression.', + 'policyId' => ['description' => 'The policy ID.', 'type' => 'string', 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e', 'title' => ''], + 'policyName' => ['description' => 'The rule name.', 'type' => 'string', 'example' => '6f5HSsg3AP', 'title' => ''], + 'policyType' => ['description' => 'The access center policy type.', 'type' => 'string', 'example' => 'ECS', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-heyuan', 'title' => ''], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-xxxxx', 'title' => ''], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '128470923', 'title' => ''], + 'workspace' => ['description' => 'The workspace.', 'type' => 'string', 'example' => 'test-api', 'title' => ''], + 'feePackage' => [ + 'description' => 'The billing type.', + 'enumValueTitles' => ['CS_Pro' => 'CS_Pro', 'CS_Basic' => 'CS_Basic'], 'type' => 'string', - 'example' => '@m', + 'example' => 'CS_Pro', + 'title' => '', ], - 'sourcePrometheusId' => [ - 'title' => '聚合任务组的源 Prometheus 实例 id', - 'description' => 'The source Prometheus instance ID of the aggregation task group.', - 'type' => 'string', - 'example' => 'rw-xxx', + 'subAddonRelease' => [ + 'description' => 'The number of sub-releases.', + 'type' => 'object', + 'properties' => [ + 'total' => ['description' => 'The total number of rules.', 'type' => 'integer', 'format' => 'int32', 'example' => '278', 'title' => ''], + 'ready' => ['description' => 'The number of ready sub-releases.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'status' => [ - 'title' => '聚合任务组状态'."\n" - ."\n", - 'description' => 'Status of the aggregation task group.', - 'type' => 'string', - 'example' => 'Running', + 'csUmodelStatus' => ['description' => 'The umodel installation status in the container environment.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5'], + 'totalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query access center policy list', + 'summary' => 'Queries the list of access center policies.', + 'description' => 'Queries the integration list.', + 'changeSet' => [ + ['createdAt' => '2025-10-30T12:36:57.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-10-30T11:46:59.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-10-15T12:10:46.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-10-14T08:04:01.000Z', 'description' => 'Response parameters changed'], + ], + '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' => 'All Resource', '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' => 'Lists the add-ons that are installed for a specified policy.', + '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' => ['description' => 'The ID of the environment.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'policy-3563e6bf338141b3b92c118e2c318c37'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'addons' => [ + 'description' => 'A list of add-ons.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the add-on.', + 'type' => 'object', + 'properties' => [ + 'alias' => ['description' => 'The display name.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], + 'categories' => [ + 'description' => 'The categories.', + 'type' => 'array', + 'items' => ['description' => 'A category.', 'type' => 'string', 'example' => 'database', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'targetPrometheusId' => [ - 'title' => '聚合任务组的目标 Prometheus 实例 id', - 'description' => 'The target Prometheus instance ID of the aggregation task group.', - 'type' => 'string', - 'example' => 'rw-xxx', + 'dashboards' => [ + 'description' => 'A list of dashboards.', + 'type' => 'array', + 'items' => [ + 'description' => 'A dashboard.', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => '用于mysql的监控大盘', 'title' => ''], + 'name' => ['description' => 'The name.', 'type' => 'string', 'example' => 'MySQL Overview', 'title' => ''], + 'url' => ['description' => 'The URL of the dashboard.', 'type' => 'string', 'example' => 'http://xxxxxxx', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'toTime' => [ - 'title' => '调度结束时间对应的秒级时间戳'."\n" - ."\n", - 'description' => 'The second-level timestamp corresponding to the end time of scheduling.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'Observability integration.', 'title' => ''], + 'environments' => [ + 'description' => 'A list of supported environments.', + 'type' => 'array', + 'items' => [ + 'description' => 'The environment context.', + 'type' => 'object', + 'properties' => [ + 'dependencies' => [ + 'description' => 'The dependencies.', + 'type' => 'object', + 'properties' => [ + 'clusterTypes' => [ + 'description' => 'The dependencies on cluster types.', + 'type' => 'array', + 'items' => ['description' => 'The cluster type.', 'type' => 'string', 'example' => 'ACK', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'features' => [ + 'description' => 'The dependencies on probes.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The metric agent.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'services' => [ + 'description' => 'The dependencies on product codes.', + 'type' => 'array', + 'items' => ['description' => 'The service name.', 'type' => 'string', 'example' => 'Prometheus', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'o11y-demo-cn-heyuan', 'title' => ''], + 'enable' => ['description' => 'Indicates whether the feature is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'label' => ['description' => 'The display name of the environment.', 'type' => 'string', 'example' => 'Cloud', 'title' => ''], + 'name' => ['description' => 'The name of the environment.', 'type' => 'string', 'example' => 'Cloud', 'title' => ''], + 'policies' => [ + 'description' => 'The policy.', + 'type' => 'object', + 'properties' => [ + 'alertDefaultStatus' => ['description' => 'The default status of the alert rule policy.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], + 'defaultInstall' => ['description' => 'Indicates whether the add-on is installed by default.', 'type' => 'boolean', 'example' => 'true'."\n", 'title' => ''], + 'enableServiceAccount' => ['description' => 'Indicates whether to assign a Service Account for communication with the console API.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'metricCheckRule' => [ + 'description' => 'The metric check rule.', + 'type' => 'object', + 'properties' => [ + 'promQl' => [ + 'description' => 'The PromQL search statements.', + 'type' => 'array', + 'items' => ['description' => 'A PromQL search statement.', 'type' => 'string', 'example' => 'up{job="mysql"} > 0', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'needRestartAfterIntegration' => ['description' => 'Indicates whether a pod restart is required after the add-on is installed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'protocols' => [ + 'description' => 'The protocols.', + 'type' => 'array', + 'items' => [ + 'description' => 'A protocol.', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'icon' => ['description' => 'The icon.', 'type' => 'string', 'example' => ' https://img.alixxxx', 'title' => ''], + 'label' => ['description' => 'The display name.', 'type' => 'string', 'example' => 'Golang', 'title' => ''], + 'name' => ['description' => 'The protocol name.', 'type' => 'string', 'example' => 'golang', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'targetAddonName' => ['description' => 'The name of the target add-on.', 'type' => 'string', 'example' => 'mysql', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'updateTime' => [ - 'title' => '聚合任务组的更新时间'."\n" - ."\n", - 'description' => 'Update time of the aggregation task group.', - 'type' => 'string', - 'example' => '1757409499000', + 'icon' => ['description' => 'The icon of the add-on.', 'type' => 'string', 'example' => 'asert/mysql.svg', 'title' => ''], + 'keywords' => [ + 'description' => 'The keywords.', + 'type' => 'array', + 'items' => ['description' => 'A keyword.', 'type' => 'string', 'example' => 'container', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'language' => ['description' => 'The language.', 'type' => 'string', 'example' => 'zh', 'title' => ''], + 'latestReleaseCreateTime' => ['description' => 'The time when the latest version was created.', 'type' => 'string', 'example' => '2025-09-03T03:15:56Z', 'title' => ''], + 'name' => ['description' => 'The name of the add-on.', 'type' => 'string', 'example' => 'mysql', 'title' => ''], + 'once' => ['description' => 'Indicates whether the add-on can be installed only once.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'scene' => ['description' => 'The scenario of the add-on.', 'type' => 'string', 'example' => 'container', 'title' => ''], + 'version' => ['description' => 'The version of the add-on.', 'type' => 'string', 'example' => '0.1.1', 'title' => ''], + 'weight' => ['description' => 'The weight.', 'type' => 'integer', 'format' => 'int32', 'example' => '99', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'maxResults' => [ - 'title' => '返回的最多记录数', - 'description' => 'The maximum number of records returned.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - 'default' => '0', - ], - 'nextToken' => [ - 'title' => '下一次查询的令牌', - 'description' => 'Token for the next query.', - 'type' => 'string', - 'example' => 'aa9d0e569b880xxx', - 'maxLength' => 128, - ], - 'requestId' => [ - 'title' => '请求 id'."\n" - ."\n", - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '7BF1F4D6-B9A8-5F0B-8C1D-4347FFCB798E', - ], - 'totalCount' => [ - 'title' => '总实例数', - 'description' => 'Total number of instances.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '7E00EF90-CEF9-57C9-9AE9-5AA937D37C03'], + 'total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - 'title' => 'List Aggregation Task Groups', - 'translator' => 'machine', - ], - 'DeletePrometheusInstance' => [ - 'summary' => 'Delete prom instance', - 'path' => '/prometheus-instances/{prometheusInstanceId}', - 'methods' => [ - 'delete', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListIntegrationPolicyAddons', + 'description' => 'Lists the add-ons that are installed for a specified policy.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'cms:ListIntegrationPolicyAddons', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'integrationPolicy', 'arn' => 'acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#integrationPolicyId}'], + ], + ], + ], ], + '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"}]', + ], + 'ListIntegrationPolicyCollectors' => [ + 'summary' => 'Returns information about collectors for an Integration Center policy.', + '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' => 'Instance ID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rw-abc123', - ], + 'schema' => ['description' => 'The ID of the Integration Center policy.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'env-d95435164593aece55f9999ce45c'], + ], + [ + 'name' => 'addonReleaseName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the add-on release.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'release-1234567'], + ], + [ + 'name' => 'collectorType', + 'in' => 'query', + 'schema' => ['description' => 'The collector type.', 'type' => 'string', 'required' => true, 'example' => 'Exporter', 'title' => ''], + ], + [ + 'name' => 'language', + 'in' => 'query', + 'schema' => ['description' => 'The language.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Response Schema', + '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' => 'The list of collectors.', + 'type' => 'array', + 'items' => [ + 'description' => 'The collector information.', + 'type' => 'object', + 'properties' => [ + 'collectorName' => ['description' => 'The collector name.', 'type' => 'string', 'example' => 'collector-kkxx', 'title' => ''], + 'collectorType' => ['description' => 'The collector type.', 'type' => 'string', 'example' => 'Exporter', 'title' => ''], + 'conditions' => [ + 'description' => 'The phase status.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details.', + 'type' => 'object', + 'properties' => [ + 'firstTransitionTime' => ['description' => 'The time of the first transition.', 'type' => 'string', 'example' => '2024-08-27T13:59:23+08:00', 'title' => ''], + 'lastTransitionTime' => ['description' => 'The time of the last transition.', 'type' => 'string', 'example' => '2024-08-27T13:59:23+08:00', 'title' => ''], + 'message' => ['description' => 'The details.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'reason' => ['description' => 'The reason for the failure.', 'type' => 'string', 'example' => 'Probe', 'title' => ''], + 'status' => ['description' => 'The phase status.', 'type' => 'string', 'example' => 'True', 'title' => ''], + 'type' => ['description' => 'The phase type.', 'type' => 'string', 'example' => 'Ready', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'managed' => ['description' => 'Indicates whether the component is a managed component.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'state' => ['description' => 'The collector status.', 'type' => 'string', 'example' => 'xx', 'title' => ''], + 'version' => ['description' => 'The component version.', 'type' => 'string', 'example' => '2.6.2', 'title' => ''], + 'workloads' => [ + 'description' => 'The list of workloads.', + 'type' => 'array', + 'items' => [ + 'description' => 'The workload details.', + 'type' => 'object', + 'properties' => [ + 'hostIp' => ['description' => 'The host IP address.', 'type' => 'string', 'example' => '10.10.10.10', 'title' => ''], + 'ip' => ['description' => 'The IP address of the workload.', 'type' => 'string', 'example' => '11.193.82.198', 'title' => ''], + 'managed' => ['description' => 'Indicates whether the component is a managed component.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'managedInfo' => [ + 'description' => 'The policy management information.', + 'type' => 'object', + 'properties' => [ + 'securityGroupId' => ['description' => 'The security group ID.', 'type' => 'string', 'example' => 'sg-xxxxx', 'title' => ''], + 'vswitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-xxxxxx', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'message' => ['description' => 'The details.', 'type' => 'string', 'example' => 'ok', 'title' => ''], + 'name' => ['description' => 'The workload name.', 'type' => 'string', 'example' => 'exporter-xxx', 'title' => ''], + 'namespace' => ['description' => 'The workload namespace.', 'type' => 'string', 'example' => 'prod-db', 'title' => ''], + 'ownerReferenceKind' => ['description' => 'The kind of the parent reference.', 'type' => 'string', 'example' => 'Deployment', 'title' => ''], + 'ownerReferenceName' => ['description' => 'The name of the parent reference.', 'type' => 'string', 'example' => 'exporter', 'title' => ''], + 'startTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2024-08-27T13:59:23+08:00', 'title' => ''], + 'status' => ['description' => 'The status.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'version' => ['description' => 'The workload version.', 'type' => 'string', 'example' => 'v2.4.4', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'releaseName' => ['description' => 'The name of the add-on release.', 'type' => 'string', 'example' => 'ecs-loong-collector-i-f8z1176fg57rlwmc1rfi', 'title' => ''], + 'addonMeta' => ['description' => 'The add-on details.', '$ref' => '#/components/schemas/AddonMeta', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', - 'title' => 'Delete Prometheus Instance', - 'description' => 'Delete a Prometheus instance.', - 'translator' => 'machine', - ], - 'DeletePrometheusView' => [ - 'summary' => 'Delete prometheus view instance', - 'path' => '/prometheus-views/{prometheusViewId}', - 'methods' => [ - 'delete', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListIntegrationPolicyCollectors', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'cms:ListIntegrationPolicyCollectors', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'IntegrationPolicy', 'arn' => 'acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#integrationPolicyId}'], + ], + ], + ], ], + '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"}]', + ], + 'ListIntegrationPolicyCustomScrapeJobRules' => [ + 'summary' => 'Lists the custom service discovery rules for an Integration Center policy.', + '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 view ID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rw-xxxxxx', - ], + 'schema' => ['title' => '接入中心策略ID。', 'description' => 'The ID of the Integration Center policy.', 'type' => 'string', 'required' => true, 'example' => 'policy-d95435164593aece55f9999ce45c'], + ], + [ + 'name' => 'addonReleaseName', + 'in' => 'query', + 'schema' => ['title' => 'Addon Release名称。', 'description' => 'The name of the add-on release.', 'type' => 'string', 'required' => false, 'example' => 'release12345678'], + ], + [ + 'name' => 'encryptYaml', + 'in' => 'query', + 'schema' => ['title' => '是否加密Yaml。', 'description' => 'Specifies whether to encrypt the YAML file.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'namespace', + 'in' => 'query', + 'schema' => ['title' => '命名空间。', 'description' => 'The namespace.', 'type' => 'string', 'required' => false, 'example' => 'arms-prom'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of response', + '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' => 'The cluster ID.', 'type' => 'string', 'title' => '', 'example' => 'et15prod-et15storage'], + 'customScrapeJobRules' => [ + 'description' => 'The custom scrape job rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The custom service discovery rules.', + 'type' => 'object', + 'properties' => [ + 'addonName' => ['description' => 'The add-on name.', 'type' => 'string', 'title' => '', 'example' => 'cloud-ecs'], + 'addonReleaseName' => ['description' => 'The name of the add-on release.', 'type' => 'string', 'title' => '', 'example' => 'release-12345678'], + 'addonVersion' => ['description' => 'The add-on version.', 'type' => 'string', 'title' => '', 'example' => '0.0.1'], + 'configYaml' => ['description' => 'The configuration YAML file.', 'type' => 'string', 'title' => '', 'example' => 'scrape_cofnigs:'."\n" + .'- jobxxxxxx'], + 'enableStatus' => ['description' => 'The enabled status.', 'type' => 'string', 'title' => '', 'example' => 'mini'], + 'encryptYaml' => ['description' => 'Indicates whether the YAML file is encrypted.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'matchedPodCount' => ['description' => 'The number of matched pods.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'message' => ['description' => 'The details.', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'name' => ['description' => 'The service name.', 'type' => 'string', 'title' => '', 'example' => 'dlab1'], + 'namespace' => ['description' => 'The namespace.', 'type' => 'string', 'title' => '', 'example' => 'prod-data'], + 'scrapeConfigs' => [ + 'description' => 'The custom configurations.', + 'type' => 'array', + 'items' => [ + 'description' => 'The custom configuration.', + 'type' => 'object', + 'properties' => [ + 'jobName' => ['description' => 'The scrape job name.', 'type' => 'string', 'title' => '', 'example' => 'mysql-exporter'], + 'message' => ['description' => 'The details.', 'type' => 'string', 'title' => '', 'example' => 'successful'], + 'metricsPath' => ['description' => 'The scrape path.', 'type' => 'string', 'title' => '', 'example' => '/metrics'], + 'scheme' => ['description' => 'The invocation method.', 'type' => 'string', 'title' => '', 'example' => 'http'], + 'scrapeInterval' => ['description' => 'The scrape interval.', 'type' => 'string', 'title' => '', 'example' => '30s'], + 'scrapeTimeout' => ['description' => 'The scrape timeout period.', 'type' => 'string', 'title' => '', 'example' => '60s'], + 'serviceDiscoveryConfigs' => [ + 'description' => 'The service discovery configurations.', + 'type' => 'array', + 'items' => ['description' => 'The service discovery configuration.', 'type' => 'string', 'title' => '', 'example' => '{}'], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'policyId' => ['description' => 'The policy ID.', 'type' => 'string', 'title' => '', 'example' => 'policy-15abcc24c06f4797832b5954198e1ed1'], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', - 'title' => 'Delete prometheus view instance.', - 'description' => 'Delete prometheus view instance.', - 'translator' => 'machine', - ], - 'GetPrometheusInstance' => [ - 'summary' => 'Query the instance in a specified environment', - 'path' => '/prometheus-instances/{prometheusInstanceId}', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + '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' => 'Get Custom Service Discovery Rules for Access Center Policy', + '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}'], + ], + ], + ], ], + ], + 'ListIntegrationPolicyDashboards' => [ + 'summary' => 'Queries a list of integration policy dashboards.', + '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' => 'Instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'rw-abc123', - ], + 'schema' => ['description' => 'The policy ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e'], ], [ - 'name' => 'resourceGroupId', + 'name' => 'addonName', 'in' => 'query', - 'schema' => [ - 'description' => 'Resource group ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aek2bhocin5e2na', - ], + 'schema' => ['description' => 'The add-on name.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cs-default'], ], [ - 'name' => 'aliyunLang', + 'name' => 'scene', + 'in' => 'query', + 'schema' => ['description' => 'The component scenario.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'databse'], + ], + [ + 'name' => 'language', 'in' => 'query', 'schema' => [ - 'title' => '语言环境, 默认为中文 zh | en', - 'description' => 'Language setting, default is Chinese zh | en', + 'title' => '', + 'description' => 'The query language.', 'type' => 'string', 'required' => false, - 'example' => 'zh', 'default' => 'zh', + 'enum' => ['zh', 'en'], + 'example' => 'zh', ], ], ], @@ -17481,653 +16317,332 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'prometheusInstance' => [ - 'description' => 'Details of the Prometheus instance.', - 'type' => 'object', - 'properties' => [ - 'accessType' => [ - 'title' => '权限类型：'."\n" - .'readWrite、readOnly、httpReadOnly', - 'description' => 'Access type:'."\n" - .'readWrite, readOnly, httpReadOnly', - 'type' => 'string', - 'example' => 'readOnly', - ], - 'archiveDuration' => [ - 'title' => '存储到期后，自动归档保存的天数，0表示不归档保存，3650表示永久保存。', - 'description' => 'Number of days to automatically archive and save after storage expiration. 0 means no archiving, 3650 means permanent saving.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '90', - ], - 'authFreeReadPolicy' => [ - 'title' => '读免密地址白名单策略。', - 'description' => 'Password-free read policy (supports IP segments and 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' => 'Password-free write policy (supports IP segments and 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 string.', - 'type' => 'string', - 'example' => 'eJwixxxxx', - ], - 'createTime' => [ - 'title' => '实例创建时间，使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ', - 'description' => 'Instance creation time, using UTC+0, formatted as yyyy-MM-ddTHH:mmZ.', - 'type' => 'string', - 'example' => '2025-08-10T02:07:53Z', - ], - 'enableAuthFreeRead' => [ - 'title' => '是否开启读免密。', - 'description' => 'Whether to enable password-free reading.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'enableAuthFreeWrite' => [ - 'title' => '是否开启写免密。', - 'description' => 'Whether to enable password-free writing.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'enableAuthToken' => [ - 'description' => 'Whether to enable authentication token.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'extraInfo' => [ - 'title' => '扩展信息（仅控制台请求才返回）', - 'description' => 'Additional information.', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'Other additional information.', - 'example' => 'value', - ], - ], - 'httpApiInterUrl' => [ - 'description' => 'HTTP public network address.', - 'type' => 'string', - 'example' => ' http://workspace-default-cms-xxxxxxx', - ], - 'httpApiIntraUrl' => [ - 'description' => 'HTTP intranet address.', - 'type' => 'string', - 'example' => ' http://workspace-default-cms-xxxxxxx', - ], - 'instanceType' => [ - 'title' => 'remote-write（Prometheus for Remote Write）', - 'description' => 'Prometheus instance type.', - 'type' => 'string', - 'example' => 'remote-write', - ], - 'paymentType' => [ - 'title' => '计费方式：'."\n" - .'POSTPAY：按指标上报量后付费。'."\n" - .'POSTPAY_GB：按指标写入量后付费。', - 'description' => 'Billing method:'."\n" - .'POSTPAY: Pay-as-you-go based on metric reporting volume.'."\n" - .'POSTPAY_GB: Pay-as-you-go based on metric write volume.', - 'type' => 'string', - 'example' => 'POSTPAY', - ], - 'product' => [ - 'title' => 'prom实例归属的产品（arms或cms）', - 'description' => 'The product to which the Prometheus instance belongs (arms or cms).', - 'type' => 'string', - 'example' => 'cms', - ], - 'prometheusInstanceId' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'example' => 'rw-524ada714221af267c73122af2e1', - ], - 'prometheusInstanceName' => [ - 'description' => 'Instance name.', - 'type' => 'string', - 'example' => 'test-prom-name', - ], - 'pushGatewayInterUrl' => [ - 'description' => 'Public network address of PushGateway.', - 'type' => 'string', - 'example' => ' http://workspace-default-cms-xxxxxxx', - ], - 'pushGatewayIntraUrl' => [ - 'description' => 'Intranet address of PushGateway.', - 'type' => 'string', - 'example' => ' http://workspace-default-cms-xxxxxxx'."\n", - ], - 'regionId' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-heyuan', - ], - 'remoteReadInterUrl' => [ - 'description' => 'Public network read address.', - 'type' => 'string', - 'example' => ' http://workspace-default-cms-xxxxxxx', - ], - 'remoteReadIntraUrl' => [ - 'description' => 'Intranet read address.', - 'type' => 'string', - 'example' => 'https://workspace-default-cms-1xxxxxxxxxx', - ], - 'remoteWriteInterUrl' => [ - 'description' => 'Public network write address.', - 'type' => 'string', - 'example' => 'https://workspace-default-cms-xxxxxxxxxx', - ], - 'remoteWriteIntraUrl' => [ - 'description' => 'Intranet write address.', - 'type' => 'string', - 'example' => 'https://workspace-default-cms-xxxxxxxxxx', - ], - 'resourceGroupId' => [ - 'description' => 'Resource group ID.', - 'type' => 'string', - 'example' => 'rg-acfm3gn5i6bigbi', - ], - 'resourceType' => [ - 'title' => '固定值：PrometheusInstance', - 'description' => 'Fixed value: PrometheusInstance.', - 'type' => 'string', - 'example' => 'Prometheus', - ], - 'status' => [ - 'title' => '后端数据存储状态', - 'description' => 'Instance status.', - 'type' => 'string', - 'example' => 'Running', - ], - 'storageDuration' => [ - 'title' => '存储时长（天）。', - 'description' => 'Storage duration (in days).', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '90', - ], - 'supportAuthTypes' => [ - 'title' => '支持的认证鉴权类型。', - 'description' => 'Supported authentication types.', - 'type' => 'array', - 'items' => [ - 'description' => 'Authentication type.', - 'type' => 'string', - 'example' => 'BasicAuth', - 'enum' => [ - 'BasicAuth', - 'AuthFree', - 'AuthToken', - ], - ], - ], - 'tags' => [ - 'description' => 'List of tags.', - 'type' => 'array', - 'items' => [ - 'description' => 'Tag.', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => 'Tag key.', - 'type' => 'string', - 'example' => 'openStorage', - ], - 'value' => [ - 'description' => 'Matched value.', - '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' => 'The number of components.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'dashboards' => [ + 'description' => 'The list of dashboards.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of dashboards.', + 'type' => 'object', + 'properties' => [ + 'uid' => ['description' => 'The ID of the current Alibaba Cloud account. This parameter is read-only.', 'type' => 'string', 'title' => '', 'example' => '1258199346721590'], + 'engine' => ['title' => '大盘引擎：'."\n" + .'grafana：共享grafana。'."\n" + .'cms：cms自研大盘引擎。', 'description' => 'The dashboard engine. Valid values:'."\n" + .'grafana: shared Grafana.'."\n" + .'cms: the self-developed dashboard engine of CloudMonitor.', 'type' => 'string', 'example' => 'grafana'], + 'title' => ['description' => 'The title of the UI module. This is different from the name parameter.', 'type' => 'string', 'title' => '', 'example' => 'test'], + 'name' => ['title' => '大盘名称', 'description' => 'The dashboard name.', 'type' => 'string', 'example' => 'k8s-pod'], + 'url' => ['description' => 'The webhook URL for PagerDuty integration. V1 and V2 are supported.', 'type' => 'string', 'title' => '', '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' => 'The region.', 'type' => 'string', 'title' => '', 'example' => 'cn-hongkong'], + 'folderUid' => ['description' => 'The UID of the dashboard folder.', 'type' => 'string', 'title' => '', 'example' => 'Env-AAA'], + 'tags' => [ + 'description' => 'The list of tags.', + 'type' => 'array', + 'items' => ['description' => 'A tag.', 'type' => 'string', 'title' => '', 'example' => 'tag1'], + 'title' => '', + 'example' => '', ], ], - 'userId' => [ - 'description' => 'User ID.', - 'type' => 'string', - 'example' => '170731234567', - ], - 'version' => [ - 'title' => '版本', - 'description' => 'Version.', - 'type' => 'string', - 'example' => 'V1', - ], - 'workspace' => [ - 'title' => 'prom实例归属的工作空间', - 'description' => 'The workspace to which the Prometheus instance belongs.', - 'type' => 'string', - 'example' => 'ws1', - ], - 'folderUrl' => [ - 'title' => '可视化大盘Url', - 'description' => 'URL of the visualization dashboard directory.', - 'type' => 'string', - 'example' => 'https://gnew.console.aliyun.com/dashboards/f/c49a80d2a551d4a20a8c4b996b0be4e52/xxxxxxx', - ], - 'grafanaInstanceId' => [ - 'title' => '绑定的托管grafana实例Id', - 'description' => 'ID of the managed Grafana instance that is bound.', - 'type' => 'string', - 'example' => 'SHARED', - ], - 'grafanaInstanceName' => [ - 'title' => '绑定的托管grafana实例名称', - 'description' => 'Name of the managed Grafana instance that is bound.', - 'type' => 'string', - 'example' => '共享版', - ], - 'paymentTypeUpdateTime' => [ - 'title' => '实例计费方式修改时间', - 'description' => 'Time when the billing method of the instance was updated.', - 'type' => 'string', - 'example' => '2025-08-10T02:07:53Z', - ], + 'title' => '', + 'example' => '', ], - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Unique identifier for the request.', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + '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' => 'Query Dashboard List', + 'description' => 'This topic provides an example of how to query a list of integration policy dashboards.', + 'changeSet' => [ + ['createdAt' => '2025-10-20T14:07:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-10-16T08:11:30.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-10-15T12:10:46.000Z', 'description' => 'Response parameters changed'], ], - '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' => 'Get Prometheus Instance Details', - 'description' => 'Retrieve details of a Prometheus instance.', - 'translator' => 'machine', - ], - 'GetPrometheusView' => [ - 'summary' => 'Query a specified Prometheus view instance', - '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}'], + ], + ], + ], ], + ], + 'ListIntegrationPolicyPodMonitors' => [ + 'summary' => 'Lists the PodMonitor resources for an Integration Center policy.', + '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' => 'Instance ID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rw-xxxxxx', - ], + 'schema' => ['title' => '接入中心策略ID。', 'description' => 'The ID of the Integration Center policy.', 'type' => 'string', 'required' => true, 'example' => 'policy-1d4634924c8ba599822c601fcee3'], ], [ - 'name' => 'resourceGroupId', + 'name' => 'addonReleaseName', 'in' => 'query', - 'schema' => [ - 'description' => 'Resource group ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aek2bhocin5e2na', - ], + 'schema' => ['title' => 'Addon Release名称。', 'description' => 'The name of the add-on release.', 'type' => 'string', 'required' => false, 'example' => 'release-123456789'], ], [ - 'name' => 'aliyunLang', + 'name' => 'namespace', 'in' => 'query', - 'schema' => [ - 'title' => '语言环境, 默认为中文 zh | en', - 'description' => 'Language environment, default is Chinese zh | en', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - 'default' => 'zh', - ], + 'schema' => ['title' => '命名空间。', 'description' => 'The namespace.', 'type' => 'string', 'required' => false, 'example' => 'default'], + ], + [ + 'name' => 'encryptYaml', + 'in' => 'query', + 'schema' => ['title' => '是否加密Yaml。', 'description' => 'Specifies whether to encrypt the YAML file.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'prometheusView' => [ - 'description' => 'View instance.', - 'type' => 'object', - 'properties' => [ - 'authFreeReadPolicy' => [ - 'title' => '读免密地址白名单策略。', - 'description' => 'Password-free read policy (supports IP segments and 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 string.', - 'type' => 'string', - 'example' => 'eJxxxxxx', - ], - 'createTime' => [ - 'title' => '实例创建时间，使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ', - 'description' => 'Instance creation time, using UTC+0 time, format is yyyy-MM-ddTHH:mmZ.', - 'type' => 'string', - 'example' => '2025-08-10T02:07:53Z', - ], - 'enableAuthFreeRead' => [ - 'title' => '是否开启读免密。', - 'description' => 'Whether to enable password-free read.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'enableAuthToken' => [ - 'title' => '是否开启authToken。', - 'description' => 'Whether to enable authToken.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'httpApiInterUrl' => [ - 'description' => 'Public HTTP address.', - 'type' => 'string', - 'example' => 'http://xxxxxxxx', - ], - 'httpApiIntraUrl' => [ - 'description' => 'Private HTTP address.', - 'type' => 'string', - 'example' => 'http://xxxxxxxx', - ], - 'instanceType' => [ - 'title' => '实例类型：'."\n" - .'prom-view：新版本聚合视图'."\n" - .'global-view：老版本聚合视图', - 'description' => 'Instance type, fixed value prom-view.', - 'type' => 'string', - 'example' => 'prom-view', - ], - 'paymentType' => [ - 'title' => '付费类型。目前固定值FREE（免费）。', - 'description' => 'Payment type. Currently, the fixed value is FREE (free).', - 'type' => 'string', - 'example' => 'FREE', - ], - 'product' => [ - 'title' => 'prom实例归属的产品（arms或cms）', - 'description' => 'Product that the prom instance belongs to.', - 'type' => 'string', - 'example' => 'cms', - ], - 'prometheusInstances' => [ - 'description' => 'Prometheus instance list.', - 'type' => 'array', - 'items' => [ - 'description' => 'Prometheus instance list.', - 'type' => 'object', - 'properties' => [ - 'prometheusInstanceId' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'example' => 'rw-63549e054ff596a4149927961dff', - ], - 'regionId' => [ - 'description' => 'Region ID', - 'type' => 'string', - 'example' => 'cn-north-2-gov-1', - ], - 'userId' => [ - 'description' => 'User ID.', - 'type' => 'string', - 'example' => '122xxxxx', + 'clusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'title' => '', 'example' => 'et15prod-et15storage'], + 'podMonitors' => [ + 'description' => 'The list of PodMonitors.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of PodMonitors.', + 'type' => 'object', + 'properties' => [ + 'addonName' => ['description' => 'The name of the add-on.', 'type' => 'string', 'title' => '', 'example' => 'cloud-ecs'], + 'addonReleaseName' => ['description' => 'The name of the add-on release.', 'type' => 'string', 'title' => '', 'example' => 'release-2345678'], + 'addonVersion' => ['description' => 'The version of the add-on.', 'type' => 'string', 'title' => '', 'example' => '0.0.1'], + 'configYaml' => ['description' => 'The YAML configuration.', 'type' => 'string', 'title' => '', 'example' => 'apiVersion: xxxxx'], + 'enableStatus' => ['description' => 'The status.', 'type' => 'string', 'title' => '', 'example' => 'run'], + 'encryptYaml' => ['description' => 'Indicates whether the YAML file is encrypted.', 'type' => 'boolean', 'title' => '', 'example' => 'YXBpVmVyc2lvbjogeHh4eHgK'], + 'endpoints' => [ + 'description' => 'The endpoints of the instance.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the endpoint.', + 'type' => 'object', + 'properties' => [ + 'interval' => ['description' => 'The collection interval.', 'type' => 'string', 'title' => '', 'example' => '30s'], + 'matchedTargetCount' => ['description' => 'The number of matched targets.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'path' => ['description' => 'The metric collection path.', 'type' => 'string', 'title' => '', 'example' => '/metrics'], + 'port' => ['description' => 'The port number.', 'type' => 'string', 'title' => '', 'example' => '9100'], + 'targetPort' => ['description' => 'The target port.', 'type' => 'string', 'title' => '', 'example' => 'https'], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'matchedPodCount' => ['description' => 'The number of matched pods.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '3'], + 'name' => ['description' => 'The collection name.', 'type' => 'string', 'title' => '', 'example' => 'znzmo_entity_test'], + 'namespace' => ['description' => 'The namespace.', 'type' => 'string', 'title' => '', 'example' => 'sla-ns-d5aeb2b4f91b47'], ], - 'prometheusViewId' => [ - 'description' => 'Prometheus view ID.', - 'type' => 'string', - 'example' => 'view-xxx', - ], - 'prometheusViewName' => [ - 'description' => 'Prometheus view name.', - 'type' => 'string', - 'example' => 'view1', - ], - 'regionId' => [ - 'description' => 'Region ID', - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'remoteReadInterUrl' => [ - 'description' => 'Remote read public 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 intranet 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' => 'Resource group ID.', - 'type' => 'string', - 'example' => 'rg-acfm3gn5i6bigbi', - ], - 'resourceType' => [ - 'title' => '固定值：PrometheusView', - 'description' => 'Fixed value: PrometheusView', - 'type' => 'string', - 'example' => 'RegistryModule', - ], - 'status' => [ - 'title' => '后端数据存储状态', - 'description' => 'Backend data storage status', - 'type' => 'string', - 'example' => 'Pending2Running', - ], - 'supportAuthTypes' => [ - 'description' => 'Supported authentication types.', - 'type' => 'array', - 'items' => [ - 'description' => 'Supported authentication types.', - 'type' => 'string', - 'example' => 'BasicAuth', - ], - ], - 'tags' => [ - 'description' => 'Instance tag keys.', - 'type' => 'array', - 'items' => [ - 'description' => 'Tags.', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => 'PagerDuty integration key.', - 'type' => 'string', - 'example' => 'global_score_series', - ], - 'value' => [ - 'description' => 'Tag value.', - 'type' => 'string', - 'example' => '371293199010092839', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'policyId' => ['description' => 'The policy ID.', 'type' => 'string', 'title' => '', 'example' => 'policy-c9efed2b99c348d49e589c5f780fc074'], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5'], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + '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' => 'Query PodMonitor Resources of Access Center Policy', + 'description' => 'This topic provides an example of how to list the PodMonitor resources for an Integration Center policy.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntegrationPolicyPodMonitors'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'cms:ListIntegrationPolicyPodMonitors', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'IntegrationPolicy', 'arn' => 'acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#integrationPolicyId}'], + ], + ], + ], + ], + ], + 'ListIntegrationPolicyServiceMonitors' => [ + 'path' => '/integration-policies/{policyId}/service-monitors', + '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' => '', 'description' => 'The ID of the Integration Center policy.', 'type' => 'string', 'required' => true, 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e'], + ], + [ + 'name' => 'addonReleaseName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the add-on release.', 'type' => 'string', 'required' => false, 'example' => 'release-12345678'], + ], + [ + 'name' => 'namespace', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The namespace.', 'type' => 'string', 'required' => false, 'example' => 'arms-prom'], + ], + [ + 'name' => 'encryptYaml', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to encrypt the YAML file.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response schema.', + 'type' => 'object', + 'properties' => [ + 'clusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'title' => '', 'example' => 'ea119prod-ea119blinkcptssd1'], + 'policyId' => ['description' => 'The policy ID.', 'type' => 'string', 'title' => '', 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e'], + 'serviceMonitors' => [ + 'description' => 'The list of ServiceMonitors.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'addonName' => ['description' => 'The add-on name.', 'type' => 'string', 'title' => '', 'example' => 'cloud-acs-ecs'], + 'addonReleaseName' => ['description' => 'The name of the add-on release.', 'type' => 'string', 'title' => '', 'example' => 'release-1234567'], + 'addonVersion' => ['description' => 'The add-on version.', 'type' => 'string', 'title' => '', 'example' => '0.0.1'], + 'configYaml' => ['description' => 'The configuration YAML file.', 'type' => 'string', 'title' => '', 'example' => 'apiVersion: xxxxx'], + 'enableStatus' => ['description' => 'The status.', 'type' => 'string', 'title' => '', 'example' => 'run'], + 'encryptYaml' => ['description' => 'Indicates whether the YAML file is encrypted.', 'type' => 'boolean', 'title' => '', 'example' => 'YXBpVmVyc2lvbjogeHh4eHgK'], + 'endpoints' => [ + 'description' => 'The list of Endpoints.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of Endpoints.', + 'type' => 'object', + 'properties' => [ + 'interval' => ['description' => 'The collection interval.', 'type' => 'string', 'title' => '', 'example' => '30s'], + 'matchedTargetCount' => ['description' => 'The number of matched targets.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '65'], + 'path' => ['description' => 'The collection path.', 'type' => 'string', 'title' => '', 'example' => '/metrics'], + 'port' => ['description' => 'The collection port.', 'type' => 'string', 'title' => '', 'example' => '9100'], + 'targetPort' => ['description' => 'The target port.', 'type' => 'string', 'title' => '', 'example' => 'http'], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'matchedServiceCount' => ['description' => 'The number of matched services.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '50'], + 'name' => ['description' => 'The name of the ServiceMonitor.', 'type' => 'string', 'title' => '', 'example' => '62a526c5-f6ca-4cfb-b5a4-b76974cffe51'], + 'namespace' => ['description' => 'The namespace.', 'type' => 'string', 'title' => '', 'example' => 'arms-prom'], ], - 'userId' => [ - 'description' => 'User ID.', - 'type' => 'string', - 'example' => '11222', - ], - 'version' => [ - 'title' => '版本', - 'description' => 'Version.', - 'type' => 'string', - 'example' => 'V1', - ], - 'workspace' => [ - 'title' => '环境归属的工作空间', - 'description' => 'Workspace to which the environment belongs', - 'type' => 'string', - 'example' => 'cms-monitor-test-aysls-pub-cn-fuzhou-monitor', - ], - 'folderUrl' => [ - 'title' => '可观测大盘Url', - 'description' => 'Observability dashboard URL.', - 'type' => 'string', - 'example' => 'https://xxxx', - ], - 'grafanaInstanceId' => [ - 'title' => '绑定的托管grafana实例Id', - 'description' => 'Bound managed Grafana instance ID.', - 'type' => 'string', - 'example' => 'g-xxx ', - ], - 'grafanaInstanceName' => [ - 'title' => '绑定的托管grafana实例名称', - 'description' => 'Bound managed Grafana instance name.', - 'type' => 'string', - 'example' => 'gxxx', - ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListIntegrationPolicyServiceMonitors', + 'summary' => 'Retrieves the ServiceMonitor information for an Integration Center policy.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - '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' => 'Query details of a specified Prometheus view instance.', - 'description' => 'Query a specified Prometheus view instance.', - 'translator' => 'machine', + '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"}]', ], - 'ListPrometheusDashboards' => [ - 'summary' => 'Get Prometheus Instance Dashboard List', - 'path' => '/prometheus-instances/{prometheusInstanceId}/dashboards', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListIntegrationPolicyStorageRequirements' => [ + 'summary' => 'Lists the storage requirements for an Integration Center policy.', + 'path' => '/integration-policies/{policyId}/storage-requirements', + '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' => 'Instance ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => 'rw-abc123', - ], + 'schema' => ['title' => '接入中心策略ID', 'description' => 'The ID of the Integration Center policy.', 'type' => 'string', 'required' => true, 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e'], ], [ - 'name' => 'resourceGroupId', + 'name' => 'addonName', 'in' => 'query', - 'schema' => [ - 'description' => 'Resource Group ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfm3gn5i6bigbi', - ], + 'schema' => ['title' => 'Addon名称，如mysql。', 'description' => 'The name of the add-on release.', 'type' => 'string', 'required' => false, 'example' => 'release-1234357'], ], [ - 'name' => 'aliyunLang', + 'name' => 'storageType', 'in' => 'query', - 'schema' => [ - 'title' => '语言环境, 默认为中文 zh | en', - 'description' => 'Language environment, default is Chinese zh | en', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - 'default' => 'zh', - ], + 'schema' => ['title' => '存储类型', 'description' => 'The storage type. Valid values: LogStore, Prometheus, TraceStore, EventStore, and EntityStore.', 'type' => 'string', 'required' => false, 'example' => 'LogStore'], + ], + [ + 'name' => 'addonReleaseName', + 'in' => 'query', + 'schema' => ['title' => 'AddonRelease的名称。', 'description' => 'The name of the AddonRelease.', 'type' => 'string', 'required' => false, 'example' => 'kafka-17201012937917'], ], ], 'responses' => [ @@ -18137,1594 +16652,1046 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'prometheusDashboards' => [ - 'description' => 'List of Prometheus instance dashboards.', + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0'], + 'storageRequirements' => [ + 'description' => 'The list of storage requirements.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'id' => [ - 'title' => '', - 'description' => 'Dashboard ID.', - 'type' => 'string', - 'example' => '1', - ], - 'uid' => [ - 'title' => '', - 'description' => 'Dashboard UID.', - 'type' => 'string', - 'example' => '1987395500251724', - ], - 'name' => [ + 'apiVersion' => ['description' => 'The version number.', 'type' => 'string', 'title' => '', 'example' => 'v1'], + 'kind' => ['description' => 'The kind of the resource.', 'type' => 'string', 'title' => '', 'example' => 'Pod'], + 'metadata' => [ + 'description' => 'The metadata.', + 'type' => 'object', + 'properties' => [ + 'annotations' => [ + 'description' => 'The annotations.', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => 'The annotations.', 'title' => '', 'example' => 'prometheus.io/path'], + 'title' => '', + 'example' => '', + ], + 'labels' => [ + 'description' => 'The resource labels.', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => 'The resource labels.', 'title' => '', 'example' => 'key=value'], + 'title' => '', + 'example' => '', + ], + 'name' => ['description' => 'The resource name.', 'type' => 'string', 'title' => '', 'example' => 'pod-1234567'], + 'namespace' => ['description' => 'The namespace.', 'type' => 'string', 'title' => '', 'example' => 'arms-prom'], + ], 'title' => '', - 'description' => 'Dashboard name.', - 'type' => 'string', - 'example' => 'pod', + 'example' => '', ], - 'title' => [ + 'spec' => [ + 'description' => 'The spec of the resource.', + 'type' => 'object', + 'properties' => [ + 'entityId' => ['description' => 'The instance ID. Specify this parameter to query data at the instance level. This parameter depends on data in EntityStore.', 'type' => 'string', 'title' => '', 'example' => 'es-xxxxx'], + 'instance' => ['description' => 'The ID of the Prometheus instance.', 'type' => 'string', 'title' => '', 'example' => 'i-bp122p85gthbniw8rsu9'], + 'instanceName' => ['description' => 'The name of the Prometheus instance.', 'type' => 'string', 'title' => '', 'example' => 'category_predict'], + 'project' => ['description' => 'Optional. The project is determined based on the current environment type.', 'type' => 'string', 'title' => '', 'example' => 'datagrid_cdm'], + 'region' => ['description' => 'The region.', 'type' => 'string', 'title' => '', 'example' => 'cn-shenzhen'], + 'shareScope' => ['description' => 'The scope of storage sharing. Valid values: Environment, Region, Workspace, and Custom.', 'type' => 'string', 'title' => '', 'example' => 'Region'], + 'storageType' => ['description' => 'The storage type of the instance.', 'type' => 'string', 'title' => '', 'example' => 'Prometheus'], + 'systemTags' => [ + 'description' => 'The tags that need to be added to the destination storage. The tags are injected as system tags.', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => 'The tags that need to be added to the destination storage. The tags are injected as system tags.', 'title' => '', 'example' => 'system-key=value'], + 'title' => '', + 'example' => '', + ], + 'tags' => [ + 'description' => 'The tags that need to be added to the destination storage. The tags are injected as common tags.', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => 'The tags that need to be added to the destination storage. The tags are injected as common tags.', 'title' => '', 'example' => 'key=value'], + 'title' => '', + 'example' => '', + ], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'title' => '', 'example' => '12345678'], + 'workspace' => ['description' => 'The workspace.', 'type' => 'string', 'title' => '', 'example' => 'test-api'], + ], 'title' => '', - 'description' => 'Dashboard title.', - 'type' => 'string', - 'example' => 'ceshi', + 'example' => '', ], - 'url' => [ + 'status' => [ + 'description' => 'The status of the storage requirement.', + 'type' => 'object', + 'properties' => [ + 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'rmq-cn-uqm3ket1t0u'], + 'interUrl' => ['description' => 'The internal URL.', 'type' => 'string', 'title' => '', 'example' => 'http://192.168.xxxxxx'], + 'intraUrl' => ['description' => 'The internal URL.', 'type' => 'string', 'title' => '', 'example' => 'http://100.100.xxxxxx'], + 'name' => ['description' => 'The name of the storage requirement.', 'type' => 'string', 'title' => '', 'example' => 'sr-xxxx'], + 'project' => ['description' => 'The project for the storage requirement.', 'type' => 'string', 'title' => '', 'example' => 'jiuwu_algo'], + 'promMetricStore' => ['description' => 'The metric store of Prometheus.', 'type' => 'string', 'title' => '', 'example' => 'xxxx'], + 'region' => ['description' => 'The region.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'], + 'storageType' => ['description' => 'The storage type of the instance.', 'type' => 'string', 'title' => '', 'example' => 'Prometheus'], + 'workspace' => ['description' => 'The workspace.', 'type' => 'string', 'title' => '', 'example' => 'default'], + ], 'title' => '', - 'description' => 'Dashboard URL address.', - 'type' => 'string', - 'example' => 'https://gnew.console.aliyun.com/d/xxx-17460385-807-7-6/cs-cost-application', + 'example' => '', ], - 'tags' => [ - 'description' => 'Tags.', + 'addonReleaseNames' => [ + 'description' => 'A collection of AddonRelease names.', 'type' => 'array', - 'items' => [ - 'description' => 'Tag values.', - 'type' => 'string', - 'example' => '[{\\"tagName\\":\\"key1\\",\\"tagDefinePrompt\\":\\"value1\\"}]', - ], + 'items' => ['description' => 'The name of the AddonRelease.', 'type' => 'string', 'title' => '', 'example' => 'kafka-17201238912'], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'ID of the request', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], - 'totalCount' => [ - 'title' => '总实例数', - 'description' => 'Total number of instances', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '66', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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' => 'Get Prometheus Instance Dashboard List', - 'description' => 'Get the list of Prometheus instance dashboards.', - 'translator' => 'machine', - ], - 'UpdatePrometheusView' => [ - 'summary' => 'Update Prometheus view instance information', - 'path' => '/prometheus-views/{prometheusViewId}', - 'methods' => [ - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + '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' => 'Get Storage Requirements Information for Access Center Policy', + 'description' => 'When a policy is active, alert notifications are not sent for alerts that occur in the application group.'."\n" + ."\n" + .'This topic provides an example of creating a policy named `PauseNotify`. This policy pauses alert notifications for application group `7301****` from `1622949300000` to `1623208500000` (from `2021-06-06 11:15:00` to `2021-06-09 11:15:00` UTC+8).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntegrationPolicyStorageRequirements'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'cms:ListIntegrationPolicyStorageRequirements', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'IntegrationPolicy', 'arn' => 'acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#integrationPolicyId}'], + ], + ], + ], ], + ], + 'ListMemoryStores' => [ + 'path' => '/workspace/{workspace}/memorystore', + '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' => 'prometheusViewId', + 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'description' => 'Prometheus view instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'rw-xxxxxxxx', - ], + 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'memoryStoreName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the memory store.', 'type' => 'string', 'required' => false, 'example' => 'qianyi_test_1', 'title' => ''], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of results to return. The maximum value is 200.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token for the next page of results.', 'type' => 'string', 'required' => false, 'example' => 'xxxxxxxxx', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Request body.', 'type' => 'object', 'properties' => [ - 'authFreeReadPolicy' => [ - 'description' => 'Password-free read policy (supports IP segments and 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' => 'Whether to support password-free read.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'enableAuthToken' => [ - 'title' => '是否支持authToken', - 'description' => 'Whether to support authToken.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'prometheusInstances' => [ - 'description' => 'List of Prometheus instances.', + 'maxResults' => ['description' => 'The maximum number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'nextToken' => ['description' => 'The token for the next page of results.', 'type' => 'string', 'example' => 'xxxxxxxxxx', 'title' => ''], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '16C0A6D6-C3E7-511D-A60B-A87FD85F5BA7', 'title' => ''], + 'total' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'memoryStores' => [ 'type' => 'array', 'items' => [ - 'description' => 'List of Prometheus instances.', 'type' => 'object', 'properties' => [ - 'prometheusInstanceId' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'c7ba84651c71e442c8d0653085d862164', - ], - 'regionId' => [ - 'description' => 'Region.', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-north-2-gov-1', - ], - 'userId' => [ - 'description' => 'User ID.', - 'type' => 'string', - 'required' => false, - 'example' => '16727123456789', - ], - ], - 'required' => false, + 'createTime' => ['description' => 'The time when the memory store was created.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1764556182850', 'title' => ''], + 'description' => ['description' => 'The description of the memory store.', 'type' => 'string', 'example' => 'Created by taishan-module-recovery', 'title' => ''], + 'memoryStoreName' => ['description' => 'The name of the memory store.', 'type' => 'string', 'example' => 'qianyi_test_1', 'title' => ''], + 'updateTime' => ['description' => 'The time when the memory store was last updated.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1764556182850', 'title' => ''], + 'workspace' => ['description' => 'Workspace', 'type' => 'string', 'example' => 'default-cms-1646467597142798-cn-shenzhen', 'title' => ''], + 'regionId' => ['description' => 'The ID of the region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'description' => 'The data of the memory store.', + 'title' => '', + 'example' => '', ], - 'required' => false, - ], - 'prometheusViewName' => [ - 'description' => 'Prometheus view name.', - 'type' => 'string', - 'required' => false, - 'example' => 'test-prom-view-name', - ], - 'status' => [ - 'description' => 'Running status.', - 'type' => 'string', - 'required' => false, - 'example' => 'Running', - ], - 'workspace' => [ - 'title' => '归属的工作空间。', - 'description' => 'Belonging workspace.', - 'type' => 'string', - 'required' => false, - 'example' => 'default-cms-108490012345-cn-heyuan', + 'description' => 'The list of memory stores.', + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListMemoryStores', + 'summary' => 'Retrieves a list of memory stores.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + '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' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'pipelineName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the pipeline.', 'type' => 'string', 'required' => false, 'example' => 'pipeline-name-1', 'title' => ''], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token.', 'type' => 'string', 'required' => false, 'example' => 'fff3442dac1de7950f44d5afc0c735ebd12e27f603b21d17ec30cb1d5c735b1ba7c4fb3a1c124bce', 'title' => ''], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of results to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'prometheusViewId' => [ - 'title' => '操作结果', - 'description' => 'Prometheus view instance 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', + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-************'], + 'nextToken' => ['description' => 'The pagination token.', 'type' => 'string', 'example' => '3f0d6785770d5fb308f0605d718d422a227c38f96117633678f029842acd19039329e8281583b3da7bc598dfc4c1973e', 'title' => ''], + 'maxResults' => ['description' => 'The maximum number of results to return.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'pipelines' => [ + 'description' => 'The pipelines.', + 'type' => 'array', + 'items' => [ + 'description' => 'The pipeline.', + 'type' => 'object', + 'properties' => [ + 'pipelineName' => ['description' => 'The name of the pipeline.', 'type' => 'string', 'example' => 'pipeline-name-1', 'title' => ''], + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'test pipeline', 'title' => ''], + 'createTime' => ['description' => 'The creation time.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2026-02-28T07:14:17Z', 'title' => ''], + 'updateTime' => ['description' => 'The update time.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2026-03-24T06:58:22Z', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'workspace' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'workspace-test', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusViewId\\": \\"rw-xxxxxx\\",\\n \\"requestId\\": \\"64D964F5-76C7-19A2-9399-457744AB3619\\"\\n}","type":"json"}]', - 'title' => 'Update Prometheus View Instance Information', - 'description' => 'Update Prometheus view instance information.', - 'translator' => 'machine', - ], - 'UpdatePrometheusInstance' => [ - 'summary' => 'Update Prometheus instance information', - 'path' => '/prometheus-instances/{prometheusInstanceId}', - 'methods' => [ - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Lists pipelines.', + 'summary' => 'Lists pipelines.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + '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' => [ + 'summary' => 'Retrieves a list of dashboards for a Prometheus instance.', + 'path' => '/prometheus-instances/{prometheusInstanceId}/dashboards', + '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', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'prometheusInstanceId', 'in' => 'path', 'allowEmptyValue' => false, - 'schema' => [ - 'title' => 'prometheus实例ID', - 'description' => 'Prometheus instance ID', - 'type' => 'string', - 'required' => true, - 'example' => 'rw-xxxxxxx', - ], + 'schema' => ['title' => '实例id', 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'rw-abc123'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'Request body.', - 'type' => 'object', - 'properties' => [ - 'archiveDuration' => [ - 'title' => '存储到期后，自动归档保存的天数，0表示不归档保存。归档天数取值范围：'."\n" - .'V1：1~365天。仅按指标写入量支持。'."\n" - .'V2：1~3650天（3650表示永久保存）。', - 'description' => 'The number of days to automatically archive and save after the storage expires, 0 means no archiving. The range of archiving days:'."\n" - .'V1: 1~365 days. Only supported for metric write volume.'."\n" - .'V2: 1~3650 days (3650 indicates permanent storage).', - 'type' => 'integer', - 'required' => false, - 'example' => '365', - 'enum' => [], - ], - 'authFreeReadPolicy' => [ - 'title' => '是否开启免密读的ip地址列表，支持CIDR配置。多个ip之间换行符分隔。', - 'description' => 'Password-free read policy (supports IP segments and 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' => 'Password-free write policy (supports IP segments and 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' => 'Whether to enable password-free read.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'enableAuthFreeWrite' => [ - 'title' => '是否开启免密写', - 'description' => 'Whether to enable password-free write.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'enableAuthToken' => [ - 'title' => '是否开启访问Token鉴权', - 'description' => 'Whether to enable access token authentication.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'prometheusInstanceName' => [ - 'description' => 'Instance name.', - 'type' => 'string', - 'required' => false, - 'example' => 'test-prom-name', - ], - 'status' => [ - 'title' => '实例存储db状态（仅支持RUNNING）。为空时，不改变存储db状态。', - 'description' => 'Instance storage DB status (only supports RUNNING). If empty, the storage DB status will not be changed.', - 'type' => 'string', - 'required' => false, - 'example' => 'RUNNING', - ], - 'storageDuration' => [ - 'title' => '存储时长（天）：'."\n" - .'按写入量：90、180'."\n" - .'按指标上报量：15、30、60、90、180', - 'description' => 'Storage duration (days):'."\n" - .'By write volume: 90, 180.'."\n" - .'By metric reporting volume: 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' => 'Billing method (can only be modified once during the instance\'s lifecycle):'."\n" - .'POSTPAY: Postpaid by metric reporting volume.'."\n" - .'POSTPAY_GB: Postpaid by metric write volume.', - 'type' => 'string', - 'required' => false, - 'example' => 'POSTPAY_GB', - 'enum' => [ - 'POSTPAY_GB', - 'POSTPAY', - ], - ], - 'workspace' => [ - 'title' => '归属的工作空间。', - 'description' => 'Belonging workspace.', - 'type' => 'string', - 'required' => false, - 'example' => 'default-cms-1500199863951574-cn-shanghai', - ], - ], - 'required' => false, - ], + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rg-acfm3gn5i6bigbi'], + ], + [ + 'name' => 'aliyunLang', + 'in' => 'query', + 'schema' => ['title' => '语言环境, 默认为中文 zh | en', 'description' => 'The language of the response. Valid values: zh and en. The default value is zh.', 'type' => 'string', 'required' => false, 'default' => 'zh', 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'prometheusInstanceId' => [ - 'description' => 'Instance 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' => 'A list of dashboards for the Prometheus instance.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => ['title' => '', 'description' => 'The dashboard ID.', 'type' => 'string', 'example' => '1'], + 'uid' => ['title' => '', 'description' => 'The dashboard UID.', 'type' => 'string', 'example' => '1987395500251724'], + 'name' => ['title' => '', 'description' => 'The dashboard name.', 'type' => 'string', 'example' => 'pod'], + 'title' => ['title' => '', 'description' => 'The dashboard title.', 'type' => 'string', 'example' => 'ceshi'], + 'url' => ['title' => '', 'description' => 'The URL of the dashboard.', 'type' => 'string', 'example' => 'https://gnew.console.aliyun.com/d/xxx-17460385-807-7-6/cs-cost-application'], + 'tags' => [ + 'description' => 'The tags.', + 'type' => 'array', + 'items' => ['description' => 'The tag value.', 'type' => 'string', 'title' => '', 'example' => '[{\\"tagName\\":\\"key1\\",\\"tagDefinePrompt\\":\\"value1\\"}]'], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'totalCount' => ['title' => '总实例数', 'description' => 'The total number of instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '66'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusInstanceId\\": \\"rw-abc123\\",\\n \\"requestId\\": \\"1E92F783-E057-58F1-BD5C-92DED088E7A5\\"\\n}","type":"json"}]', - 'title' => 'Update Prometheus Instance Information', - 'description' => 'Update Prometheus instance information.', - 'translator' => 'machine', - ], - 'ListPrometheusViews' => [ - 'summary' => 'Retrieve a list of Prometheus view instance information', - 'path' => '/prometheus-views', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + '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' => 'Get Prometheus Instance Dashboard List', + 'description' => 'Retrieves a list of dashboards for a Prometheus instance.', + '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}'], + ], + ], + ], ], + ], + 'ListPrometheusInstances' => [ + 'summary' => 'Retrieves a list of Managed Service for Prometheus instances.', + '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' => 'List of Prometheus view instance IDs.', - 'type' => 'string', - 'required' => false, - 'example' => 'view-xxx', - ], + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'The instance IDs, separated by commas.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'rw-00001,rw-00002,rw-00003'], ], [ - 'name' => 'prometheusViewName', + 'name' => 'prometheusInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => 'Prometheus view name.', - 'type' => 'string', - 'required' => false, - 'example' => 'view1', - ], + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'The instance name. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test'], ], [ 'name' => 'workspace', 'in' => 'query', - 'schema' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'required' => false, - 'example' => 'workspace-test', - ], + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'The workspace to which the instance belongs.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'workspace-test'], ], [ 'name' => 'version', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'title' => '实例版本：V1或V2', - 'description' => 'Instance version: V1 or V2', + 'title' => '', + 'description' => 'The instance version. Valid values:'."\n" + .'- V1: V1 version.'."\n" + .'- V2: V2 version.', + 'enumValueTitles' => ['V1' => 'V1 version.', 'V2' => 'V2 version.'], 'type' => 'string', 'required' => false, + 'docRequired' => false, + 'enum' => ['V1', 'V2'], 'example' => 'V2', - 'enum' => [ - 'V1', - 'V2', - ], ], ], [ 'name' => 'resourceType', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'title' => '资源类型：PrometheusView', - 'description' => 'Resource type.', + 'title' => '', + 'description' => 'The resource type of the instance.', 'type' => 'string', 'required' => false, - 'example' => 'PROMETHEUSVIEW', + 'docRequired' => false, + 'enum' => [], + 'example' => 'Prometheus', ], ], [ 'name' => 'filterRegionIds', 'in' => 'query', - 'schema' => [ - 'description' => 'Filter by RegionID.', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-zhangjiakou,cn-beijing', - 'title' => '指定筛选的regionId（目前仅支持单regioinId，暂不支持多值）。', - ], + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'The region IDs for filtering, separated by commas.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-shenzhen'], ], [ 'name' => 'resourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'Resource group ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfm3gn5i6bigbi', - ], + 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2bhocin5e2na', 'title' => ''], ], [ 'name' => 'tag', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'List of tags.', + 'description' => 'The tags.', 'type' => 'array', 'items' => [ - 'description' => 'List of tags.', + 'description' => 'The tag.', 'type' => 'object', 'properties' => [ - 'key' => [ - 'description' => 'Tag key', - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], - 'value' => [ - 'description' => 'Match value.', - 'type' => 'string', - 'required' => false, - 'example' => 'value1', - ], + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'testKey', 'title' => ''], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'testValue', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '返回的最多记录数。', - 'description' => 'Maximum number of records to return.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '100', - ], + 'schema' => ['title' => '', 'description' => 'The maximum number of records to return.', 'type' => 'integer', 'format' => 'int32', 'docRequired' => false, 'maximum' => '100', 'minimum' => '0', 'required' => false, 'example' => '10'], ], [ 'name' => 'nextToken', 'in' => 'query', 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '查询令牌。', - 'description' => 'Query token.', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '44ANBjKZmQeKnaB1fXRq06w7sFYK3MUcCALMD9qQbmEiE', - 'maxLength' => 128, - ], + 'schema' => ['title' => '', 'description' => 'The query token.', 'type' => 'string', 'docRequired' => false, 'maxLength' => 128, 'required' => false, 'example' => 'xxxxxxxxxx'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Response schema', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'maxResults' => [ - 'title' => '返回的最多记录数。', - 'description' => 'Maximum number of records to return.', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '100', - 'minimum' => '0', - 'example' => '10', - ], - 'nextToken' => [ - 'title' => '下一次查询的令牌。', - 'description' => 'Token for the next query.', - 'type' => 'string', - 'example' => '2-ba4d-4b9f-aa24-dcb067a30f1c', - 'maxLength' => 128, - ], - 'prometheusViews' => [ - 'description' => 'List of Prometheus view instances.', + 'maxResults' => ['title' => '', 'description' => 'The maximum number of records to return.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '0', 'example' => '10'], + 'nextToken' => ['title' => '', 'description' => 'The token for the next query.', 'type' => 'string', 'maxLength' => 128, 'example' => 'xxxxxxxxxx'], + 'prometheusInstances' => [ + 'description' => 'The list of Prometheus instances.', 'type' => 'array', 'items' => [ - 'description' => 'Prometheus view instance.', + 'description' => 'The Prometheus instance.', 'type' => 'object', 'properties' => [ - 'createTime' => [ - 'title' => '实例创建时间，使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ', - 'description' => 'Instance creation time, using UTC+0 time, formatted as yyyy-MM-ddTHH:mmZ', - 'type' => 'string', - 'example' => '2025-07-12T02:18:36Z', - ], - 'instanceType' => [ - 'title' => '实例类型：'."\n" - .'prom-view：新版本聚合视图'."\n" - .'global-view：老版本聚合视图', - 'description' => 'Instance type:'."\n" - .'prom-view: new version aggregated view'."\n" - .'global-view: old version aggregated view', - 'type' => 'string', - 'example' => 'prom-view', - ], - 'paymentType' => [ - 'title' => '付费类型。目前固定值FREE（免费）。', - 'description' => 'Payment type. Currently, the fixed value is FREE (free).', - 'type' => 'string', - 'example' => 'FREE', - ], - 'product' => [ - 'title' => 'prom实例归属的产品（arms或cms）', - 'description' => 'Product that the prom instance belongs to (arms or cms).', - 'type' => 'string', - 'example' => 'cms', - ], - 'prometheusInstanceCount' => [ - 'title' => '视图包含的prometheus实例的数量。', - 'description' => 'Number of Prometheus instances in the view.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'prometheusViewId' => [ - 'description' => 'Prometheus view ID.', - 'type' => 'string', - 'example' => 'view-xxx', - ], - 'prometheusViewName' => [ - 'description' => 'Prometheus view name.', - 'type' => 'string', - 'example' => 'view1', - ], - 'regionId' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-zhangjiakou', - ], - 'resourceType' => [ - 'title' => '固定值：PrometheusView', - 'description' => 'Fixed value: PrometheusView.', - 'type' => 'string', - 'example' => 'PrometheusView', - ], - 'status' => [ - 'title' => '后端数据存储状态', - 'description' => 'Backend data storage status.', - 'type' => 'string', - 'example' => 'Running', - ], - 'userId' => [ - 'description' => 'User ID.', - 'type' => 'string', - 'example' => '123xxx', - ], - 'version' => [ - 'title' => '版本', - 'description' => 'Version.', - 'type' => 'string', - 'example' => 'V2', - ], - 'workspace' => [ - 'title' => 'prom实例归属工作空间', - 'description' => 'Workspace that the prom instance belongs to.', - 'type' => 'string', - 'example' => 'default-cms-1490404746278495-cn-hangzhou', + 'accessType' => ['title' => '', 'description' => 'The access type. Valid values:'."\n" + .'- readWrite'."\n" + .'- readOnly'."\n" + .'- httpReadOnly', 'type' => 'string', 'example' => 'readWrite'], + 'createTime' => ['title' => '', 'description' => 'The instance creation time in UTC+0, in the format of yyyy-MM-ddTHH:mmZ.', 'type' => 'string', 'example' => '2025-08-10T02:07:53Z'], + 'instanceType' => ['title' => '', 'description' => 'The instance type.', 'type' => 'string', 'example' => 'remote-write'], + 'paymentType' => ['title' => '', 'description' => 'The billing method. Valid values:'."\n" + .'- POSTPAY: pay-as-you-go by metric volume.'."\n" + .'- POSTPAY_GB: pay-as-you-go by write volume.'."\n" + .'- PREPAY: subscription.'."\n" + .'- FREE: free.', 'type' => 'string', 'example' => 'POSTPAY_GB'], + 'product' => ['title' => '', 'description' => 'The product to which the Prometheus instance belongs.', 'type' => 'string', 'example' => 'arms'], + 'prometheusInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'rw-63549e054ff596a4149927961dff', 'title' => ''], + 'prometheusInstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'test-prom-name', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-nanjing', 'title' => ''], + 'resourceType' => ['title' => '', 'description' => 'The resource type.', 'type' => 'string', 'example' => 'Prometheus'], + 'status' => ['title' => '', 'description' => 'The backend data storage status.', 'type' => 'string', 'example' => 'Pending2Running'], + 'supportAuthTypes' => [ + 'description' => 'The supported authentication types.', + 'type' => 'array', + 'items' => ['description' => 'The authentication type.', 'type' => 'string', 'example' => 'BasicAuth', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '17073812345', 'title' => ''], + 'version' => ['title' => '', 'description' => 'The version.', 'type' => 'string', 'example' => '*'], + 'workspace' => ['title' => '', 'description' => 'The workspace to which the Prometheus instance belongs.', 'type' => 'string', 'example' => 'default-cms-115214006-cn-hangzhou'], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-aek2bhocin5e2na', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'ID of the request', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', - ], - 'totalCount' => [ - 'title' => '总实例数', - 'description' => 'Total number of instances', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '66', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'totalCount' => ['title' => '', 'description' => 'The total number of instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '66'], ], + 'example' => '', ], ], ], - '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' => 'Get Prometheus View Instance List', - 'description' => 'Retrieve a list of Prometheus view instance information.', - 'translator' => 'machine', - ], - 'ListPrometheusInstances' => [ - 'summary' => 'Get the list of Prometheus instance information', - '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' => 'Query prometheus instance list', + 'description' => 'Retrieves a list of Managed Service for Prometheus instances.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrometheusInstances'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + ], + 'ListPrometheusViews' => [ + 'summary' => 'Queries the list of Prometheus view instances.', + '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' => 'List of instance IDs (comma-separated)', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'rw-00001,rw-00002,rw-00003', - ], + 'schema' => ['description' => 'The list of Prometheus view instance IDs.', 'type' => 'string', 'required' => false, 'example' => 'view-xxx', 'title' => ''], ], [ - 'name' => 'prometheusInstanceName', + 'name' => 'prometheusViewName', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '实例名称（支持部分匹配）', - 'description' => 'Instance name (partial match supported)', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The Prometheus view name.', 'type' => 'string', 'required' => false, 'example' => 'view1', 'title' => ''], ], [ 'name' => 'workspace', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '实例归属的工作空间', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => false, 'example' => 'workspace-test', 'title' => ''], ], [ 'name' => 'version', 'in' => 'query', - 'allowEmptyValue' => true, 'schema' => [ - 'title' => '实例版本：V1或V2', - 'description' => 'Instance version: V1 or V2', + 'title' => '', + 'description' => 'The instance version: V1 or V2.', + 'enumValueTitles' => ['V1' => 'V1 version.', 'V2' => 'V2 version.'], 'type' => 'string', + 'enum' => ['V1', 'V2'], 'required' => false, - 'docRequired' => false, 'example' => 'V2', - 'enum' => [ - 'V1', - 'V2', - ], ], ], [ 'name' => 'resourceType', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '实例的资源类型：PrometheusInstance', - 'description' => 'Resource type of the instance.', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Prometheus', - 'enum' => [], - ], + 'schema' => ['title' => '', 'description' => 'The resource type.', 'type' => 'string', 'required' => false, 'example' => 'PROMETHEUSVIEW'], ], [ 'name' => 'filterRegionIds', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '指定筛选的regionId（目前仅支持单regioinId，暂不支持多值）。', - 'description' => 'Specified list of regionIds to filter (comma-separated).', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cn-shenzhen', - ], + 'schema' => ['title' => '', 'description' => 'Filters by region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-zhangjiakou,cn-beijing'], ], [ 'name' => 'resourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'Resource group ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aek2bhocin5e2na', - ], + 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfm3gn5i6bigbi', 'title' => ''], ], [ 'name' => 'tag', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'List of tags.', + 'description' => 'The list of tags.', 'type' => 'array', 'items' => [ - 'description' => 'Tag.', + 'description' => 'The list of tags.', 'type' => 'object', 'properties' => [ - 'key' => [ - 'description' => 'Tag key', - 'type' => 'string', - 'required' => false, - 'example' => 'testKey', - ], - 'value' => [ - 'description' => 'Tag value.', - 'type' => 'string', - 'required' => false, - 'example' => 'testValue', - ], + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'key1', 'title' => ''], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '返回的最多记录数。', - 'description' => 'Maximum number of records to return.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '10', - ], + 'schema' => ['title' => '', 'description' => 'The maximum number of records to return.', 'type' => 'integer', 'format' => 'int32', 'docRequired' => false, 'maximum' => '100', 'minimum' => '0', 'required' => false, 'example' => '100'], ], [ 'name' => 'nextToken', 'in' => 'query', 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '查询令牌。', - 'description' => 'Query token.', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'xxxxxxxxxx', - 'maxLength' => 128, - ], + 'schema' => ['title' => '', 'description' => 'The query token.', 'type' => 'string', 'docRequired' => false, 'maxLength' => 128, 'required' => false, 'example' => '44ANBjKZmQeKnaB1fXRq06w7sFYK3MUcCALMD9qQbmEiE'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'maxResults' => [ - 'title' => '返回的最多记录数。', - 'description' => 'Maximum number of records to return.', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '100', - 'minimum' => '0', - 'example' => '10', - ], - 'nextToken' => [ - 'title' => '下一次查询的令牌。', - 'description' => 'Token for the next query.', - 'type' => 'string', - 'example' => 'xxxxxxxxxx', - 'maxLength' => 128, - ], - 'prometheusInstances' => [ - 'description' => 'List of Prometheus instances.', + 'maxResults' => ['title' => '', 'description' => 'The maximum number of records to return.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '0', 'example' => '10'], + 'nextToken' => ['title' => '', 'description' => 'The token for the next query.', 'type' => 'string', 'maxLength' => 128, 'example' => '2-ba4d-4b9f-aa24-dcb067a30f1c'], + 'prometheusViews' => [ + 'description' => 'The list of Prometheus view instances.', 'type' => 'array', 'items' => [ - 'description' => 'Prometheus instance.', + 'description' => 'The Prometheus view instance.', 'type' => 'object', 'properties' => [ - 'accessType' => [ - 'title' => '权限类型：'."\n" - .'readWrite、readOnly、httpReadOnly', - 'description' => 'Access type:'."\n" - .'readWrite, readOnly, httpReadOnly', - 'type' => 'string', - 'example' => 'readWrite', - ], - 'createTime' => [ - 'title' => '实例创建时间，使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ', - 'description' => 'Instance creation time, using UTC+0 time, formatted as 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' => 'Instance type.', - 'type' => 'string', - 'example' => 'remote-write', - ], - 'paymentType' => [ - 'title' => 'POSTPAY：按指标量后付费。'."\n" - .'POSTPAY_GB：按写入量后付费。'."\n" - .'PREPAY：预付费。'."\n" - .'FREE：免费。', - 'description' => 'POSTPAY: Postpaid by metric.'."\n" - .'POSTPAY_GB: Postpaid by write volume.'."\n" - .'PREPAY: Prepaid.'."\n" - .'FREE: Free.', - 'type' => 'string', - 'example' => 'POSTPAY_GB', - ], - 'product' => [ - 'title' => 'prom实例归属的产品（arms或cms）', - 'description' => 'Product to which the prom instance belongs', - 'type' => 'string', - 'example' => 'arms', - ], - 'prometheusInstanceId' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'example' => 'rw-63549e054ff596a4149927961dff', - ], - 'prometheusInstanceName' => [ - 'description' => 'Instance name.', - 'type' => 'string', - 'example' => 'test-prom-name', - ], - 'regionId' => [ - 'description' => 'Region ID', - 'type' => 'string', - 'example' => 'cn-nanjing', - ], - 'resourceType' => [ - 'title' => '固定值：PrometheusInstance', - 'description' => 'Resource type.', - 'type' => 'string', - 'example' => 'Prometheus', - ], - 'status' => [ - 'title' => '后端数据存储状态', - 'description' => 'Backend data storage status', - 'type' => 'string', - 'example' => 'Pending2Running', - ], - 'supportAuthTypes' => [ - 'description' => 'Supported authentication types.', - 'type' => 'array', - 'items' => [ - 'description' => 'Authentication type.', - 'type' => 'string', - 'example' => 'BasicAuth', - ], - ], - 'userId' => [ - 'description' => 'User ID.', - 'type' => 'string', - 'example' => '17073812345', - ], - 'version' => [ - 'title' => '版本', - 'description' => 'Version', - 'type' => 'string', - 'example' => '*', - ], - 'workspace' => [ - 'title' => 'prom实例归属工作空间', - 'description' => 'Workspace to which the Prometheus instance belongs', - 'type' => 'string', - 'example' => 'default-cms-115214006-cn-hangzhou', - ], + 'createTime' => ['title' => '', 'description' => 'The instance creation time in UTC+0, in the format of yyyy-MM-ddTHH:mmZ.', 'type' => 'string', 'example' => '2025-07-12T02:18:36Z'], + 'instanceType' => ['title' => '', 'description' => 'The instance type:'."\n" + .'prom-view: aggregated view of the new version.'."\n" + .'global-view: aggregated view of the legacy version.', 'type' => 'string', 'example' => 'prom-view'], + 'paymentType' => ['title' => '', 'description' => 'The billing type. Currently, the fixed value is FREE.', 'type' => 'string', 'example' => 'FREE'], + 'product' => ['title' => '', 'description' => 'The product to which the Prometheus instance belongs (arms or cms).', 'type' => 'string', 'example' => 'cms'], + 'prometheusInstanceCount' => ['title' => '', 'description' => 'The number of Prometheus instances included in the view.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'prometheusViewId' => ['description' => 'The Prometheus view ID.', 'type' => 'string', 'example' => 'view-xxx', 'title' => ''], + 'prometheusViewName' => ['description' => 'The Prometheus view name.', 'type' => 'string', 'example' => 'view1', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-zhangjiakou', 'title' => ''], + 'resourceType' => ['title' => '', 'description' => 'The fixed value: PrometheusView.', 'type' => 'string', 'example' => 'PrometheusView'], + 'status' => ['title' => '', 'description' => 'The backend data storage status.', 'type' => 'string', 'example' => 'Running'], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '123xxx', 'title' => ''], + 'version' => ['title' => '', 'description' => 'The version.', 'type' => 'string', 'example' => 'V2'], + 'workspace' => ['title' => '', 'description' => 'The workspace to which the Prometheus instance belongs.', 'type' => 'string', 'example' => 'default-cms-1490404746278495-cn-hangzhou'], + 'resourceGroupId' => ['title' => '', 'description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-acfm3gn5i6bigbi'], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'ID of the request', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'totalCount' => [ - 'title' => '总实例数', - 'description' => 'Total number of instances', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '66', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0'], + 'totalCount' => ['title' => '', 'description' => 'The total number of instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '66'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => [], ], - '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' => 'Query Prometheus Instance List', - 'description' => 'Get the list of Prometheus instances.', - 'translator' => 'machine', - ], - 'CreatePrometheusInstance' => [ - 'summary' => 'Create a Prometheus monitoring instance', - 'path' => '/prometheus-instances', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'title' => 'List prometheus view instances', + 'description' => 'Queries the list of Prometheus view instances.', + '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' => 'The namespace of the cloud product. This parameter is optional.', 'type' => 'string', 'required' => false, 'example' => 'ack-csi-fuse'], + ], + [ + 'name' => 'tenantId', + 'in' => 'query', + 'schema' => ['description' => 'The tenant ID.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Request structure.', 'type' => 'object', 'properties' => [ - 'archiveDuration' => [ - 'title' => '存储到期后，自动归档保存的天数，0表示不归档保存。归档天数取值范围：'."\n" - .'V1：1~365天。仅按指标写入量支持。'."\n" - .'V2：1~3650天（3650表示永久保存）。', - 'description' => 'The number of days to automatically archive and save after the storage expires, 0 means no archiving. The range of archiving days is as follows:'."\n" - .'* V1: 60~365 days.'."\n" - .'* V2: 60~3650 days (3650 indicates permanent storage).', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60', - 'enum' => [], - ], - 'authFreeReadPolicy' => [ - 'description' => 'Password-free read policy (supports IP segments and 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' => 'Password-free write policy.', - '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' => 'Whether to enable password-free read (only supported in V2 version).', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'enableAuthFreeWrite' => [ - 'description' => 'Whether to enable password-free write (only supported in V2 version).', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'enableAuthToken' => [ - 'description' => 'Whether to enable authorization Token (only supported in V1 version).', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'prometheusInstanceName' => [ - 'description' => 'Instance name.', - 'type' => 'string', - 'required' => true, - 'example' => 'name1', - ], - 'status' => [ - 'description' => 'Instance status.', - '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' => 'Storage duration (days):'."\n" - .'* By write volume: 90, 180.'."\n" - .'* By metric reporting volume: 15, 30, 60, 90, 180.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '90', - 'enum' => [ - '15', - '30', - '60', - '90', - '180', - ], - ], - 'tags' => [ - 'description' => 'Tag values.', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'instances' => [ + 'description' => 'A list of instances.', 'type' => 'array', 'items' => [ - 'description' => 'Tag values.', + 'description' => 'The details of an instance.', 'type' => 'object', 'properties' => [ - 'key' => [ - 'description' => 'Tag key.', - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], - 'value' => [ - 'description' => 'Tag value.', - 'type' => 'string', - 'required' => false, - 'example' => '110109200001214284', - ], + 'instanceId' => ['description' => 'Returned for the `PROMETHEUS_DS` data source type.'."\n" + ."\n" + .'The Prometheus instance ID.', 'type' => 'string', 'example' => 'rw-b8cfbbe94194ac37fe83f3d2d16a', 'title' => ''], + 'httpApiUrl' => ['description' => 'The HTTP API URL.', 'type' => 'string', 'example' => 'http://xxxxxxxx', 'title' => ''], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '17073812345', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-shanghai-cloudspe', 'title' => ''], + 'namespace' => ['description' => 'Returned for the `CMS_BASIC_QUERY` query type.'."\n" + ."\n" + .'The namespace of the metric.', 'type' => 'string', 'example' => 'arms-prom', 'title' => ''], + 'createdAt' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '1750315319946', 'title' => ''], ], - 'required' => false, - ], - 'required' => false, - ], - 'workspace' => [ - 'title' => '默认值：default-cms-{userId}-{regionId}', - 'description' => 'Belonging workspace, default value: default-cms-{userId}-{regionId}.', - 'type' => 'string', - 'required' => false, - 'example' => 'wokspace1', - ], - 'paymentType' => [ - 'title' => '计费方式：'."\n" - .'POSTPAY：按指标上报量后付费。'."\n" - .'POSTPAY_GB：按指标写入量后付费。'."\n" - .'空：则使用用户的默认计费方式配置。若用户未配置默认值，则系统默认是按指标上报量计费。', - 'description' => 'Billing method:'."\n" - .'* POSTPAY: Postpaid by metric reporting volume.'."\n" - .'* POSTPAY_GB: Postpaid by metric write volume.'."\n" - .'Note, if left blank, the user\'s default billing method configuration will be used. If the user has not configured a default, the system defaults to billing by metric reporting volume.', - 'type' => 'string', - 'required' => false, - 'example' => 'POSTPAY', - 'enum' => [ - 'POSTPAY', - 'POSTPAY_GB', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'totalCount' => ['description' => 'The total number of entries returned.', 'type' => 'string', 'title' => '', 'example' => ''], + 'maxResults' => ['description' => 'The maximum number of entries returned on each page.', 'type' => 'string', 'title' => '', 'example' => ''], + 'nextToken' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. If all results are returned, this parameter is left empty.', 'type' => 'string', 'title' => '', 'example' => ''], ], - 'required' => false, + 'description' => 'The response object.', + 'title' => '', + 'example' => '', ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'prometheusInstanceId' => [ - 'title' => '集群id', - 'description' => 'Instance ID.', - 'type' => 'string', - 'example' => 'rw-abc123', - ], - 'requestId' => [ - 'description' => 'ID of the request.', - 'type' => 'string', - 'example' => '264C3E89-BE6E-5F82-A484-CE9C2196C7DC', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get Prometheus Virtual Instance List', + 'summary' => 'Retrieves Prometheus virtual instances.', + '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' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusInstanceId\\": \\"rw-abc123\\",\\n \\"requestId\\": \\"264C3E89-BE6E-5F82-A484-CE9C2196C7DC\\"\\n}","type":"json"}]', - 'title' => 'Create Prometheus Instance', - 'translator' => 'machine', + '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' => 'Create Prometheus View', - 'path' => '/prometheus-views', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListServiceRecords' => [ + 'summary' => 'Lists service-linked entries.', + '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' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'recordType', + 'in' => 'query', 'schema' => [ - 'description' => 'Request Body', - 'type' => 'object', - 'properties' => [ - 'authFreeReadPolicy' => [ - 'description' => 'Not enabled yet', - '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' => 'Whether to support password-free read', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'enableAuthToken' => [ - 'title' => '是否支持authToken', - 'description' => 'Whether to support authToken', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'prometheusInstances' => [ - 'description' => 'List of Prometheus instances.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'prometheusInstanceId' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'arms-1d581fac20a462dcde743d9628', - ], - 'regionId' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-wulanchabu', - ], - 'userId' => [ - 'description' => 'User ID.', - 'type' => 'string', - 'required' => false, - 'example' => '167271234567890', - ], - ], - 'required' => false, - ], - 'required' => true, - ], - 'prometheusViewName' => [ - 'description' => 'Prometheus view name.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-prom-view-name', - ], - 'resourceGroupId' => [ - 'description' => 'Resource group ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfm3gn5i6bigbi', - ], - 'status' => [ - 'description' => 'Not enabled yet.', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - 'default' => 'Running', - 'enum' => [ - 'Running', - ], - ], - 'tags' => [ - 'description' => 'The operation to be performed.', - 'type' => 'array', - 'items' => [ - 'description' => 'Tag key.', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => 'Tag key.', - 'type' => 'string', - 'required' => false, - 'example' => 'test-key', - ], - 'value' => [ - 'description' => 'Tag value.', - 'type' => 'string', - 'required' => false, - 'example' => 'test-value', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'version' => [ - 'title' => 'V1：老版本(global-view)'."\n" - .'V2：新版本(prom-view)', - 'description' => '- V1: Old version'."\n" - .'- V2: New version', - 'type' => 'string', - 'required' => true, - 'example' => 'V2', - 'enum' => [ - 'V1', - 'V2', - ], - ], - 'workspace' => [ - 'title' => '默认值：default-cms-{userId}-{regionId}', - 'description' => 'Default value: default-cms-{userId}-{regionId}', - 'type' => 'string', - 'required' => false, - 'example' => 'cms-monitor-test-aysls-pub-cn-zhangjiakou-spe-monitor', - ], - ], - 'required' => false, + 'title' => '', + 'description' => 'The type of the linked entry. Currently supported:'."\n" + .'logCorrelation, which indicates application log association.', + 'type' => 'string', + 'required' => true, + 'enum' => ['logCorrelation'], + 'example' => 'logCorrelation', ], ], + [ + 'name' => 'search', + 'in' => 'query', + 'schema' => ['description' => 'The filter information for service-linked entries.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "serviceName": "my-service",'."\n" + .' "storeName": "my-logstore"'."\n" + .'}', 'title' => ''], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of entries to return. Maximum value: 200.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token.', 'type' => 'string', 'required' => false, 'example' => 'xxxxx', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'prometheusViewId' => [ - 'description' => 'Prometheus view 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' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0CEC5375-XXXX-XXXX-XXXX-9A629907C1F0'], + 'nextToken' => ['description' => 'The pagination token.', 'type' => 'string', 'example' => '2-ba4d-4b9f-aa24-dcb067a30f1c', 'title' => ''], + 'totalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'maxResults' => ['description' => 'The maximum number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'records' => [ + 'description' => 'The list of ticket operation records.', + 'type' => 'array', + 'items' => [ + 'description' => 'The record information.', + 'type' => 'object', + 'properties' => [ + 'serviceId' => ['title' => '', 'description' => 'The unique identifier of the service.', 'type' => 'string', 'example' => 'gaddp9ap8q@f8ca37734da3eda787dbb'], + 'recordType' => ['title' => '', 'description' => 'The type of the linked entry. Currently supported:'."\n" + .'logCorrelation, which indicates application log association.', 'type' => 'string', 'example' => 'logCorrelation'], + 'recordContent' => ['title' => '', 'description' => 'The entry content in JSON string format. The format varies depending on the 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' => 'The workspace.', 'type' => 'string', 'example' => 'workspace-test'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'List service-linked entries', + 'description' => 'Queries a paginated list of service-linked entries.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusViewId\\": \\"cd5237f7dbd574cf9bbd648ff9efb16cd\\",\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', - 'title' => 'Create Prometheus View', - 'description' => 'Used to create a site monitoring task', - 'translator' => 'machine', + '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' => 'Query Alert Actions', - 'path' => '/alertActions', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListServices' => [ + 'summary' => 'Queries a list of application observability services.', + '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' => 'Unique identifier for the action integration.', - 'type' => 'array', - 'items' => [ - 'description' => 'Unique identifier for the action integration.', - 'type' => 'string', - 'required' => false, - 'example' => 'testId', - ], - 'required' => false, - ], + 'schema' => ['description' => 'The token for the next page of results. If this parameter is empty, it means you have reached the last page.', 'type' => 'string', 'example' => '7-b81a-4bc9-bbfa-a50cc6988667', 'title' => '', 'required' => false], ], [ - 'name' => 'type', + 'name' => 'maxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'Type of the action integration.', - 'type' => 'string', - 'required' => false, - 'example' => 'FC', - 'enum' => [ - 'FC', - 'MNS', - 'OPEN_API', - 'SLS', - 'ESS', - 'PAGER_DUTY', - 'WEBHOOK', - 'EB', - 'FC3', - ], - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The maximum number of records to return for this request.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '500', 'minimum' => '0', 'exclusiveMinimum' => false, 'example' => '10', 'title' => '', 'required' => false], ], [ - 'name' => 'alertActionName', + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'serviceType', 'in' => 'query', 'schema' => [ - 'description' => 'Name of the action integration.', + 'description' => 'The service type.', 'type' => 'string', 'required' => false, - 'example' => 'testName', + 'example' => 'TRACE', + 'enum' => ['TRACE', 'XTRACE', 'RUM'], + 'title' => '', ], ], [ - 'name' => 'pageNumber', + 'name' => 'serviceName', 'in' => 'query', - 'schema' => [ - 'description' => 'Page number. Default is 1.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The application service name.', 'type' => 'string', 'example' => 'app-demo', 'title' => '', 'required' => false], ], [ - 'name' => 'pageSize', + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-aekxxzuad5zzzz', 'title' => '', 'required' => false], + ], + [ + 'name' => 'tags', 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'json', 'schema' => [ - 'description' => 'Page size. Default is 100.', - 'type' => 'integer', - 'format' => 'int32', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'evn', 'title' => '', 'required' => false], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'prod', 'title' => '', 'required' => false], + ], + 'title' => '', + 'description' => 'The tag.', + 'required' => false, + 'example' => '', + ], + 'title' => '', + 'description' => 'An array of tags.', 'required' => false, - 'example' => '100', + 'example' => '', ], ], ], @@ -19733,664 +17700,449 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], - 'total' => [ - 'description' => 'Total number of items.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '9', - ], - 'pageNumber' => [ - 'description' => 'Page number.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'pageSize' => [ - 'description' => 'Page size.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'alertActions' => [ - 'description' => 'List of alert action configurations.', + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', 'title' => ''], + 'nextToken' => ['description' => 'The paging token.', 'type' => 'string', 'example' => '2-ba4d-4b9f-aa24-dcb067a30f1c', 'title' => ''], + 'totalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '66', 'title' => ''], + 'maxResults' => ['description' => 'The maximum number of results returned. The maximum value is 200.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'services' => [ + 'description' => 'A list of service information.', 'type' => 'array', 'items' => [ - 'description' => 'List of alert action configurations.', + 'description' => 'The service information.', 'type' => 'object', 'properties' => [ - 'fcParam' => [ - 'description' => 'Function Compute parameters.', - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'service' => [ - 'description' => 'Function Compute service name.', - 'type' => 'string', - 'example' => 'test', - ], - 'function' => [ - 'description' => 'Function name in the Function Compute service.', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - 'ebParam' => [ - 'description' => 'Event Bridge parameters.', - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-heyuan', - ], - 'subject' => [ - 'description' => 'Subject.', - 'type' => 'string', - 'example' => 'test', - ], - 'ebSource' => [ - 'description' => 'Event source.', - 'type' => 'string', - 'example' => 'test', - ], - 'eventBusName' => [ - 'description' => 'Event bus name.', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - 'alertActionId' => [ - 'description' => 'Unique identifier for the action integration.', - 'type' => 'string', - 'example' => 'test', - ], - 'slsParam' => [ - 'description' => 'Log Service parameters.', - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'project' => [ - 'description' => 'Log Service project name.', - 'type' => 'string', - 'example' => 'test', - ], - 'logstore' => [ - 'description' => 'Logstore name of the Log Service.', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - 'fc3Param' => [ - 'description' => 'Function Compute 3.0 parameters.', - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-qingdao', - ], - 'function' => [ - 'description' => 'Function name of the Function Compute service.', - 'type' => 'string', - 'example' => 'test', - ], - 'qualifier' => [ - 'description' => 'Version or alias of the function.', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - 'mnsParam' => [ - 'description' => 'Lightweight Message Queue (formerly MNS) parameters.', - 'type' => 'object', - 'properties' => [ - 'mnsType' => [ - 'description' => 'Resource type of the Lightweight Message Queue (formerly MNS).', - 'type' => 'string', - 'example' => 'queue', - ], - 'regionId' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'name' => [ - 'description' => 'Resource name.'."\n" - ."\n" - .'- If the resource type is queue, the resource name is the queue name.'."\n" - .'- If the resource type is topic, the resource name is the topic name.', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - 'pagerDutyParam' => [ - 'description' => 'PagerDuty parameters', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => 'Integration key for PagerDuty.', - 'type' => 'string', - 'example' => 'fsfer4543t5t65g4t4', - ], - 'url' => [ - 'description' => 'Integration webhook for PagerDuty. Supports V1 and V2 versions.', - 'type' => 'string', - 'example' => 'https://events.pagerduty.com/v2/enqueue', - ], - ], - ], - 'type' => [ - 'description' => 'Action integration type.', - 'type' => 'string', - 'example' => 'FC', - ], - 'webhookParam' => [ - 'description' => 'Webhook parameters', - 'type' => 'object', - 'properties' => [ - 'headers' => [ - 'description' => 'Request headers.', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{\'X-Total-Count\': 0}', - 'description' => 'Request headers.', - ], - ], - 'method' => [ - 'description' => 'Webhook request method.', - 'type' => 'string', - 'example' => 'GET', - ], - 'contentType' => [ - 'description' => 'Data format, effective when the request method is POST.', - 'type' => 'string', - 'example' => 'JSON', - ], - 'url' => [ - 'description' => 'The URL address for the alarm callback.', - 'type' => 'string', - 'example' => 'http://www.test.com', - ], - ], - ], - 'essParam' => [ - 'description' => 'Elastic scaling parameters.', - 'type' => 'object', - 'properties' => [ - 'essGroupId' => [ - 'description' => 'Elastic scaling group ID.', - 'type' => 'string', - 'example' => 'testId', - ], - 'regionId' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'essRuleId' => [ - 'description' => 'Elastic scaling rule ID.', - 'type' => 'string', - 'example' => 'testId', - ], - ], - ], - 'alertActionName' => [ - 'description' => 'Alert action name.', - 'type' => 'string', - 'example' => 'testName', - ], + 'serviceId' => ['description' => 'The service ID.', 'type' => 'string', 'example' => 'jm2pl0yoqf@d4905cb11a4f218dfb0a8', 'title' => ''], + 'serviceName' => ['description' => 'The service name.', 'type' => 'string', 'example' => 'demo-app', 'title' => ''], + 'createTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2025-07-01T02:23:59Z', 'title' => ''], + 'serviceType' => ['description' => 'The service type.', 'type' => 'string', 'example' => 'TRACE', 'title' => ''], + 'serviceStatus' => ['description' => 'The service status. This parameter is valid only when serviceType is RUM.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'displayName' => ['description' => 'The display name. This parameter is valid only when serviceType is RUM.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'pid' => ['description' => 'The ID of the ARMS application for backward compatibility.', 'type' => 'string', 'example' => 'kgcsf@192197e828d51aa', 'title' => ''], + 'description' => ['description' => 'The service description. This parameter is valid only when serviceType is RUM.', 'type' => 'string', 'example' => 'workspace api monitor test', 'title' => ''], + 'attributes' => ['description' => 'Additional information.', 'type' => 'string', 'example' => '{"language":"java"}', 'title' => ''], + 'workspace' => ['description' => 'The workspace.', 'type' => 'string', 'example' => 'default-cms-1192928460540589-cn-hangzhou', 'title' => ''], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-aekxxzuad5zzzz', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'Query Alert Action Integration', - 'translator' => 'machine', - ], - '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' => 'Batch Query Application Observability Services', + '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' => 'Queries the tags attached to resources.', + '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' => ['description' => 'The resource type.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'Service'], + ], + [ + 'name' => 'resourceId', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'type' => 'array', + 'items' => ['description' => 'The resource ID.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], 'required' => false, - 'example' => 'workspace-test', + 'title' => '', + 'description' => 'A list of resource IDs.', + 'example' => '', ], ], [ - 'name' => 'body', - 'in' => 'body', - 'allowEmptyValue' => false, + 'name' => 'tag', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', + 'type' => 'array', + 'items' => ['description' => 'The tags. These are used as filter conditions for the query.'."\n" + ."\n" + .'You can specify up to 20 tags.', '$ref' => '#/components/schemas/Tag', 'required' => false, 'title' => '', 'example' => ''], + 'title' => '', + 'description' => 'The tags. These are used as filter conditions for the query.'."\n" + ."\n" + .'You can specify up to 20 tags.', 'required' => false, - '$ref' => '#/components/schemas/SubscriptionForModify', + 'example' => '', ], ], [ - 'name' => 'subscriptionId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123123123123', - ], + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token that is used to start the next query.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'xxxxxxxxxx'], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of results to return. The maximum value is 200.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], ], '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' => '0CEC5375-C554-562B-A65F-******', - ], - 'subscriptionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123123123123', + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0CEC5375-C554-562B-A65F-***'], + 'maxResults' => ['description' => 'The maximum number of results to return. The maximum value is 200.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'], + 'nextToken' => ['description' => 'The token that is used to start the next query.', 'type' => 'string', 'title' => '', 'example' => 'xxxxxxxxxx'], + 'tagResources' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'tagKey' => ['description' => 'The tag key.', 'type' => 'string', 'title' => '', 'example' => 'env'], + 'tagValue' => ['description' => 'The tag value.', 'type' => 'string', 'title' => '', 'example' => 'test'], + 'resourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'title' => '', 'example' => 'test'], + 'resourceType' => ['description' => 'The resource type.', 'type' => 'string', 'title' => '', 'example' => 'Service'], + ], + 'description' => 'A list of tags.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'description' => 'A list of tags.', + 'example' => '', ], ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], ], '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' => 'ListTagResources', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-******\\",\\n \\"subscriptionId\\": \\"123123123123\\"\\n}","type":"json"}]', - 'title' => 'UpdateSubscription', + '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' => [ + 'summary' => 'Retrieves a list of workspaces.', + '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' => 'The name of the workspace. This parameter supports fuzzy search.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'workspace-test-001'], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token for the next page of results.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'xxxxxxxxxx'], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page. Default value: 50. Maximum value: 50.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '0', 'default' => '100', 'title' => '', 'example' => '10'], + ], + [ + 'name' => 'workspaceNameList', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'contentType' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh_CN', - 'enum' => [ - 'zh_CN', - 'en_US', - ], - ], - 'method' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'GET', - 'default' => 'POST', - 'enum' => [ - 'GET', - 'POST', - ], - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - 'url' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'https://aliyun.com/test', - ], - 'webhookId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], + 'description' => 'The names of the workspaces. This parameter supports exact search.', + 'type' => 'array', + 'items' => ['description' => 'The name of a workspace. This parameter supports exact search.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'workspace-test-001'], 'required' => false, + 'example' => 'workspace-test-001', + 'title' => '', ], ], + [ + 'name' => 'region', + 'in' => 'query', + 'schema' => ['description' => 'The region.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-heyuan'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'alertWebhookId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', + 'maxResults' => ['description' => 'The number of entries returned per page. Default value: 50. Maximum value: 50.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'nextToken' => ['description' => 'The token for the next page of results.', 'type' => 'string', 'title' => '', 'example' => 'xxxxxxxxxx'], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'total' => ['title' => '当总结果个数大于MaxResults时，用于翻页的token。', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'workspaces' => [ + 'title' => '数组，返回示例目录。', + 'description' => 'The list of workspaces.', + 'type' => 'array', + 'items' => [ + 'title' => 'WorkspaceItemType', + 'description' => 'WorkspaceItemType', + 'type' => 'object', + 'properties' => [ + 'createTime' => ['description' => 'The time when the workspace was created.', 'type' => 'string', 'format' => 'iso8601_normal', 'title' => '', 'example' => '2025-03-11T08:21:58Z'], + 'displayName' => ['description' => 'The display name of the workspace.', 'type' => 'string', 'title' => '', 'example' => 'workspace-test'], + 'description' => ['title' => '工作空间描述', 'description' => 'The description of the workspace.', 'type' => 'string', 'pattern' => '', 'default' => '', 'example' => 'workspace test'], + 'lastModifyTime' => ['description' => 'The time when the workspace was last modified.', 'type' => 'string', 'format' => 'iso8601_normal', 'title' => '', 'example' => '2025-03-11T08:21:58Z'], + 'regionId' => ['title' => '地域ID', 'description' => 'The ID of the region.', 'type' => 'string', 'pattern' => '', 'default' => '', 'example' => 'cn-heyuan'], + 'slsProject' => ['title' => '日志服务项目名称', 'description' => 'The name of the Simple Log Service project.', 'type' => 'string', 'pattern' => '', 'default' => '', 'example' => 'sls-project-test-001'], + 'workspaceName' => ['title' => '工作空间名称', 'description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'pattern' => '', 'default' => '', 'example' => 'workspace-test-001'], + ], + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => 'Resource already exist .', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => '%s is missing or invalid.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get Workspace List', + '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' => 'CreateAlertWebhook', + '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' => 'Manages alert rules.', + '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' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'required' => true, - ], + 'schema' => ['description' => 'The request body for managing alert rules. This body is shared by CREATE, UPDATE, PATCH, and BATCH_DELETE operations. Specify fields based on the action.', '$ref' => '#/components/schemas/ManageAlertRulesUnifiedActionInput', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'E5B1D3D4-BB28-5996-8AD2-***********', - ], - ], - ], + 'schema' => ['description' => 'The response for managing alert rules.', '$ref' => '#/components/schemas/ServerResponseManageAlertRulesResult', 'title' => '', 'example' => ''], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => '%s is missing or invalid.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'The parameter is missing or invalid. %s', 'description' => 'The parameter is invalid.'], + ], + 403 => [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 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' => 'A service runtime error occurred.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Manage alert rules', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E5B1D3D4-BB28-5996-8AD2-***********\\"\\n}","type":"json"}]', - 'title' => 'DeleteAlertWebhooks', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"alertRule\\": {\\n \\"uuid\\": \\"\\",\\n \\"createdAt\\": \\"\\",\\n \\"updatedAt\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"workspace\\": \\"\\",\\n \\"displayName\\": \\"\\",\\n \\"contentTemplate\\": \\"\\",\\n \\"enabled\\": false,\\n \\"datasourceConfig\\": {\\n \\"type\\": \\"\\",\\n \\"instanceId\\": \\"\\",\\n \\"regionId\\": \\"\\",\\n \\"productCategory\\": \\"\\",\\n \\"legacyType\\": \\"\\",\\n \\"legacyRaw\\": \\"\\"\\n },\\n \\"queryConfig\\": {\\n \\"type\\": \\"\\",\\n \\"expr\\": \\"\\",\\n \\"promQl\\": \\"\\",\\n \\"enableDataCompleteCheck\\": false,\\n \\"metricSet\\": \\"\\",\\n \\"metric\\": \\"\\",\\n \\"queries\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"metricSet\\": \\"\\",\\n \\"metric\\": \\"\\",\\n \\"labelFilters\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"value\\": \\"\\",\\n \\"operator\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"logSet\\": \\"\\",\\n \\"windowSecs\\": 0,\\n \\"offsetSecs\\": 0,\\n \\"aggregate\\": \\"\\",\\n \\"entityDomain\\": \\"\\",\\n \\"entityType\\": \\"\\",\\n \\"entityFilters\\": [\\n {\\n \\"field\\": \\"\\",\\n \\"operator\\": \\"\\",\\n \\"value\\": \\"\\"\\n }\\n ],\\n \\"labelFilters\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"value\\": \\"\\",\\n \\"operator\\": \\"\\"\\n }\\n ],\\n \\"entityFields\\": [\\n {\\n \\"field\\": \\"\\",\\n \\"value\\": \\"\\"\\n }\\n ],\\n \\"serviceIdList\\": [\\n \\"\\"\\n ],\\n \\"filterList\\": [\\n {\\n \\"key\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"value\\": \\"\\"\\n }\\n ],\\n \\"measureList\\": [\\n {\\n \\"measureCode\\": \\"\\",\\n \\"windowSecs\\": 0,\\n \\"groupBy\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"namespace\\": \\"\\",\\n \\"relationType\\": \\"\\",\\n \\"dimensions\\": [\\n {\\n \\"key\\": \\"\\"\\n }\\n ],\\n \\"groupId\\": \\"\\",\\n \\"legacyType\\": \\"\\",\\n \\"legacyRaw\\": \\"\\"\\n },\\n \\"conditionConfig\\": {\\n \\"type\\": \\"\\",\\n \\"durationSecs\\": 0,\\n \\"severity\\": \\"\\",\\n \\"operator\\": \\"\\",\\n \\"threshold\\": 0,\\n \\"min\\": 0,\\n \\"max\\": 0,\\n \\"aggregate\\": \\"\\",\\n \\"matchField\\": \\"\\",\\n \\"matchOperator\\": \\"\\",\\n \\"matchValue\\": \\"\\",\\n \\"countOperator\\": \\"\\",\\n \\"countThreshold\\": 0,\\n \\"thresholdList\\": [\\n {\\n \\"severity\\": \\"\\",\\n \\"threshold\\": 0,\\n \\"min\\": 0,\\n \\"max\\": 0\\n }\\n ],\\n \\"compareList\\": [\\n {\\n \\"aggregate\\": \\"\\",\\n \\"operator\\": \\"\\",\\n \\"threshold\\": 0,\\n \\"yoyTimeUnit\\": \\"\\",\\n \\"yoyTimeValue\\": 0\\n }\\n ],\\n \\"relation\\": \\"\\",\\n \\"escalationType\\": \\"\\",\\n \\"simpleEscalation\\": {\\n \\"metricName\\": \\"\\",\\n \\"period\\": 0,\\n \\"escalations\\": [\\n {\\n \\"comparisonOperator\\": \\"\\",\\n \\"statistics\\": \\"\\",\\n \\"threshold\\": \\"\\",\\n \\"severity\\": \\"\\",\\n \\"times\\": 0,\\n \\"preCondition\\": \\"\\"\\n }\\n ]\\n },\\n \\"compositeEscalation\\": {\\n \\"relation\\": \\"\\",\\n \\"severity\\": \\"\\",\\n \\"times\\": 0,\\n \\"escalations\\": [\\n {\\n \\"comparisonOperator\\": \\"\\",\\n \\"metricName\\": \\"\\",\\n \\"period\\": 0,\\n \\"statistics\\": \\"\\",\\n \\"threshold\\": \\"\\",\\n \\"preCondition\\": \\"\\"\\n }\\n ]\\n },\\n \\"expressEscalation\\": {\\n \\"times\\": 0,\\n \\"severity\\": \\"\\",\\n \\"rawExpression\\": \\"\\"\\n },\\n \\"prometheus\\": {\\n \\"severity\\": \\"\\",\\n \\"promQl\\": \\"\\",\\n \\"times\\": 0\\n },\\n \\"noDataPolicy\\": \\"\\",\\n \\"legacyType\\": \\"\\",\\n \\"yoyTimeUnit\\": \\"\\",\\n \\"yoyTimeValue\\": 0,\\n \\"triggers\\": [\\n {\\n \\"severity\\": \\"\\",\\n \\"durationSecs\\": 0,\\n \\"expressionType\\": \\"\\",\\n \\"queryName\\": \\"\\",\\n \\"operator\\": \\"\\",\\n \\"threshold\\": 0,\\n \\"min\\": 0,\\n \\"max\\": 0,\\n \\"logicOperator\\": \\"\\",\\n \\"conditions\\": [\\n {\\n \\"expressionType\\": \\"\\",\\n \\"queryName\\": \\"\\",\\n \\"operator\\": \\"\\",\\n \\"threshold\\": 0,\\n \\"min\\": 0,\\n \\"max\\": 0\\n }\\n ]\\n }\\n ],\\n \\"enableSeveritySuppression\\": false,\\n \\"legacyRaw\\": \\"\\"\\n },\\n \\"scheduleConfig\\": {\\n \\"type\\": \\"\\",\\n \\"intervalSecs\\": 0\\n },\\n \\"notifyConfig\\": {\\n \\"type\\": \\"\\",\\n \\"channels\\": [\\n {\\n \\"type\\": \\"\\",\\n \\"identifiers\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"silenceTimeSecs\\": 0,\\n \\"activeDays\\": [\\n 0\\n ],\\n \\"activeStartTime\\": \\"\\",\\n \\"activeEndTime\\": \\"\\",\\n \\"utcOffset\\": \\"\\",\\n \\"notifyStrategies\\": [\\n \\"\\"\\n ]\\n },\\n \\"actionIntegrationConfig\\": {\\n \\"enabled\\": false,\\n \\"actions\\": [\\n \\"\\"\\n ]\\n },\\n \\"armsIntegrationConfig\\": {\\n \\"enabled\\": false\\n },\\n \\"labels\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"annotations\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"datasourceType\\": \\"\\",\\n \\"observeResourceType\\": \\"\\",\\n \\"observeResourceGlobalScope\\": false,\\n \\"observeResourceList\\": [\\n \\"\\"\\n ],\\n \\"severityLevels\\": \\"\\",\\n \\"notifyStrategyId\\": \\"\\",\\n \\"partitionKey\\": \\"\\"\\n },\\n \\"deletedCount\\": 0,\\n \\"deletedUuidList\\": [\\n \\"\\"\\n ],\\n \\"updatedCount\\": 0,\\n \\"updatedUuidList\\": [\\n \\"\\"\\n ]\\n },\\n \\"code\\": \\"\\",\\n \\"success\\": false,\\n \\"requestId\\": \\"\\",\\n \\"message\\": \\"\\",\\n \\"total\\": 0,\\n \\"pageSize\\": 0,\\n \\"pageNumber\\": 0,\\n \\"nextToken\\": \\"\\"\\n}","type":"json"}]', ], - 'ListAlertWebhooks' => [ - 'summary' => '查询Webhook', - 'path' => '/webhooks', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'OpenCmsService' => [ + 'summary' => 'Activates CloudMonitor services, including Hybrid Cloud Monitoring, Managed Service for Prometheus, and Simple Log Service (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' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'enabled' => ['description' => 'Indicates whether the service or commodity is activated.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Activate cloudMonitor services', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'pageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '', - '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' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, + 'title' => 'body参数', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'displayName' => ['title' => '', 'description' => 'The display name of the workspace.', 'type' => 'string', 'required' => false, 'maxLength' => 256, 'example' => 'workspace-test'], + 'description' => ['title' => '工作空间描述', 'description' => 'The description of the workspace.', 'type' => 'string', 'required' => false, 'maxLength' => 256, 'pattern' => '', 'default' => '', 'example' => 'workspace test'], + 'slsProject' => ['title' => '日志服务项目名称', 'description' => 'The name of the Simple Log Service project.', 'type' => 'string', 'required' => true, 'maxLength' => 128, 'minLength' => 1, 'default' => '', 'example' => 'sls-project-test-001'], ], 'required' => false, + 'example' => '', ], ], [ - 'name' => 'name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'maxLength' => 56, 'minLength' => 1, 'title' => '', 'example' => 'workspace-test-001'], ], ], 'responses' => [ @@ -20400,675 +18152,498 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'pageNumber' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'pageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'JSON', - ], - 'headers' => [ - 'description' => 'headers', - 'type' => 'object', - 'example' => 'key', - ], - 'lang' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'zh_CN', - ], - 'method' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'GET', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'url' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://aliyun.com/test', - ], - 'webhookId' => [ - 'description' => '', - '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' => 'The name of the workspace.', 'type' => 'string', 'title' => '', 'example' => 'workspace-test-001'], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => '%s is missing or invalid.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create or Modify Workspace', + 'summary' => 'Creates a workspace.', + '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' => 'ListAlertWebhooks', + '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'name' => 'nextToken', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'The token that marks the position from which you want to start reading data. If you leave this parameter empty, data is read from the beginning.', 'type' => 'string', 'required' => false, 'example' => '123456'], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'The maximum number of data records to read in this request.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'clientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['title' => '', 'description' => 'The idempotency token.', 'type' => 'string', 'required' => false, 'example' => 'xxxxx-xxxx-xxxx'], ], [ 'name' => 'body', - 'in' => 'body', + 'in' => 'formData', 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'contentType' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh_CN', - 'enum' => [ - 'zh_CN', - 'en_US', - ], - ], - 'method' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'GET', - 'enum' => [ - 'GET', - 'POST', - ], - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'url' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'http://aliyun.com/test', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The request body for querying alert rules.', '$ref' => '#/components/schemas/QueryAlertRulesInput', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '8A33DBEA-*****-*****-*****-*****', - ], - ], - ], + 'schema' => ['description' => 'The response for querying alert rules.', '$ref' => '#/components/schemas/ServerResponseQueryAlertRulesResult', 'title' => '', 'example' => ''], ], ], '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' => 'The request parameters are invalid or required parameters are missing (such as GroupName, WorkspaceId, GroupId, or region being empty).'], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'The parameter is missing or invalid. %s', 'description' => 'The parameter is invalid.'], ], - 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' => 'No permission, please use RAM to authorize'], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 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' => 'A service runtime error occurred.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query alert rules', + 'summary' => 'Queries alert rules.', + 'description' => 'This topic provides an example on how to query a list of alert templates. The response shows that the alert template list contains two alert templates: `ECS_Template1` and `ECS_Template2`.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8A33DBEA-*****-*****-*****-*****\\"\\n}","type":"json"}]', - 'title' => 'UpdateAlertWebhook', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"totalCount\\": 0,\\n \\"alertRules\\": [\\n {\\n \\"uuid\\": \\"\\",\\n \\"createdAt\\": \\"\\",\\n \\"updatedAt\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"workspace\\": \\"\\",\\n \\"displayName\\": \\"\\",\\n \\"contentTemplate\\": \\"\\",\\n \\"enabled\\": false,\\n \\"datasourceConfig\\": {\\n \\"type\\": \\"\\",\\n \\"instanceId\\": \\"\\",\\n \\"regionId\\": \\"\\",\\n \\"productCategory\\": \\"\\",\\n \\"legacyType\\": \\"\\",\\n \\"legacyRaw\\": \\"\\"\\n },\\n \\"queryConfig\\": {\\n \\"type\\": \\"\\",\\n \\"expr\\": \\"\\",\\n \\"promQl\\": \\"\\",\\n \\"enableDataCompleteCheck\\": false,\\n \\"metricSet\\": \\"\\",\\n \\"metric\\": \\"\\",\\n \\"queries\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"metricSet\\": \\"\\",\\n \\"metric\\": \\"\\",\\n \\"labelFilters\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"value\\": \\"\\",\\n \\"operator\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"logSet\\": \\"\\",\\n \\"windowSecs\\": 0,\\n \\"offsetSecs\\": 0,\\n \\"aggregate\\": \\"\\",\\n \\"entityDomain\\": \\"\\",\\n \\"entityType\\": \\"\\",\\n \\"entityFilters\\": [\\n {\\n \\"field\\": \\"\\",\\n \\"operator\\": \\"\\",\\n \\"value\\": \\"\\"\\n }\\n ],\\n \\"labelFilters\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"value\\": \\"\\",\\n \\"operator\\": \\"\\"\\n }\\n ],\\n \\"entityFields\\": [\\n {\\n \\"field\\": \\"\\",\\n \\"value\\": \\"\\"\\n }\\n ],\\n \\"serviceIdList\\": [\\n \\"\\"\\n ],\\n \\"filterList\\": [\\n {\\n \\"key\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"value\\": \\"\\"\\n }\\n ],\\n \\"measureList\\": [\\n {\\n \\"measureCode\\": \\"\\",\\n \\"windowSecs\\": 0,\\n \\"groupBy\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"namespace\\": \\"\\",\\n \\"relationType\\": \\"\\",\\n \\"dimensions\\": [\\n {\\n \\"key\\": \\"\\"\\n }\\n ],\\n \\"groupId\\": \\"\\",\\n \\"legacyType\\": \\"\\",\\n \\"legacyRaw\\": \\"\\"\\n },\\n \\"conditionConfig\\": {\\n \\"type\\": \\"\\",\\n \\"durationSecs\\": 0,\\n \\"severity\\": \\"\\",\\n \\"operator\\": \\"\\",\\n \\"threshold\\": 0,\\n \\"min\\": 0,\\n \\"max\\": 0,\\n \\"aggregate\\": \\"\\",\\n \\"matchField\\": \\"\\",\\n \\"matchOperator\\": \\"\\",\\n \\"matchValue\\": \\"\\",\\n \\"countOperator\\": \\"\\",\\n \\"countThreshold\\": 0,\\n \\"thresholdList\\": [\\n {\\n \\"severity\\": \\"\\",\\n \\"threshold\\": 0,\\n \\"min\\": 0,\\n \\"max\\": 0\\n }\\n ],\\n \\"compareList\\": [\\n {\\n \\"aggregate\\": \\"\\",\\n \\"operator\\": \\"\\",\\n \\"threshold\\": 0,\\n \\"yoyTimeUnit\\": \\"\\",\\n \\"yoyTimeValue\\": 0\\n }\\n ],\\n \\"relation\\": \\"\\",\\n \\"escalationType\\": \\"\\",\\n \\"simpleEscalation\\": {\\n \\"metricName\\": \\"\\",\\n \\"period\\": 0,\\n \\"escalations\\": [\\n {\\n \\"comparisonOperator\\": \\"\\",\\n \\"statistics\\": \\"\\",\\n \\"threshold\\": \\"\\",\\n \\"severity\\": \\"\\",\\n \\"times\\": 0,\\n \\"preCondition\\": \\"\\"\\n }\\n ]\\n },\\n \\"compositeEscalation\\": {\\n \\"relation\\": \\"\\",\\n \\"severity\\": \\"\\",\\n \\"times\\": 0,\\n \\"escalations\\": [\\n {\\n \\"comparisonOperator\\": \\"\\",\\n \\"metricName\\": \\"\\",\\n \\"period\\": 0,\\n \\"statistics\\": \\"\\",\\n \\"threshold\\": \\"\\",\\n \\"preCondition\\": \\"\\"\\n }\\n ]\\n },\\n \\"expressEscalation\\": {\\n \\"times\\": 0,\\n \\"severity\\": \\"\\",\\n \\"rawExpression\\": \\"\\"\\n },\\n \\"prometheus\\": {\\n \\"severity\\": \\"\\",\\n \\"promQl\\": \\"\\",\\n \\"times\\": 0\\n },\\n \\"noDataPolicy\\": \\"\\",\\n \\"legacyType\\": \\"\\",\\n \\"yoyTimeUnit\\": \\"\\",\\n \\"yoyTimeValue\\": 0,\\n \\"triggers\\": [\\n {\\n \\"severity\\": \\"\\",\\n \\"durationSecs\\": 0,\\n \\"expressionType\\": \\"\\",\\n \\"queryName\\": \\"\\",\\n \\"operator\\": \\"\\",\\n \\"threshold\\": 0,\\n \\"min\\": 0,\\n \\"max\\": 0,\\n \\"logicOperator\\": \\"\\",\\n \\"conditions\\": [\\n {\\n \\"expressionType\\": \\"\\",\\n \\"queryName\\": \\"\\",\\n \\"operator\\": \\"\\",\\n \\"threshold\\": 0,\\n \\"min\\": 0,\\n \\"max\\": 0\\n }\\n ]\\n }\\n ],\\n \\"enableSeveritySuppression\\": false,\\n \\"legacyRaw\\": \\"\\"\\n },\\n \\"scheduleConfig\\": {\\n \\"type\\": \\"\\",\\n \\"intervalSecs\\": 0\\n },\\n \\"notifyConfig\\": {\\n \\"type\\": \\"\\",\\n \\"channels\\": [\\n {\\n \\"type\\": \\"\\",\\n \\"identifiers\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"silenceTimeSecs\\": 0,\\n \\"activeDays\\": [\\n 0\\n ],\\n \\"activeStartTime\\": \\"\\",\\n \\"activeEndTime\\": \\"\\",\\n \\"utcOffset\\": \\"\\",\\n \\"notifyStrategies\\": [\\n \\"\\"\\n ]\\n },\\n \\"actionIntegrationConfig\\": {\\n \\"enabled\\": false,\\n \\"actions\\": [\\n \\"\\"\\n ]\\n },\\n \\"armsIntegrationConfig\\": {\\n \\"enabled\\": false\\n },\\n \\"labels\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"annotations\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"datasourceType\\": \\"\\",\\n \\"observeResourceType\\": \\"\\",\\n \\"observeResourceGlobalScope\\": false,\\n \\"observeResourceList\\": [\\n \\"\\"\\n ],\\n \\"severityLevels\\": \\"\\",\\n \\"notifyStrategyId\\": \\"\\",\\n \\"partitionKey\\": \\"\\"\\n }\\n ]\\n },\\n \\"code\\": \\"\\",\\n \\"success\\": false,\\n \\"requestId\\": \\"\\",\\n \\"message\\": \\"\\",\\n \\"total\\": 0,\\n \\"pageSize\\": 0,\\n \\"pageNumber\\": 0,\\n \\"nextToken\\": \\"\\"\\n}","type":"json"}]', ], - 'UpdateNotifyStrategy' => [ - 'summary' => '修改已存在的告警通知策略', - 'path' => '/notifyStrategies/{notifyStrategyId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'SearchContext' => [ + 'summary' => 'Search context.', + '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' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'workspace-test', - 'title' => '工作空间', - ], + 'in' => 'path', + 'schema' => ['description' => 'Workspace ID', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => 'Context store name', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-context-store', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', - 'allowEmptyValue' => false, + 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request body', + 'type' => 'object', + 'properties' => [ + 'query' => ['description' => 'Query content', 'type' => 'string', 'required' => true, 'example' => 'How is the cost for consuming SLS logs in Flink calculated?', 'title' => ''], + 'formatted' => ['description' => 'Whether to format', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'filter' => [ + 'description' => 'Filter conditions', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'Filter conditions', 'type' => 'any', 'example' => '{'."\n" + .' "metadata.serviceName": "sls-sop-daily",'."\n" + .' "metadata.taskType": {'."\n" + .' "in": ["troubleshooting", "knowledge_retrieval"]'."\n" + .' }', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'limit' => ['description' => 'Limit the number of items returned', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + 'threshold' => ['description' => 'Similarity threshold', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.3', 'title' => ''], + 'retrievalOption' => ['description' => 'Retrieval option', 'type' => 'string', 'required' => false, 'example' => 'reranker,llm_rank', 'title' => ''], + ], 'required' => false, - '$ref' => '#/components/schemas/NotifyStrategyForModify', - ], - ], - [ - 'name' => 'notifyStrategyId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12312-31-23-123-1-23123', - 'title' => '通知策略ID', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response data', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], - 'notifyStrategyId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '12312-31-23-123-1-23123', - 'title' => '通知策略ID', + 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '123-0F43-23423-AC43-34234', 'title' => ''], + 'results' => [ + 'description' => 'Return value', + 'type' => 'array', + 'items' => [ + 'description' => 'Return value', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Return value', 'type' => 'any', 'example' => '{}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + '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' => 'Search context', + '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' => 'UpdateNotifyStrategy', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"123-0F43-23423-AC43-34234\\",\\n \\"results\\": [\\n {\\n \\"key\\": \\"{}\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'CreateTicket' => [ - 'summary' => 'Create Ticket', - 'path' => '/tickets', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'SearchMemories' => [ + 'summary' => 'Searches for memories based on query conditions and filters.', + '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' => '- Expiration time (in seconds), which is the expiration time for the embedded page URL. The default value is 86400 seconds (one day), and the range of values is from 0 to 2592000 seconds (30 days).', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '86400', - ], + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'accessTokenExpirationTime', - 'in' => 'query', + 'name' => 'memoryStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The memory store name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'qianyi_test_1', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '- Access token expiration time (in seconds), which is the expiration time for the user to access the page interface. The default value is 86400 seconds (one day), and the range of values is from 0 to 86400 seconds (one day).'."\n" - .'- The access token expiration time is the minimum value between `accessTokenExpirationTime` and `expirationTime`.'."\n" - .'- If called through STS, the access token expiration time (i.e., the time during which the user can access the page interface) is the minimum value among `accessTokenExpirationTime`, `expirationTime`, and the STS expiration time.', - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'query' => ['description' => 'The query content.', 'type' => 'string', 'required' => false, 'example' => 'What I like', 'title' => ''], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'required' => false, 'example' => 'test_session_001', 'title' => ''], + 'topK' => ['description' => 'The top-K entries to return in the results.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'agentId' => ['description' => 'The agent ID.', 'type' => 'string', 'required' => false, 'example' => '972772996913709056', 'title' => ''], + 'appId' => ['description' => 'The app key of the project assigned by the merchant.', 'type' => 'string', 'required' => false, 'example' => 'mm_480d961a1b5e4efe84603f4cbc0f', 'title' => ''], + 'runId' => ['description' => 'The run ID.', 'type' => 'string', 'required' => false, 'example' => 'test_session_001', 'title' => ''], + 'rerank' => ['description' => 'Specifies whether to enable reranking.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'filters' => [ + 'title' => '', + 'description' => 'The filter conditions.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['title' => '', 'description' => 'The filter conditions.', 'type' => 'any', 'example' => '{"__strategy_type__":"Fact"}'], + 'example' => '', + ], + 'threshold' => ['title' => '', 'description' => 'The similarity threshold.', 'type' => 'number', 'format' => 'double', 'example' => '0.3', 'required' => false], + 'retrievalOption' => ['title' => '', 'description' => 'The retrieval option.', 'type' => 'string', 'example' => 'reranker,llm_rank', 'required' => false], + 'searchType' => ['title' => '', 'description' => 'The search type.', 'type' => 'string', 'example' => 'experience', 'required' => false], + ], 'required' => false, - 'example' => '600', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Returned structure.', + 'title' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'ticket' => [ - 'title' => 'Id of the request', - 'description' => '免登录票据。', - 'type' => 'string', - 'example' => 'eyJ***************.eyJ******************.KUT****************', + 'results' => [ + 'description' => 'The returned results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned results.', + 'type' => 'object', + 'properties' => [ + 'actorId' => ['description' => 'The actor ID.', 'type' => 'string', 'example' => 'test_session_001', 'title' => ''], + 'agentId' => ['description' => 'The agent ID of the application.', 'type' => 'string', 'example' => '972772996913709056', 'title' => ''], + 'createdAt' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '1762773128968', 'title' => ''], + 'hash' => ['description' => 'The memory hash value.', 'type' => 'string', 'example' => 'd791bf27236c5532056a13279baad3517042bb8d5b1bdb02e7871fa632debffe', 'title' => ''], + 'id' => ['description' => 'The memory ID.', 'type' => 'string', 'example' => '019ca1e5-7307-7d50-b943-5e628326a8ed', 'title' => ''], + 'memory' => ['description' => 'The memory content.', 'type' => 'string', 'example' => 'My name is Zhang San and I live in Hangzhou.', 'title' => ''], + 'metadata' => [ + 'title' => '', + 'description' => 'The metadata.', + 'type' => 'object', + 'additionalProperties' => ['title' => '', 'description' => 'The metadata.', 'type' => 'any', 'example' => '{"__strategy_type__":"Fact"}'], + 'example' => '{"__strategy_type__":"Fact"}', + ], + 'role' => ['description' => 'The role that initiated the message.', 'type' => 'string', 'example' => 'user', 'title' => ''], + 'runId' => ['description' => 'The run ID.', 'type' => 'string', 'example' => 'test_session_001', 'title' => ''], + 'score' => ['description' => 'The similarity score.', 'type' => 'number', 'format' => 'double', 'example' => '13.21', 'title' => ''], + 'updatedAt' => ['description' => 'The update time.', 'type' => 'string', 'example' => '1764902557784', 'title' => ''], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => 'test_session_001', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'relations' => [ + 'description' => 'The relations.', + 'type' => 'array', + 'items' => [ + 'description' => 'The relations.', + 'type' => 'object', + 'properties' => [ + 'destination' => ['description' => 'The destination.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'relationship' => ['description' => 'The relations.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'source' => ['description' => 'The source.', 'type' => 'string', 'example' => 'todo_open_dingoj06pvqfeayy3lkr', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Search memories', + 'description' => 'This topic provides an example on how to create a threshold alert rule for the cpu_total metric of the Elastic Computing Service `acs_ecs_dashboard` instance `i-uf6j91r34rnwawoo****`. The alert contact group of the alert rule is `ECS_Group`, the alert rule name is `test123`, the alert rule ID is `a151cd6023eacee2f0978e03863cc1697c89508****`, the statistical method for the Critical level is `Average`, the comparison operator for the Critical level is `GreaterThanOrEqualToThreshold`, the threshold for the Critical level is `90`, and the retry count for the Critical level is `3`.'."\n" + .'> 2024-08-15: Statistics validation is added. Only the Statistics value that corresponds to the metric can be specified. For information about how to obtain the value of this parameter, see [Cloud service monitoring metrics](https://www.alibabacloud.com/help/en/cms/support/appendix-1-metrics).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ticket\\": \\"eyJ***************.eyJ******************.KUT****************\\"\\n}","type":"json"}]', - 'title' => 'Create Login-free Ticket', - 'translator' => 'machine', + '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', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'resourceType' => [ - 'title' => '资源类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Service', - ], + 'resourceType' => ['description' => 'The resource type.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'Service'], 'resourceId' => [ - 'title' => '资源ID,最多 50个子项', - 'description' => '', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'items' => ['description' => 'A resource ID.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], 'required' => true, 'maxItems' => 50, 'minItems' => 1, + 'title' => '', + 'description' => 'A list of resource IDs.', + 'example' => '', ], 'tag' => [ - 'title' => '对应新增标签列表，最多包含20个子项', - 'description' => '', 'type' => 'array', - 'items' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/Tag', - ], + 'items' => ['description' => 'A tag.', '$ref' => '#/components/schemas/Tag', 'required' => false, 'title' => '', 'example' => ''], 'required' => false, 'maxItems' => 20, + 'title' => '', + 'description' => 'The tags.'."\n" + ."\n" + .'You can attach a maximum of 20 tags.', + 'example' => '', ], ], 'required' => false, + 'description' => 'The request body.', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '3B311FD9-A60B-55E0-A896-A0C73*********', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '3B311FD9-A60B-55E0-A896-A0C73*********'], ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], ], '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' => 'TagResources', + 'summary' => 'Adds tags to one or more resources.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:TagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3B311FD9-A60B-55E0-A896-A0C73*********\\"\\n}","type":"json"}]', ], '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' => ['description' => 'The resource type.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'Service'], ], [ 'name' => 'resourceId', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '资源ID,最多 50个子项', - 'description' => '', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'items' => ['description' => 'The resource ID.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], 'required' => true, 'maxItems' => 50, 'minItems' => 1, + 'title' => '', + 'description' => 'A list of resource IDs.', + 'example' => '', ], ], [ @@ -21076,374 +18651,476 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '对应标签键列表，最多包含20个子项', - 'description' => '', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'env', - ], + 'items' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'env', 'title' => ''], + 'title' => '', + 'description' => 'The tag key.'."\n" + ."\n" + .'You can detach tags with up to 20 tag keys.', 'required' => false, + 'example' => '', ], ], [ 'name' => 'all', 'in' => 'query', - 'schema' => [ - 'title' => '是否全部删除，只针对tags为空时有效。取值范围： true false True False 默认是 false', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'schema' => ['description' => 'Specifies whether to remove all tags from the specified resources. Valid values:'."\n" + ."\n" + .'false (default): No'."\n" + .'true: Yes', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'false'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], ], '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' => 'UntagResources', + 'summary' => 'Deletes a tag', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:UntagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', ], - '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' => 'The name of the 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' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'addonVersion' => ['title' => 'Addon 的版本信息。', 'description' => 'The version of the add-on.', 'type' => 'string', 'required' => false, 'example' => '0.0.2'], + 'dryRun' => [ + 'title' => '是否预检本次请求。', + 'description' => 'Specifies whether to perform a dry run for the request.', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => ['true' => 'Performs a dry run.', 'false' => 'Performs the actual request.'], + 'example' => 'true', + ], + 'values' => ['title' => '元数据信息。', 'description' => 'The metadata.', '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' => 'The entity discovery rules.', 'required' => false, '$ref' => '#/components/schemas/EntityDiscoverRule', 'example' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'tag', - 'in' => 'query', - 'style' => 'json', + 'name' => 'policyId', + 'in' => 'path', + 'schema' => ['title' => '策略环境 ID。', 'description' => 'The ID of the policy environment.', 'type' => 'string', 'required' => true, 'example' => 'policy-xxxxxxxxxxxx'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '对应新增标签列表，最多包含20个子项', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/Tag', + 'title' => 'Schema of Response', + 'description' => 'The data returned.', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9F00A7AF-2728-5424-B321-79D39C00A1EC'], ], - 'required' => false, + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update Access Component Configuration', + 'summary' => 'Upgrades an add-on component.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAddonRelease'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'nextToken', - 'in' => 'query', - 'schema' => [ - 'title' => '下一个查询开始Token', - 'description' => '', - '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' => [ + 'summary' => 'Updates an aggregation task group.', + 'path' => '/prometheus-instances/{instanceId}/agg-task-groups/{groupId}', + 'methods' => ['put'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'maxResults', - 'in' => 'query', - 'schema' => [ - 'description' => '', - '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' => 'The ID of the Prometheus instance to which the aggregation task group belongs. The aggregation task reads data from this instance.', 'type' => 'string', 'required' => true, 'example' => 'rw-pq4apob9jm'], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => ['title' => '聚合任务组 id', 'description' => 'The ID of the aggregation task group.', 'type' => 'string', 'required' => true, 'example' => 'aggTaskGroup-xxxx'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '入参结构体', + 'description' => 'The request parameters.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求id', - 'description' => '', + 'aggTaskGroupConfig' => ['title' => '聚合任务组配置。目前仅支持 “RecordingRuleYaml” 格式，要求符合开源 Prometheus 的 RecordingRule 的格式要求', 'description' => 'The configuration of the aggregation task group. Currently, only the RecordingRuleYaml format is supported. The configuration must comply with the RecordingRule format of open source Prometheus.', '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' => 'The type of the aggregation task group configuration. The default value is RecordingRuleYaml, which is the RecordingRule format of open source Prometheus.', 'type' => 'string', 'required' => false, 'default' => 'RecordingRuleYaml', 'example' => 'RecordingRuleYaml'], + 'aggTaskGroupName' => ['title' => '聚合任务组名称', 'description' => 'The name of the aggregation task group.', 'type' => 'string', 'required' => false, 'example' => 'test-group'], + 'cronExpr' => ['title' => '调度模式选择“Cron”情况下，具体的调度表达式。例如“0/1 * * * *”，表示从 0 分开始，每隔 1 分钟调度一次', 'description' => 'The cron expression for scheduling when the scheduling mode is set to Cron. For example, \\`0/1 \\* \\* \\* \\*\\` indicates that the task is scheduled every 1 minute, starting from the 0th minute.', 'type' => 'string', 'required' => false, 'example' => '0/1 * * * *'], + 'delay' => ['title' => '调度的固定延迟时间，单位：秒，默认 30', 'description' => 'The fixed delay for scheduling. Unit: seconds. The default value is 30.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '120', 'minimum' => '0', 'default' => '30', 'example' => '30'], + 'description' => ['title' => '聚合任务组描述', 'description' => 'The description of the aggregation task group.', 'type' => 'string', 'required' => false, 'example' => 'desc'], + 'fromTime' => ['title' => '调度开始时间对应的的秒级时间戳', 'description' => 'The UNIX timestamp in seconds that indicates the start time of the scheduling.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1724996015'], + 'maxRetries' => ['title' => '执行聚合任务的最大重试次数，默认 20', 'description' => 'The maximum number of retries to execute the aggregation task. The default value is 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '20', 'example' => '20'], + 'maxRunTimeInSeconds' => ['title' => '执行聚合任务的最大重试时间，单位：秒，默认 600', 'description' => 'The maximum retry time to execute the aggregation task. Unit: seconds. The default value is 600.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '600', 'example' => '600'], + 'precheckString' => ['title' => '预检测配置，默认不配置。输入的字符串需要能被正确 JSON 解析', 'description' => 'The dry run configuration. This parameter is not configured by default. The input string must be a valid JSON string.', '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' => 'The scheduling mode. Valid values: Cron and FixedRate. The default value is FixedRate.', 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-***', - ], - 'maxResults' => [ - 'title' => '列表最大数量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', + 'required' => false, + 'default' => 'FixedRate', + 'enum' => ['FixedRate', 'Cron'], + 'example' => 'FixedRate', ], - 'nextToken' => [ - 'title' => '下一个查询开始Token', - 'description' => '', + 'scheduleTimeExpr' => ['title' => '调度时间表达式，推荐 “@s” 或者 “@m”，表示调度时间窗口对齐的粒度，默认 “@m”', 'description' => 'The scheduling time expression. Recommended values are \\`@s\\` and \\`@m\\`. This expression indicates the granularity at which the scheduling time window is snapped. The default value is \\`@m\\`.', 'type' => 'string', 'required' => false, 'default' => '@m', 'example' => '@m'], + 'status' => [ + 'title' => '聚合任务组状态，“Running” 或者 “Stopped”。默认 Running', + 'description' => 'The status of the aggregation task group. Valid values: Running and Stopped. The default value is Running.', 'type' => 'string', - 'example' => 'xxxxxxxxxx', + 'required' => false, + 'default' => 'Running', + 'enum' => ['Running', 'Stopped'], + 'example' => 'Running', ], - 'tagResources' => [ - 'title' => '资源列表', - 'description' => '', + 'tags' => [ + 'title' => '资源组标签', + 'description' => 'The tags of the resource group.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The tag.', 'type' => 'object', 'properties' => [ - 'tagKey' => [ - 'title' => '标签键', - 'description' => '', - 'type' => 'string', - 'example' => 'env', - ], - 'tagValue' => [ - 'title' => '标签值', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'resourceId' => [ - 'title' => '资源ID', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'resourceType' => [ - 'title' => '资源类型', - 'description' => '', - 'type' => 'string', - 'example' => 'Service', - ], + 'key' => ['title' => '资源组标签的键', 'description' => 'The key of the resource group tag.', 'type' => 'string', 'required' => false, 'example' => 'key1'], + 'value' => ['title' => '资源组标签的值', 'description' => 'The value of the resource group tag.', 'type' => 'string', 'required' => false, 'example' => 'value1'], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'example' => '', ], + 'targetPrometheusId' => ['title' => '聚合任务组的目标 Prometheus 实例 id', 'description' => 'The ID of the target Prometheus instance for the aggregation task group.', 'type' => 'string', 'required' => true, 'example' => 'rw-pq4apob9jm'], + 'toTime' => ['title' => '调度结束时间对应的秒级时间戳，0 表示不停止调度', 'description' => 'The UNIX timestamp in seconds that indicates the end time of the scheduling. A value of 0 indicates that the scheduling does not stop.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], ], + 'required' => false, + 'example' => '', ], ], ], - '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' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '请求 id', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'aggTaskGroupConfigHash' => ['title' => '聚合任务组配置的摘要', 'description' => 'The summary of the aggregation task group configuration.', 'type' => 'string', 'example' => 'a54136014dc386a92c83a6ef1e97ff22'], + 'aggTaskGroupId' => ['title' => '聚合任务组 id', 'description' => 'The ID of the aggregation task group.', 'type' => 'string', 'example' => 'aggTaskGroup-5fb2c3ade63a4709bcb059d13493b7b8'], + 'aggTaskGroupName' => ['title' => '聚合任务组名称', 'description' => 'The name of the aggregation task group.', 'type' => 'string', 'example' => 'pipeline-aggtask-group'], + 'sourcePrometheusId' => ['title' => '聚合任务组的源 Prometheus 实例 id', 'description' => 'The ID of the source Prometheus instance for the aggregation task group.', 'type' => 'string', 'example' => 'rw-083e17834e279f8c627fe91a2d72'], + 'status' => ['title' => '聚合任务组的当前状态', 'description' => 'The current status of the aggregation task group.', 'type' => 'string', 'example' => 'Running'], + ], + 'example' => '', ], ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'The operator is not permission for this operate', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + '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"}]', + 'title' => 'Update Aggregation Task Group', + '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.', + ], + ], + 'UpdateAggTaskGroupStatus' => [ + 'summary' => 'Updates the status of an aggregation task group.', + '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' => 'The ID of the Prometheus instance. The aggregation task reads data from this instance.', 'type' => 'string', 'required' => true, 'example' => 'rw-pq4apob9jm'], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => ['title' => '聚合任务组 id', 'description' => 'The ID of the aggregation task group.', 'type' => 'string', 'required' => true, 'example' => 'aggTaskGroup-xxx'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '入参结构体', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'status' => [ + 'title' => '聚合任务组状态，“Running” 或者 “Stopped”。默认 Running', + 'description' => 'The status of the aggregation task group. Valid values are "Running" and "Stopped". The default value is Running.', + 'type' => 'string', + 'required' => true, + 'enum' => ['Running', 'Stopped'], + 'example' => 'Running', + ], + ], + 'required' => false, + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '出参结构体', + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'aggTaskGroupConfigHash' => ['title' => '聚合任务组配置的摘要', 'description' => 'The summary of the aggregation task group configuration.', 'type' => 'string', 'example' => 'a54136014dc386a92c83a6ef1e97ff22'], + 'aggTaskGroupId' => ['title' => '聚合任务组 id', 'description' => 'The ID of the aggregation task group.', 'type' => 'string', 'example' => 'aggTaskGroup-xxx'], + 'aggTaskGroupName' => ['title' => '聚合任务组名称', 'description' => 'The name of the aggregation task group.', 'type' => 'string', 'example' => 'pipeline-aggtask-group'], + 'requestId' => ['title' => '请求 id', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-***'], + 'sourcePrometheusId' => ['title' => '聚合任务组的源 Prometheus 实例 id', 'description' => 'The ID of the source Prometheus instance for the aggregation task group.', 'type' => 'string', 'example' => 'rw-xxx'], + 'status' => ['title' => '聚合任务组的当前状态', 'description' => 'The current status of the aggregation task group.', 'type' => 'string', 'example' => 'Running'], + ], + 'example' => '', + ], + ], ], - '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"}]', - ], - 'ChangeResourceGroup' => [ - 'summary' => '修改资源所属资源组', - 'path' => '/resourcegroup', - 'methods' => [ - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + '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' => 'Update Aggregation Task Group Status', + '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}'], + ], + ], + ], ], + ], + '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' => 'The unique identifier of the webhook.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request struct.', 'type' => 'object', 'properties' => [ - 'resourceType' => [ - 'description' => '', + 'contentType' => [ + 'description' => 'The content type of the data. Supported values:'."\n" + ."\n" + .'- JSON'."\n" + ."\n" + .'- FORM', 'type' => 'string', + 'enum' => ['JSON', 'FORM'], 'required' => false, - 'example' => 'Service', + 'example' => 'JSON', + 'title' => '', ], - 'resourceId' => [ - 'description' => '', + 'headers' => [ + 'description' => 'The headers.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'The header.', 'type' => 'string', 'example' => 'key', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'lang' => [ + 'description' => 'The language. Supported values:'."\n" + ."\n" + .'- zh\\_CN'."\n" + ."\n" + .'- en\\_US', 'type' => 'string', + 'enum' => ['zh_CN', 'en_US'], 'required' => false, - 'example' => 'test', + 'example' => 'zh_CN', + 'title' => '', ], - 'resourceGroupId' => [ - 'description' => '', + 'method' => [ + 'description' => 'The request method. Supported values:'."\n" + ."\n" + .'- GET'."\n" + ."\n" + .'- POST', 'type' => 'string', + 'enum' => ['GET', 'POST'], 'required' => false, - 'example' => 'rg-ae******ey', + 'example' => 'GET', + 'title' => '', ], + 'name' => ['description' => 'The name of the webhook.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'url' => ['description' => 'The URL of the alert callback.', 'type' => 'string', 'required' => false, 'example' => 'http://aliyun.com/test', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -21451,524 +19128,749 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8A33DBEA-*****-*****-*****-*****'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', - ], - 'DescribeRegions' => [ - 'summary' => '查询地域信息列表', - 'path' => '/regions', - 'methods' => [ - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.', 'description' => ''], + ], + 404 => [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource %s is not found.', 'description' => 'The specified resource% s does not exist.'], + ], + 500 => [ + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateAlertWebhook', + 'summary' => 'Updates a 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' => 'The ID of the business trace.', 'type' => 'string', 'required' => false, 'example' => 'e339260ed64c95d', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'ja' => 'ja', - 'en' => 'en', - 'zh' => 'zh', + 'type' => 'object', + 'properties' => [ + 'bizTraceName' => ['description' => 'The name of the business trace.', 'type' => 'string', 'required' => false, 'example' => 'just test', 'title' => ''], + 'workspace' => ['description' => 'The workspace.', 'type' => 'string', 'required' => false, 'example' => 'default-cms-xxxxxxx-cn-hangzhou', 'title' => ''], + 'ruleConfig' => ['description' => 'The list of configuration rules.', '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"]}}]}}]', 'title' => ''], + 'advancedConfig' => ['description' => 'The advanced configuration.', 'type' => 'string', 'required' => false, 'example' => '{"sample":{"strategy":"BY_APP"}}', 'title' => ''], ], - 'example' => 'zh', + 'description' => 'The request body.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], - 'regions' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'localName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'China (Beijing)', - ], - ], - ], - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'bizTraceId' => ['description' => 'The ID of the business trace.', 'type' => 'string', 'example' => 'e339260ed64c95d', 'title' => ''], ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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"}]', - ], - 'GetCmsService' => [ - 'summary' => '获取云监控开通状态', - 'path' => '/cmsservice', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateBizTrace', + 'summary' => 'Modifies a business trace.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpdateBizTrace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'BizTrace', 'arn' => 'acs:cms:{#regionId}:{#accountId}:biztrace/{#BizTraceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"bizTraceId\\": \\"e339260ed64c95d\\"\\n}","type":"json"}]', + ], + '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' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The context store name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-context-store', 'title' => ''], + ], + [ + 'name' => 'contextId', + 'in' => 'path', + 'schema' => ['description' => 'The context ID.', 'type' => 'string', 'required' => true, 'minLength' => 1, 'example' => '897294a7-67a4-4f60-976c-e136edc5f97e', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'content' => ['description' => 'The updated text for the long-term memory.', '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", 'title' => ''], + 'payload' => ['description' => 'The payload to update.', '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" + .' }', 'title' => ''], + 'triggerCondition' => ['description' => 'The trigger condition.', 'type' => 'string', 'required' => false, 'example' => 'Identify and troubleshoot SLs issues', 'title' => ''], + 'experience' => ['description' => 'The experience object.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "taskType": "troubleshooting",'."\n" + .' "complexity": "medium",'."\n" + .' "confidence": 0.95'."\n" + .'}', 'title' => ''], + 'metadata' => ['description' => 'A set of key-value pairs to attach to an object for storing custom information.', 'type' => 'object', 'required' => false, 'example' => '{"sessionId":"test_session_001"}', 'title' => ''], + ], + 'description' => 'The request body.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => ['description' => 'Returns an empty object on success.', 'type' => 'object', 'example' => '{}', 'title' => ''], + ], ], - 'produces' => [ - 'application/json', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateContext', + 'summary' => 'Updates a context.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + ], + 'UpdateContextStore' => [ + 'summary' => 'Modifies the configuration of a context store.', + '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' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the context store.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-context-store', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '空：云产品开通prometheus场景使用。'."\n" - .'prometheus：开通prometheuse服务（按上报量或写入量计费）'."\n" - .'sls：开通sls日志服务', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'prometheus' => 'prometheus', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'config' => [ + 'description' => 'The configuration information.', + 'type' => 'object', + 'properties' => [ + 'metadataField' => [ + 'description' => 'The metadata field.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'The metadata field.', 'type' => 'string', 'example' => '{'."\n" + .' "project": "attributes.project",'."\n" + .' "logstore": "attributes.logstore",'."\n" + .' "agentId": "attributes.agent_id",'."\n" + .' "scene": "attributes.scene"'."\n" + .' }', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'source' => [ + 'description' => 'The reference path.', + 'type' => 'object', + 'properties' => [ + 'startTime' => ['description' => 'The start time.', 'type' => 'string', 'required' => false, 'example' => '1776824891000', 'title' => ''], + 'logstore' => ['description' => 'The name of the Simple Log Service Logstore.', 'type' => 'string', 'required' => false, 'example' => 'sls-test-logstore', 'title' => ''], + 'project' => ['description' => 'The name of the Simple Log Service project.', 'type' => 'string', 'required' => false, 'example' => 'sls-test-project', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'contextType' => ['description' => 'The context type.', 'type' => 'string', 'required' => false, 'example' => 'memory', 'title' => ''], + 'dataset' => [ + 'description' => 'The dataset information.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the dataset.', 'type' => 'string', 'required' => false, 'example' => 'test_dataset', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], ], - 'example' => 'prometheus', - 'enum' => [ - 'prometheus', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Modify context store configuration', + 'description' => 'Only Alibaba Cloud accounts that have activated Network Analysis and Monitoring can create one-time detection tasks.'."\n" + ."\n" + .'This topic provides an example of how to create a one-time detection task. The detection task is named `task1`, the detection address is `http://www.aliyun.com`, the detection type is `HTTP`, and the number of detection points is `1`.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + ], + 'UpdateDataset' => [ + 'summary' => 'Updates a dataset.', + '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' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'datasetName', + 'in' => 'path', + 'schema' => ['description' => 'The dataset name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test_dataset', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '空：云产品开通prometheus场景使用。'."\n" - .'prometheus：检查上报量计费的prometheus是否开通。'."\n" - .'prometheusgb：检查写入量计费的prometheus是否开通。'."\n" - .'ackpro：检查容器监控pro是否开通。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'prometheusgb' => 'prometheusgb', - 'promethues' => 'promethues', - 'ackpro' => 'ackpro', - ], - 'example' => 'prometheus', - 'enum' => [ - 'prometheus', - 'prometheusgb', - 'promethues', - 'ackpro', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'The new description for the dataset.', 'type' => 'string', 'required' => false, 'example' => 'test dataset', 'title' => ''], ], + 'description' => 'The request body.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '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' => '', - 'type' => 'string', - 'example' => 'PROM_NOT_OPEN', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], ], - 'errorCodes' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateDataset', + '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"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', ], - 'CreateBizTrace' => [ - 'summary' => '创建业务链路', - 'path' => '/bizTrace', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateDeliveryTask' => [ + 'summary' => 'Updates a data delivery task. The update uses patch semantics: fields that are not specified remain unchanged.', + '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' => 'The task ID.', 'type' => 'string', 'required' => true, 'example' => '6afe16bece7996a3', 'title' => ''], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body. All fields are optional. Specify only the fields that you want to update.', 'type' => 'object', 'properties' => [ - 'workspace' => [ - 'description' => '', + 'taskName' => ['description' => 'The task name. The name can contain letters, digits, underscores (_), and hyphens (-).', 'type' => 'string', 'required' => false, 'example' => 'new-task-name', 'title' => ''], + 'dataSourceId' => ['description' => 'The data source ID, which is the Managed Service for Prometheus instance ID.', 'type' => 'string', 'required' => false, 'example' => 'rw-5f2b4sc7es4d66', 'title' => ''], + 'taskDescription' => ['description' => 'The task description.', 'type' => 'string', 'required' => false, 'example' => 'updated desc', 'title' => ''], + 'status' => [ + 'description' => 'The task status. This parameter is used to enable or disable the task.', + 'enumValueTitles' => ['Enable' => 'Enable', 'Disable' => 'Disable'], 'type' => 'string', + 'enum' => ['Running', 'Disable'], 'required' => false, - 'example' => 'default-cms-xxxxxxx-cn-hangzhou', + 'example' => 'Enable', + 'title' => '', ], - 'bizTraceCode' => [ - 'description' => '', + 'labelFiltersType' => [ + 'description' => 'The metric filtering mode.', 'type' => 'string', + 'enum' => ['Allow', 'Deny'], 'required' => false, - 'example' => 'label_env', + 'example' => 'Deny', + 'title' => '', ], - 'bizTraceName' => [ - 'description' => '', - 'type' => 'string', + 'labelFilters' => [ + 'description' => 'The metric filter conditions. The entire value is replaced rather than incrementally merged.', + 'type' => 'object', 'required' => false, - 'example' => 'just test', + 'additionalProperties' => ['description' => 'filterKey → filterValue. Example: job → my_job.', 'type' => 'string', 'example' => '__name__: up', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'ruleConfig' => [ - 'description' => '', - 'type' => 'string', + 'externalLabels' => [ + 'description' => 'The additional labels attached to all delivered metrics. The key is the label name and the value is the label value.', + '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' => ['description' => 'externalLabelsKey → externalLabelsValue. Example: region → ap-southeast-1.', 'type' => 'string', 'example' => 'region: cn-hangzhou', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'advancedConfig' => [ - 'description' => '', - 'type' => 'string', + 'sinkList' => [ + 'description' => 'The list of delivery targets.', + 'type' => 'array', + 'items' => [ + 'description' => 'The delivery target.', + 'type' => 'object', + 'properties' => [ + 'sinkType' => [ + 'description' => 'The delivery target type.', + 'type' => 'string', + 'enum' => ['Prometheus', 'AcsMaxCompute', 'AcsKafka'], + 'required' => false, + 'example' => 'Prometheus', + 'title' => '', + ], + 'sinkConfigs' => [ + 'description' => 'The detailed configuration of the delivery target. The meanings of keys and values vary depending on the sinkType.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'The configuration items supported by each sinkType.', 'type' => 'string', 'example' => 'Url: http://xxxx/api/v1/write', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '{"sample":{"strategy":"BY_APP"}}', + 'title' => '', + 'example' => '', ], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-aekzoiafjtr7zyq', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'bizTraceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'e339260ed64c95d', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9335D7CB-2725-53DD-A2B3-187821C8F1B8'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update a data delivery task', + 'description' => 'Deletes a specified site monitoring task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"bizTraceId\\": \\"e339260ed64c95d\\"\\n}","type":"json"}]', - ], - 'CreateServiceObservability' => [ - 'summary' => '创建应用可观测实例', - 'path' => '/workspace/{workspace}/service-observability/{type}', - 'methods' => [ - 'post', - ], - '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"}]', + 'translator' => 'machine', + ], + 'UpdateIntegrationPolicy' => [ + 'summary' => 'Updates the specified policy.', + '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' => 'The request body parameters.', + 'type' => 'object', + 'properties' => [ + 'feePackage' => ['description' => 'The type of the paid plan. Valid values: CS\\_Pro, CS\\_Basic, and empty.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'CS_Pro'], + 'policyName' => ['description' => 'The name of the rule. The name must be 3 to 63 characters in length and start with a letter.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'metrics-inner-manage'], + 'resourceGroupId' => ['description' => 'The ID of the resource group to which the instance belongs.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rg-aekzoiafjtr7zyq'], + 'tags' => [ + 'description' => 'The tags of the resource.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tags of the resource.', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The key of the tag.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'algo_bhv_expose_in_airec_exposure'], + 'value' => ['description' => 'The value of the tag.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '[{\'Id\': \'kgqie6hm\', \'Name\': \'Sheet1\'}]'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'type', + 'name' => 'integrationPolicyId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'rum' => '', - 'apm' => '', - ], - 'example' => 'apm', - ], + 'schema' => ['description' => 'The ID of the Integration Center policy.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'polixy-xxxxxxxxx'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', - ], - 'DeleteBizTrace' => [ - 'summary' => '删除业务链路', - 'path' => '/bizTrace/{bizTraceId}', - 'methods' => [ - 'delete', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update Access Center Policy', + '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' => 'Updates a specific Memory.', + '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' => 'The name of the Workspace.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'memoryStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the Memory Store.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-memory-store', 'title' => ''], + ], + [ + 'name' => 'memoryId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the Memory.', 'type' => 'string', 'required' => true, 'minLength' => 1, 'example' => '019ca1e5-7307-7d50-b943-5e628326a8ed', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The Request Body.', + 'type' => 'object', + 'properties' => [ + 'metadata' => ['description' => 'The metadata of the Memory.', 'type' => 'object', 'required' => false, 'example' => '{"sessionId":"test_session_001"}', 'title' => ''], + 'text' => ['description' => 'The new text for the Memory.', 'type' => 'string', 'required' => false, 'example' => 'Likes to play tennis on weekends', 'title' => ''], + ], 'required' => false, - 'example' => 'e339260ed64c95d', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The Response Data.', 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], + 'requestId' => ['title' => 'ID of the request', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '3B311FD9-A60B-55E0-A896-A0C73*********'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', - ], - 'GetAddon' => [ - 'summary' => '插件详情(Addon)', - 'path' => '/addons/{addonName}', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Modify memory', + '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' => 'Modify a memory store.', + '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' => 'Workspace name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'version', - 'in' => 'query', - 'schema' => [ - 'title' => 'Addon版本号', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '*', - ], + 'name' => 'memoryStoreName', + 'in' => 'path', + 'schema' => ['description' => 'Memory store name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'qianyi_test_3', 'title' => ''], ], [ - 'name' => 'aliyunLang', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '语言环境,默认为中文 zh | en', - 'description' => '', - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'Description.', 'type' => 'string', 'required' => false, 'example' => 'memoryStore test', 'title' => ''], + 'shortTermTtl' => ['description' => 'Short-term memory retention time.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7', 'title' => ''], + 'extractionStrategies' => [ + 'type' => 'array', + 'items' => ['description' => 'Array of strategies.', 'type' => 'string', 'required' => false, 'example' => 'Fact', 'title' => ''], + 'description' => 'Extraction strategies. Supports "Episodic", "Summary", and "Fact".', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'customExtractionStrategies' => [ + 'type' => 'array', + 'items' => ['description' => 'Array of strategies.', '$ref' => '#/components/schemas/CustomExtractionStrategy', 'required' => false, 'title' => '', 'example' => ''], + 'description' => 'Custom extraction strategies.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'Request data.', 'required' => false, - 'example' => 'zh', + 'title' => '', + 'example' => '', ], ], ], @@ -21977,932 +19879,648 @@ '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' => '[{\'DisplayName\': u\'\\u4f1a\\u8bae\'}]', - ], - ], - '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' => '', - 'type' => 'string', - 'example' => 'http://iac-service-transfer.oss-cn-hangzhou.aliyuncs.com/78c5_288850010070719968_bdcf7cca781844c8ac4add133791713f', - ], - ], - ], - ], - 'description' => [ - 'description' => '', - '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', - 'example' => 'true', - 'description' => '', - ], - ], - 'services' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[]', - ], - ], - ], - ], - 'description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Observability integration.', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cs-default-umodel-1752755202744_k8s.metric.high_level_metric_deployment_cn-hangzhou/c0a686118449c4390b9cc0a07ea3e0e85', - ], - 'policies' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'alertDefaultStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], - 'defaultInstall' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'enableServiceAccount' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'metricCheckRule' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'promQL' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'up=1', - ], - ], - ], - ], - 'needRestartAfterIntegration' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'protocols' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Prometheus Metrics', - ], - 'icon' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'icon URL', - ], - 'label' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rum_api_dot_metric_set', - ], - ], - ], - ], - 'targetAddonName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cs-default', - ], - ], - ], - 'policyType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CS', - ], - 'commonSchemaRefs' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'group' => [ - 'type' => 'string', - ], - 'version' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - 'icon' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'icon URL', - ], - 'keywords' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'finance', - ], - ], - 'language' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'zh', - ], - 'latestReleaseCreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2023-09-12 12:30:30', - ], - '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' => '10', - ], - ], - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8', - ], + 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'title' => '', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0'], ], + 'title' => '', + 'description' => 'Response data.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateMemoryStore', + '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' => 'GetAddon', - ], - 'GetAddonCodeTemplate' => [ - 'summary' => '插件schema详情(Addon)', - 'path' => '/addons/{addonName}/alert-code-template', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpdateMemoryStore', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'MemoryStore', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#WorkspaceName}/memorystore/{#MemoryStoreName}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', + ], + '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'apm-opentelemetry', - ], - ], - [ - 'name' => 'aliyunLang', + 'name' => 'workspace', 'in' => 'query', - 'schema' => [ - 'title' => '语言环境,默认为中文 zh | en', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => false, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'environmentType', - 'in' => 'query', - 'schema' => [ - 'title' => '环境类型 CS(容器) | ECS', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Client', - ], + 'name' => 'body', + 'in' => 'body', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The request body.', '$ref' => '#/components/schemas/NotifyStrategyForModify', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'version', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0.1.0', - ], + 'name' => 'notifyStrategyId', + 'in' => 'path', + 'schema' => ['description' => 'The UUID of the notification policy.', 'type' => 'string', 'required' => true, 'example' => '12312-31-23-123-1-23123', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The structure of the response.', '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' => 'The ID of the request. This is a unique identifier for troubleshooting.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'notifyStrategyId' => ['description' => 'The UUID of the notification policy.', 'type' => 'string', 'example' => '12312-31-23-123-1-23123', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => 'Illegal parameters.'], + ['errorCode' => 'StrategyNameConflict', 'errorMessage' => 'The specified strategy name exits already.', 'description' => 'The specified strategy name already exists'], + ], + 403 => [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 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"}]', - ], - 'GetAddonSchema' => [ - 'summary' => '插件schema详情(Addon)', - 'path' => '/addons/{addonName}/schema', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateNotifyStrategy', + 'summary' => 'Updates a notification policy.', + '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cloud-rds-audit-log', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'aliyunLang', - 'in' => 'query', - 'schema' => [ - 'title' => '语言环境,默认为中文 zh | en', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - [ - 'name' => 'environmentType', - 'in' => 'query', - 'schema' => [ - 'title' => '环境类型 CS(容器) | ECS', - 'description' => '', - 'type' => 'string', - 'required' => false, - ], + 'name' => 'pipelineName', + 'in' => 'path', + 'schema' => ['description' => 'The pipeline name.', 'type' => 'string', 'required' => false, 'example' => 'pipeline-name-1', 'title' => ''], ], [ - 'name' => 'version', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0.1.1', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ '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' => 'redeploy', - ], - 'field' => [ - 'description' => '', - 'type' => 'string', - ], - 'op' => [ - 'description' => '', - 'type' => 'string', - ], - 'value' => [ - 'description' => '', - 'type' => 'any', - 'example' => '[{\'count\': \'1\', \'max\': \'358.106\', \'sum\': \'358.106\', \'ts\': \'1755049815000000\', \'min\': \'358.106\'}, {\'count\': \'1\', \'max\': \'326.311\', \'sum\': \'326.311\', \'ts\': \'1755049830000000\', \'min\': \'326.311\'}]', - ], - ], - ], - ], - 'defaultValue' => [ - 'description' => '', - 'type' => 'any', - ], - 'description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'o11y-demo-cn-heyuan', - ], - 'disabled' => [ - 'description' => '', - 'type' => 'boolean', - ], - 'element' => [ - 'description' => '', - 'type' => 'string', - ], - 'fieldPath' => [ - 'type' => 'string', - ], - 'label' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rum_api_dashboard_explorer_link_metric_set', - ], - 'placeholder' => [ - 'description' => '', - 'type' => 'string', - ], - 'props' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'dataSource' => [ - 'description' => 'AK', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'label' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'value' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[]', - ], - ], - ], - ], - 'related' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'example' => 'false', - ], - ], - 'selectMode' => [ - 'type' => 'string', - ], - ], - ], - 'type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xtrace', + 'description' => ['description' => 'The pipeline description.', 'type' => 'string', 'required' => false, 'example' => 'test pipeline ', 'title' => ''], + 'source' => [ + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'The source type.', 'type' => 'string', 'required' => false, 'example' => 'logstore', 'title' => ''], + 'logstore' => [ + 'type' => 'object', + 'properties' => [ + 'logstore' => ['description' => 'The Logstore name.', 'type' => 'string', 'required' => false, 'example' => 'test-logstore', 'title' => ''], + 'query' => ['description' => 'The filter query.', 'type' => 'string', 'required' => false, 'example' => 'status:500 and method:GET', 'title' => ''], ], - 'validation' => [ + 'description' => 'The Log Service Logstore configuration.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The data source configuration.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'pipeline' => [ + 'type' => 'object', + 'properties' => [ + 'nodes' => [ + 'type' => 'array', + 'items' => [ 'type' => 'object', 'properties' => [ - 'max' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - ], - 'maxLength' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ok', - ], - 'min' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - ], - 'minLength' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - ], - 'regular' => [ - 'type' => 'string', - ], - 'required' => [ - 'description' => '', - 'type' => 'boolean', + 'id' => ['description' => 'The node ID.', 'type' => 'string', 'required' => false, 'example' => 'node_1', 'title' => ''], + 'type' => ['description' => 'The node type.', 'type' => 'string', 'required' => false, 'example' => 'dedup-fuzzy', 'title' => ''], + 'parameters' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'The node-specific parameters.', '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" + .' }', 'title' => ''], + 'description' => 'The node parameters.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'description' => 'A node object.', + 'required' => false, + 'title' => '', + 'example' => '', ], + 'description' => 'The pipeline nodes.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'description' => 'The pipeline configuration.', + 'required' => false, + 'title' => '', + 'example' => '', ], - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'E5B1D3D4-BB28-5996-8AD2-***********', + 'sink' => [ + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'The sink type.', 'type' => 'string', 'required' => false, 'example' => 'dataset', 'title' => ''], + 'dataset' => [ + 'type' => 'object', + 'properties' => [ + 'workspace' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'workspace-test', 'title' => ''], + 'dataset' => ['description' => 'The dataset name.', 'type' => 'string', 'required' => false, 'example' => 'dataset_1', 'title' => ''], + ], + 'description' => 'The destination dataset configuration.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The data sink configuration.', + 'required' => false, + 'title' => '', + 'example' => '', ], - 'type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'response_time', + 'executePolicy' => [ + 'type' => 'object', + 'properties' => [ + 'mode' => ['description' => 'The execution mode.', 'type' => 'string', 'required' => false, 'example' => 'runOnce', 'title' => ''], + 'runOnce' => [ + 'type' => 'object', + 'properties' => [ + 'fromTime' => ['description' => 'The start timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1772519013', 'title' => ''], + 'toTime' => ['description' => 'The end timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1772605413', 'title' => ''], + ], + 'description' => 'The one-time execution configuration.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'scheduled' => [ + 'type' => 'object', + 'properties' => [ + 'interval' => ['description' => 'The execution interval.', 'type' => 'string', 'required' => false, 'example' => '86400', 'title' => ''], + 'fromTime' => ['description' => 'The start timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1772519013', 'title' => ''], + ], + 'description' => 'The scheduled execution configuration.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The execution policy.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'description' => 'The request body.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], - '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' => 'GetAddonSchema', - ], - 'GetBizTrace' => [ - 'summary' => '查询业务链路', - 'path' => '/bizTrace/{bizTraceId}', - 'methods' => [ - 'get', + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'E99F1CCD-256A-5DF9-9B67-8F4A7ACE7132'], + ], + 'title' => '', + 'description' => 'The data returned in the response.', + 'example' => '', + ], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdatePipeline', + 'summary' => 'Update pipeline', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E99F1CCD-256A-5DF9-9B67-8F4A7ACE7132\\"\\n}","type":"json"}]', + ], + 'UpdatePrometheusInstance' => [ + 'summary' => 'Updates the information of a Managed Service for Prometheus instance.', + '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' => '', 'description' => 'The Prometheus instance ID.', 'type' => 'string', 'required' => true, 'example' => 'rw-xxxxxxx'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'archiveDuration' => [ + 'title' => '', + 'description' => 'The number of days for automatic archiving after storage expires. A value of 0 indicates no archiving. Valid values for archiving days:'."\n" + .'V1: 1 to 365 days. Supported only for billing by metric write volume.'."\n" + .'V2: 1 to 3650 days (3650 indicates permanent retention).', + 'type' => 'integer', + 'enum' => [], + 'required' => false, + 'example' => '365', + ], + 'authFreeReadPolicy' => ['title' => '', 'description' => 'The authentication-free read policy. IP CIDR blocks and VPC IDs are supported.', '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' => '', 'description' => 'The authentication-free read policy. IP CIDR blocks and VPC IDs are supported.', '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' => 'Specifies whether to enable authentication-free read.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'enableAuthFreeWrite' => ['title' => '', 'description' => 'Specifies whether to enable authentication-free write.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'enableAuthToken' => ['title' => '', 'description' => 'Specifies whether to enable access token authentication.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'prometheusInstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'required' => false, 'example' => 'test-prom-name', 'title' => ''], + 'status' => ['title' => '', 'description' => 'Instance storage database status of the instance. Only RUNNING is supported. If this parameter is left empty, instance storage database status remains unchanged.', 'type' => 'string', 'required' => false, 'example' => 'RUNNING'], + 'storageDuration' => [ + 'title' => '', + 'description' => 'The storage duration (days):'."\n" + .'By write volume: 90 or 180.'."\n" + .'By metric reporting volume: 15, 30, 60, 90, or 180.', + 'enumValueTitles' => [15 => '15 days.', 30 => '30 days.', 60 => '60 days.', 90 => '90 days.', 180 => '180 days.', 365 => '365 days.'], + 'type' => 'integer', + 'enum' => ['15', '30', '60', '90', '180', '365'], + 'required' => false, + 'example' => '90', + ], + 'paymentType' => [ + 'title' => '', + 'description' => 'The billing method. This parameter can be modified only once during the instance lifetime. Valid values:'."\n" + .'- POSTPAY: pay-as-you-go by metric reporting volume.'."\n" + .'- POSTPAY_GB: pay-as-you-go by metric write volume.', + 'enumValueTitles' => ['POSTPAY_GB' => 'Write volume.', 'POSTPAY' => 'Reporting volume.'], + 'type' => 'string', + 'enum' => ['POSTPAY_GB', 'POSTPAY'], + 'required' => false, + 'example' => 'POSTPAY_GB', + ], + 'workspace' => ['title' => '', 'description' => 'The workspace to which the instance belongs.', 'type' => 'string', 'required' => false, 'example' => 'default-cms-1500199863951574-cn-shanghai'], + ], 'required' => false, - 'example' => 'e339260ed64c95d', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], - 'item' => [ - 'description' => '', - '$ref' => '#/components/schemas/BizTraceConfig', - ], + 'prometheusInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'rw-abc123', 'title' => ''], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1E92F783-E057-58F1-BD5C-92DED088E7A5'], ], + 'example' => '', ], ], ], - '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"}]', - ], - 'GetIntegrationVersionForCS' => [ - 'summary' => '查询接入中心在CS的版本', - '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' => 'Update prometheus instance information', + 'description' => 'Updates the information of a Managed Service for Prometheus instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePrometheusInstance'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + ], + 'UpdatePrometheusUserSetting' => [ + 'summary' => 'Updates the user settings for Prometheus. Note: If you set `settingKey` to `financeUsageRegion`, Prometheus usage data is sent to Simple Log Service (SLS) in the specified region. Historical usage data will no longer be available in the Prometheus console.', + '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' => '', + 'description' => 'The key of the user setting.', + 'enumValueTitles' => ['defaultPaymentType' => 'The default billing method.', 'defaultPostPayDays' => 'The default retention period for the pay-as-you-go billing method based on reported data.', 'financeUsageRegion' => 'The ID of the region where usage statistics are stored.', 'defaultPostPayGBDays' => 'The default retention period for the pay-as-you-go billing method based on written data.'], 'type' => 'string', 'required' => true, - 'example' => 'c502646fd0d1249baaf792b3a1b589e1b', + 'example' => 'financeUsageRegion', + 'title' => '', ], ], [ - 'name' => 'clusterType', + 'name' => 'settingValue', 'in' => 'query', - 'schema' => [ - 'title' => '集群类型。取值：acs.ack.cluster,acs.asi.cluster。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'acs.ack.cluster', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The value of the user setting.', 'type' => 'string', 'required' => true, 'example' => 'ap-southeast-1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response object.', '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' => 'The ID of the request.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"integrationVersion\\": \\"V1\\",\\n \\"requestId\\": \\"CD9BCF34-EA09-5643-BC11-AF41C8DFAE5A\\"\\n}","type":"json"}]', - 'title' => 'GetIntegrationVersionForCS', - ], - 'GetPrometheusUserSetting' => [ - 'summary' => '查询指定环境实例', - 'path' => '/prometheus-user-setting', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdatePrometheusUserSetting', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'UpdatePrometheusView' => [ + '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' => 'The ID of the Prometheus view instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'rw-xxxxxxxx'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '语言环境, 默认为中文 zh | en', - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'authFreeReadPolicy' => ['description' => 'The policy for password-free read access. IP address segments and VPC IDs are supported.', 'type' => 'string', 'required' => false, 'title' => '', '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' => 'Specifies whether to enable password-free read access.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'enableAuthToken' => ['title' => '', 'description' => 'Specifies whether to enable authentication tokens.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'prometheusInstances' => [ + 'description' => 'A list of Prometheus instances.', + 'type' => 'array', + 'items' => [ + 'description' => 'A list of Prometheus instances.', + 'type' => 'object', + 'properties' => [ + 'prometheusInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'c7ba84651c71e442c8d0653085d862164'], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-north-2-gov-1'], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '16727123456789'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'prometheusViewName' => ['description' => 'The name of the Prometheus view.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test-prom-view-name'], + 'status' => ['description' => 'The status of the Prometheus view.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Running'], + 'workspace' => ['title' => '', 'description' => 'The workspace to which the view belongs.', 'type' => 'string', 'required' => false, 'example' => 'default-cms-108490012345-cn-heyuan'], + ], 'required' => false, - 'example' => 'zh', - 'default' => 'zh', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'Response body', 'type' => 'object', 'properties' => [ - 'prometheusUserSetting' => [ - 'description' => '', - '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' => 'The ID of the Prometheus view instance.', 'type' => 'string', 'example' => 'rw-xxxxxx'], + 'requestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '64D964F5-76C7-19A2-9399-457744AB3619'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusUserSetting\\": {\\n \\"key\\": \\"value1\\"\\n },\\n \\"requestId\\": \\"058550FA-DDBE-519E-9C6D-93521B9A5E90\\"\\n}","type":"json"}]', - 'title' => 'GetPrometheusUserSetting', - ], - 'ListAddons' => [ - 'summary' => '新版接入中心产品列表(分组)', - 'path' => '/addons', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update Prometheus View Instance Information', + 'summary' => 'Updates the information about a Prometheus view instance.', + 'description' => 'Updates the information about a Prometheus view instance.', + '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' => '', - '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' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'search', - 'in' => 'query', - 'schema' => [ - 'title' => 'addon名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '105095', - ], + 'name' => 'serviceId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the service.', 'type' => 'string', 'required' => true, 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', 'title' => ''], ], [ - 'name' => 'regexp', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '查询字段, 是否正则匹配, 默认为false'."\n", - 'description' => '', - 'type' => 'boolean', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'displayName' => ['description' => 'The display name. This parameter is valid only when serviceType is set to RUM.', 'type' => 'string', 'example' => 'api-monitor-test', 'required' => false, 'title' => ''], + 'description' => ['description' => 'The description of the service. This parameter is valid only when serviceType is set to RUM.', 'type' => 'string', 'example' => 'test', 'required' => false, 'title' => ''], + 'attributes' => ['description' => 'The extended properties.', 'type' => 'string', 'example' => '{"language":"java"}', 'required' => false, 'title' => ''], + 'serviceStatus' => ['description' => 'The status of the service. This parameter is valid only when serviceType is set to RUM.', 'type' => 'string', 'example' => 'Stopped', 'required' => false, 'title' => ''], + ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -22911,1498 +20529,657 @@ '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'metricCheckRule' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'promQL' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'scraper_up{scraper=\\"ecs\\"}==1', - ], - ], - ], - ], - 'needRestartAfterIntegration' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'protocols' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Support OpenTelemetry Protocal', - ], - 'icon' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://xxxxxxx', - ], - 'label' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OpenTelemetry', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'openTelemetry', - ], - ], - ], - ], - 'targetAddonName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cloud-acs-ecs', - ], - ], - ], - 'policyType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CS', - ], - 'commonSchemaRefs' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'group' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'acs-ecs', - ], - 'version' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0.1.4', - ], - ], - ], - ], - ], - ], - ], - 'icon' => [ - 'description' => '', - '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' => 'The request ID.', 'type' => 'string', 'example' => '123-0F43-23423-AC43-34234', 'title' => ''], + 'serviceId' => ['description' => 'The ID of the service.', 'type' => 'string', 'example' => 'em87vd@c2e25bcfe0e21ce0***', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - ], - 'ListBizTraces' => [ - 'summary' => '业务链路列表', - 'path' => '/bizTraces', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update Application Observability Service', + 'summary' => 'Updates an application observability service.', + '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' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'maxResults', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'name' => 'serviceId', + 'in' => 'path', + 'schema' => ['description' => 'The service ID.', 'type' => 'string', 'required' => true, 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', 'title' => ''], ], [ - 'name' => 'nextToken', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'allowEmptyValue' => false, + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'recordType' => [ + 'title' => '', + 'description' => 'The type of the linked entry. Currently supported value:'."\n" + .'logCorrelation, which indicates application log association.', + 'type' => 'string', + 'required' => true, + 'enum' => ['logCorrelation'], + 'example' => 'logCorrelation', + ], + 'recordContent' => ['title' => '', 'description' => 'The entry content in JSON string format. The format varies depending on the recordType value.', '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', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-*****', - ], - 'maxResults' => [ - 'description' => '', - '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' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0CEC5375-XXXX-XXXX-XXXX-9A629907C1F0'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update a service-linked entry', + 'summary' => 'Updates a service-linked entry.', + 'description' => 'Updates an existing service-linked entry.', + '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"}]', + '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' => 'The workspace name.', 'type' => 'string', 'required' => false, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The request body.', '$ref' => '#/components/schemas/SubscriptionForModify', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'subscriptionId', 'in' => 'path', - 'schema' => [ - 'title' => '环境id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-3563e6bf338141b3b92c118e2c318c37', - ], + 'schema' => ['description' => 'The subscription ID.', 'type' => 'string', 'required' => true, 'example' => '123123123123', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response body structure.', 'type' => 'object', 'properties' => [ - 'addons' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - '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' => '', - ], - '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' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'metricCheckRule' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'promQl' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'up{job="mysql"} > 0', - ], - ], - ], - ], - 'needRestartAfterIntegration' => [ - 'description' => '', - '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' => '', - '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' => '', - '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' => '', 'description' => 'The unique request ID.', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-******'], + 'subscriptionId' => ['description' => 'The subscription ID.', 'type' => 'string', 'example' => '123123123123', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => 'Illegal parameters.'], + ], + 403 => [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 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' => 'ListIntegrationPolicyAddons', - ], - 'ListIntegrationPolicyCollectors' => [ - 'summary' => '获取接入中心策略的存储要求信息', - 'path' => '/integration-policies/{policyId}/collectors', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], - 'schemes' => [ - 'https', + 'title' => 'Update a subscription', + 'summary' => 'Updates a subscription.', + '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' => [ + 'summary' => 'Updates the configuration of a Umodel.', + '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'env-d95435164593aece55f9999ce45c', - ], + 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'workspace-test'], ], [ - 'name' => 'addonReleaseName', - 'in' => 'query', - 'schema' => [ - 'title' => 'Addon Release名称。', - 'description' => '', - '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' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'workspace test'], + ], 'required' => false, - 'example' => 'zh', + 'title' => '', + 'example' => '', ], ], ], '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' => '', - 'type' => 'string', - 'example' => '10.10.10.10', - ], - 'ip' => [ - 'description' => '', - 'type' => 'string', - 'example' => '11.193.82.198', - ], - 'managed' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'managedInfo' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'securityGroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'sg-xxxxx', - ], - 'vswitchId' => [ - 'description' => '', - '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' => '', - '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' => [ - 'type' => 'string', - ], - 'addonMeta' => [ - '$ref' => '#/components/schemas/AddonMeta', - ], - ], - ], - ], - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '234324-123-123-123-23423'], + 'workspace' => ['description' => 'The name of the workspace.', 'type' => 'string', 'title' => '', 'example' => 'workspace-test'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"234324-123-123-123-23423\\",\\n \\"workspace\\": \\"workspace-test\\"\\n}","type":"json"}]', + 'title' => 'Update Umodel', + 'description' => 'Updates the configuration of a Umodel.', + 'changeSet' => [ + ['createdAt' => '2025-08-12T02:41:41.000Z', 'description' => 'Request parameters changed'], ], - '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' => 'ListIntegrationPolicyCollectors', - ], - 'ListIntegrationPolicyServiceMonitors' => [ - 'summary' => '获取接入中心策略的存储要求信息', - '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'], + ], + ], + ], ], + ], + 'UpsertUmodelCommonSchemaRef' => [ + 'summary' => 'Upserts a common Umodel schema reference.', + '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e', - ], - ], - [ - 'name' => 'addonReleaseName', - 'in' => 'query', - 'schema' => [ - 'title' => 'Addon Release名称。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'release-12345678', - ], + 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'workspace-test'], ], [ - 'name' => 'namespace', + 'name' => 'group', 'in' => 'query', - 'schema' => [ - 'title' => '命名空间。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'arms-prom', - ], + 'schema' => ['description' => 'The group of the common Umodel schema.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'card-service-daily01'], ], [ - 'name' => 'encryptYaml', + 'name' => 'version', 'in' => 'query', - 'schema' => [ - 'title' => '是否加密Yaml。', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The version number.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '0.1.0'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'clusterId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ea119prod-ea119blinkcptssd1', - ], - 'policyId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e', - ], - 'serviceMonitors' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'addonName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cloud-acs-ecs', - ], - 'addonReleaseName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'release-1234567', - ], - 'addonVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0.0.1', - ], - 'configYaml' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'apiVersion: xxxxx', - ], - 'enableStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'run', - ], - 'encryptYaml' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'YXBpVmVyc2lvbjogeHh4eHgK', - ], - 'endpoints' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'interval' => [ - 'description' => '', - 'type' => 'string', - 'example' => '30s', - ], - 'matchedTargetCount' => [ - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '62a526c5-f6ca-4cfb-b5a4-b76974cffe51', - ], - 'namespace' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'arms-prom', - ], - ], - ], - ], - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0B9377D9-C56B-5C2E-A8A4-************'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'ListIntegrationPolicyServiceMonitors', - ], - 'UpdateBizTrace' => [ - 'summary' => '修改业务链路', - 'path' => '/bizTrace/{bizTraceId}', - 'methods' => [ - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-************\\"\\n}","type":"json"}]', + 'title' => 'UpsertUmodelCommonSchemaRef', + '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'], + ], + ], + ], ], + ], + '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'e339260ed64c95d', - ], + 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'workspace-test'], + ], + [ + 'name' => 'method', + 'in' => 'query', + 'schema' => ['description' => 'The method.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Upsert'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The list of elements.', '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' => 'The content of the element.', + 'type' => 'array', + 'items' => ['description' => 'The content of the element.', 'type' => 'any', 'required' => false, 'title' => '', 'example' => '{}'], 'required' => false, - 'example' => '{"sample":{"strategy":"BY_APP"}}', + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'bizTraceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'e339260ed64c95d', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"bizTraceId\\": \\"e339260ed64c95d\\"\\n}","type":"json"}]', - ], - 'UpdatePrometheusUserSetting' => [ - 'summary' => '更新Prom实例信息', - 'path' => '/prometheus-user-setting/{settingKey}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Add or Overwrite Umodel (Elements)', + 'summary' => 'Inserts or updates 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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'key1', - ], - ], + 'ramActions' => [ [ - 'name' => 'settingValue', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => 'setting值', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'abc', - ], - ], - ], - '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' => 'UpdatePrometheusUserSetting', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', ], ], 'endpoints' => [ + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-beijing.aliyuncs.com', 'endpoint' => 'metrics.cn-beijing.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-zhengzhou-jva', 'regionName' => 'Zhengzhou (China Unicom Joint Venture)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-zhengzhou-jva.aliyuncs.com', 'endpoint' => 'metrics.cn-zhengzhou-jva.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-zhengzhou-jva.aliyuncs.com'], + ['regionId' => 'cn-heyuan', 'regionName' => 'China (Heyuan)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-heyuan.aliyuncs.com', 'endpoint' => 'metrics.cn-heyuan.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-heyuan.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'metrics.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'ap-northeast-2', 'regionName' => 'South Korea (Seoul)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-northeast-2.aliyuncs.com', 'endpoint' => 'metrics.ap-northeast-2.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-northeast-2.aliyuncs.com'], + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-northeast-1.aliyuncs.com', 'endpoint' => 'metrics.ap-northeast-1.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-northeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-southeast-1.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-1.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-southeast-2.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-2.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-southeast-2.aliyuncs.com'], + ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-southeast-3.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-3.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-southeast-3.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-southeast-5.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-5.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-southeast-5.aliyuncs.com'], + ['regionId' => 'ap-southeast-6', 'regionName' => 'Philippines (Manila)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-southeast-6.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-6.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-southeast-6.aliyuncs.com'], + ['regionId' => 'ap-southeast-7', 'regionName' => 'Thailand (Bangkok)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-southeast-7.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-7.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-southeast-7.aliyuncs.com'], + ['regionId' => 'ap-southeast-8', 'regionName' => 'Malaysia (Johor)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-southeast-8.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-8.aliyuncs.com', 'vpc' => 'cms-vpc.ap-southeast-8.aliyuncs.com'], + ['regionId' => 'cn-zhongwei', 'regionName' => 'China (Zhongwei)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-zhongwei.aliyuncs.com', 'endpoint' => 'metrics.cn-zhongwei.aliyuncs.com', 'vpc' => 'cms-vpc.cn-zhongwei.aliyuncs.com'], + ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'metrics.cn-wulanchabu.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-wulanchabu.aliyuncs.com'], + ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-qingdao.aliyuncs.com', 'endpoint' => 'metrics.cn-qingdao.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-qingdao.aliyuncs.com'], + ['regionId' => 'cn-wuhan-lr', 'regionName' => 'China (Wuhan - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-wuhan-lr.aliyuncs.com', 'endpoint' => 'metrics.cn-wuhan-lr.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-wuhan-lr.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-shanghai.aliyuncs.com', 'endpoint' => 'metrics.cn-shanghai.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-hongkong.aliyuncs.com', 'endpoint' => 'metrics.cn-hongkong.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-shenzhen.aliyuncs.com', 'endpoint' => 'metrics.cn-shenzhen.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'cn-nanjing', 'regionName' => 'China (Nanjing - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-nanjing.aliyuncs.com', 'endpoint' => 'metrics.cn-nanjing.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-nanjing.aliyuncs.com'], + ['regionId' => 'cn-fuzhou', 'regionName' => 'China (Fuzhou - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-fuzhou.aliyuncs.com', 'endpoint' => 'metrics.cn-fuzhou.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-fuzhou.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-chengdu.aliyuncs.com', 'endpoint' => 'metrics.cn-chengdu.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-chengdu.aliyuncs.com'], + ['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-guangzhou.aliyuncs.com', 'endpoint' => 'metrics.cn-guangzhou.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-guangzhou.aliyuncs.com'], + ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-huhehaote.aliyuncs.com', 'endpoint' => 'metrics.cn-huhehaote.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-huhehaote.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-hangzhou.aliyuncs.com', 'endpoint' => 'metrics.cn-hangzhou.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'us-southeast-1', 'regionName' => 'US（Atlanta）', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'metrics.us-southeast-1.aliyuncs.com', 'endpoint' => 'metrics.us-southeast-1.aliyuncs.com', 'vpc' => 'metrics-vpc.us-southeast-1.aliyuncs.com'], + ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'metrics.eu-west-1.aliyuncs.com', 'endpoint' => 'metrics.eu-west-1.aliyuncs.com', 'vpc' => 'metrics-vpc.eu-west-1.aliyuncs.com'], + ['regionId' => 'eu-west-2', 'regionName' => 'France (Paris)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'metrics.eu-west-2.aliyuncs.com', 'endpoint' => 'metrics.eu-west-2.aliyuncs.com', 'vpc' => 'cms-vpc.eu-west-2.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'metrics.eu-central-1.aliyuncs.com', 'endpoint' => 'metrics.eu-central-1.aliyuncs.com', 'vpc' => 'metrics-vpc.eu-central-1.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'metrics.us-east-1.aliyuncs.com', 'endpoint' => 'metrics.us-east-1.aliyuncs.com', 'vpc' => 'metrics-vpc.us-east-1.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'metrics.us-west-1.aliyuncs.com', 'endpoint' => 'metrics.us-west-1.aliyuncs.com', 'vpc' => 'metrics-vpc.us-west-1.aliyuncs.com'], + ['regionId' => 'na-south-1', 'regionName' => 'Mexico', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'metrics.na-south-1.aliyuncs.com', 'endpoint' => 'metrics.na-south-1.aliyuncs.com', 'vpc' => 'metrics-vpc.na-south-1.aliyuncs.com'], + ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'metrics.me-east-1.aliyuncs.com', 'endpoint' => 'metrics.me-east-1.aliyuncs.com', 'vpc' => 'metrics-vpc.me-east-1.aliyuncs.com'], + ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'metrics.ap-south-1.aliyuncs.com', 'endpoint' => 'metrics.ap-south-1.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-south-1.aliyuncs.com'], + ['regionId' => 'me-central-1', 'regionName' => 'Saudi Arabia (Riyadh)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'metrics.me-central-1.aliyuncs.com', 'endpoint' => 'metrics.me-central-1.aliyuncs.com', 'vpc' => 'metrics-vpc.me-central-1.aliyuncs.com'], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'metrics.cn-hangzhou-finance.aliyuncs.com', 'endpoint' => 'metrics.cn-hangzhou-finance.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-hangzhou-finance.aliyuncs.com'], + ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'metrics.cn-shenzhen-finance-1.aliyuncs.com', 'endpoint' => 'metrics.cn-shenzhen-finance-1.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-shenzhen-finance-1.aliyuncs.com'], + ['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'metrics.cn-beijing-finance-1.aliyuncs.com', 'endpoint' => 'metrics.cn-beijing-finance-1.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-beijing-finance-1.aliyuncs.com'], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'metrics.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'metrics.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-shanghai-finance-1.aliyuncs.com'], + ['regionId' => 'cn-wulanchabu-gic-1', 'regionName' => 'China (Ulanqab) GIC', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'metrics.cn-wulanchabu-gic-1.aliyuncs.com', 'endpoint' => 'metrics.cn-wulanchabu-gic-1.aliyuncs.com', 'vpc' => 'cms-vpc.cn-wulanchabu-gic-1.aliyuncs.com'], + ['regionId' => 'cn-heyuan-acdr-1', 'regionName' => 'Heyuan ACDR Auto', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'metrics.cn-heyuan-acdr-1.aliyuncs.com', 'endpoint' => 'metrics.cn-heyuan-acdr-1.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-heyuan-acdr-1.aliyuncs.com'], + ['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'metrics.cn-north-2-gov-1.aliyuncs.com', 'endpoint' => 'metrics.cn-north-2-gov-1.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-north-2-gov-1.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'AccessDeniedException', 'message' => 'You do not have the authority to operate this rule.', 'http_code' => 401, 'description' => 'ess rules cannot be modified in the cloud monitoring console.'], + ['code' => 'AccessForbidden', 'message' => 'No permission, please use Ram for authorization.', 'http_code' => 403, 'description' => 'No permission, please use Ram for authorization.'], + ['code' => 'AgentStateError', 'message' => 'Expected agent running state is stopped.', 'http_code' => 412, 'description' => 'Uninstall the plug-in when the status is Stopped.'], + ['code' => 'BadRequest', 'message' => 'Bad request.', 'http_code' => 400, 'description' => 'Error Parameter Request'], + ['code' => 'ContactNotExists', 'message' => 'ContactName does not exist.', 'http_code' => 404, 'description' => 'The contact name was not found.'], + ['code' => 'CSS_CREATE_ORDER_ERROR', 'message' => 'Create order error', 'http_code' => 400, 'description' => 'Failed to create order'], + ['code' => 'EmptyProbeList', 'message' => 'The selected probe list is empty.', 'http_code' => 400, 'description' => 'The selected probe list is empty'], + ['code' => 'ExceedingQuota', 'message' => 'You have exceeded the task limit.', 'http_code' => 406, 'description' => 'You have exceeded the task limit'], + ['code' => 'ExceedingQuota', 'message' => 'Exceeding quota limits.', 'http_code' => 406, 'description' => 'The number of tasks exceeds the limit'], + ['code' => 'Forbidden', 'message' => 'You are not authorized to operate the specified resource.', 'http_code' => 403, 'description' => 'No permission, please use RAM to authorize'], + ['code' => 'FrequencyLimit', 'message' => 'Frequency too high, please try again later.', 'http_code' => 429, 'description' => 'Frequency too high, please try again later'], + ['code' => 'Illegal Task Name', 'message' => 'The task name of the sitemonitor task is illegal.', 'http_code' => 400, 'description' => 'Site monitoring task name is illegal.'], + ['code' => 'IllegalAddress', 'message' => 'illegal address.', 'http_code' => 400, 'description' => 'Illegal Address'], + ['code' => 'Illgeal Task Name', 'message' => 'The task name for sitemonitor task is illegal.', 'http_code' => 400, 'description' => 'Site monitoring task name is illegal'], + ['code' => 'InsecureParams', 'message' => 'The params for site monitor is insecure.', 'http_code' => 400, 'description' => 'There is a security risk to the parameters of the site monitoring task'], + ['code' => 'InternalError', 'message' => '%s.', 'http_code' => 500, 'description' => '%s'], + ['code' => 'InternalUnknownError', 'message' => 'The request processing has failed due to some unknown error.', 'http_code' => 500, 'description' => 'A service runtime error occurred.'], + ['code' => 'InternetServerError', 'message' => 'System internal error.', 'http_code' => 500, 'description' => 'System internal error'], + ['code' => 'InvalidAuthorization', 'message' => 'Permission denied', 'http_code' => 403, 'description' => 'Permission denied.'], + ['code' => 'InvalidAuthorization', 'message' => 'InvalidAuthorization.', 'http_code' => 403, 'description' => 'You do not have the required permissions.'], + ['code' => 'InvalidAuthorization', 'message' => 'Permission denied.', 'http_code' => 403, 'description' => 'You do not have the required permissions.'], + ['code' => 'InvalidAuthorizationTokenExpire', 'message' => 'Authentication token expired, please re-authenticate.', 'http_code' => 403, 'description' => 'Authentication token expired, please re-authenticate'], + ['code' => 'InvalidClientTokenId', 'message' => 'not allow this operation.', 'http_code' => 403, 'description' => 'No permission'], + ['code' => 'InvalidParameter', 'message' => '%s is missing or invalid.', 'http_code' => 400, 'description' => 'The request parameters are invalid or required parameters are missing (such as GroupName, WorkspaceId, GroupId, or region being empty).'], + ['code' => 'InvalidParameter', 'message' => 'Invalid parameter.', 'http_code' => 400, 'description' => 'Parameter error'], + ['code' => 'InvalidParameterValue', 'message' => 'Illegal parameters.', 'http_code' => 400, 'description' => 'Illegal parameters.'], + ['code' => 'InvalidQueryParameter', 'message' => 'Parameter error.', 'http_code' => 400, 'description' => 'Query parameter error'], + ['code' => 'InvalidQueryParameter', 'message' => 'Invalid query parameter.', 'http_code' => 400, 'description' => 'Bad query parameters'], + ['code' => 'MaxRcaTimesExceed', 'message' => 'The maximum reanalysis limit has been reached.', 'http_code' => 400, 'description' => 'The maximum reanalysis limit has been reached.'], + ['code' => 'NameRepeat', 'message' => 'The task name already exists.', 'http_code' => 400, 'description' => 'The task name already exists. Make sure that the task name is not used in protocol-based synthetic tests and synthetic tests for browsers.'], + ['code' => 'NotAuthSLR', 'message' => 'You are not authorized role AliyunServiceRoleForCloudMonitor.', 'http_code' => 403, 'description' => 'The service-linked role AliyunServiceRoleForCloudMonitor is required.'], + ['code' => 'NotFound', 'message' => 'The specified resource is not found.', 'http_code' => 404, 'description' => 'The corresponding resource was not found.'], + ['code' => 'NotFound.EndpointConnector', 'message' => 'endpoint connector not found.', 'http_code' => 404, 'description' => 'endpoint connector does not exist'], + ['code' => 'OperatorCityInvalid', 'message' => 'Invalid Isp.', 'http_code' => 400, 'description' => 'Invalid Isp'], + ['code' => 'OperatorCityInvalid', 'message' => 'Invalid IspCity for certain probes.', 'http_code' => 400, 'description' => 'The isp or city of certain probes provided is invalid.'], + ['code' => 'OperatorCityInvalid', 'message' => 'The synthetic probe info provided is incorrect. The incorrect probe info are as below. %s.', 'http_code' => 400, 'description' => 'The synthetic probe info provided is incorrect.'], + ['code' => 'ParameterInvalid', 'message' => 'The parameter is missing or invalid. %s', 'http_code' => 400, 'description' => 'The parameter is invalid.'], + ['code' => 'ParameterInvalid', 'message' => 'Parameter invalid.', 'http_code' => 400, 'description' => 'The parameter is invalid.'], + ['code' => 'PhoneIsEmptyOrNotVerified', 'message' => 'Contact does not have a phone number configured or not verified.', 'http_code' => 400, 'description' => 'Contact does not have a phone number configured or not verified'], + ['code' => 'RateLimit', 'message' => 'Service rate limit.', 'http_code' => 400, 'description' => 'Service load is high, please try again later'], + ['code' => 'ResourceExist', 'message' => 'Resource already exist .', 'http_code' => 400, 'description' => 'The resource already exists.'], + ['code' => 'ResourceLimit', 'message' => 'Namespace limited.', 'http_code' => 400, 'description' => 'A maximum of 30 indicator warehouses can be created for one account.'], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource is not found.', 'http_code' => 404, 'description' => 'The specified resource is not found.'], + ['code' => 'ResourceNotFound', 'message' => 'Resource % not found.', 'http_code' => 404, 'description' => '已废弃'], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource %s is not found.', 'http_code' => 404, 'description' => 'The specified resource% s does not exist.'], + ['code' => 'ResourceOverLimit', 'message' => 'The resource has exceeded the limit. %s', 'http_code' => 429, 'description' => 'The quantity limit has been exceeded.'], + ['code' => 'RestrictedUser', 'message' => 'The user has no access to this operation. %s.', 'http_code' => 403, 'description' => 'The user does not have permission for the current action.'], + ['code' => 'RmcNotEnabled', 'message' => 'ResourceCenter Service is not enabled.', 'http_code' => 403, 'description' => 'You have not activated Resource Center.'], + ['code' => 'StrategyNameConflict', 'message' => 'The specified strategy name exits already.', 'http_code' => 400, 'description' => 'The specified strategy name already exists'], + ['code' => 'TaskIdNotExist', 'message' => 'Task does not exist.', 'http_code' => 404, 'description' => 'Task does not exist'], + ['code' => 'TaskNotExist', 'message' => 'Task does not exist.', 'http_code' => 400, 'description' => 'Site monitoring task does not exist'], + ['code' => 'TaskNotExist', 'message' => 'The specified task does not exist.', 'http_code' => 404, 'description' => 'The specified task does not exist.'], + ['code' => 'UnauthorizedTasks', 'message' => 'You are not permitted to operate the specified tasks.', 'http_code' => 403, 'description' => 'You are not permitted to operate the specified tasks.'], + ['code' => 'UnsupportedWorkspaceRegion', 'message' => 'Synthetic monitoring is not supported in this workspace region.', 'http_code' => 400, 'description' => 'Synthetic monitoring is not supported in this workspace region.'], + ['code' => 'VerifyCodeIsSent', 'message' => 'Verification code sent too often, please try again later.', 'http_code' => 400, 'description' => 'The verification code is sent too often, please try again later.'], + ['code' => 'WorkspaceNotExist', 'message' => 'The specified workspace does not exist.', 'http_code' => 400, 'description' => 'The workspace does not exist.'], + ['code' => 'InvalidParameter', 'message' => 'The request parameter is invalid or a required parameter is missing.', 'http_code' => 400, 'description' => 'The request parameter is invalid or a required parameter is missing.'], + ['code' => 'InvalidMaxResults', 'message' => 'The MaxResults parameter is invalid.', 'http_code' => 400, 'description' => 'The MaxResults parameter is invalid, must be a positive integer within the allowed limit.'], + ['code' => 'InvalidParameter.NextToken', 'message' => 'The NextToken is invalid or does not match the request parameters.', 'http_code' => 400, 'description' => 'The NextToken is invalid or does not match the request parameters.'], + ['code' => 'InvalidParameter.RegionId', 'message' => 'Unable to determine the region for the observe group.', 'http_code' => 400, 'description' => 'Unable to determine the region: the account has not enabled CloudResource and no central region can be derived.'], + ['code' => 'ObserveGroup.AlreadyExists', 'message' => 'An observe group with the same name already exists in the workspace.', 'http_code' => 409, 'description' => 'An observe group with the same name already exists in the workspace.'], + ['code' => 'DatabaseError', 'message' => 'A database error occurred while processing the request.', 'http_code' => 500, 'description' => 'A database error occurred. Please retry later or contact the administrator.'], + ['code' => 'ObserveGroup.NotFound', 'message' => 'The specified observe group does not exist.', 'http_code' => 404, 'description' => 'The specified observe group does not exist. Please check the ObserveGroupId.'], + ['code' => 'InternalError', 'message' => 'An internal error occurred while processing the request.', 'http_code' => 500, 'description' => 'An internal error occurred (e.g. failed to update Diamond config or deliver MetaQ). Please retry later.'], + ['code' => 'Workspace.NotFound', 'message' => 'The specified workspace does not exist or you have no permission.', 'http_code' => 404, 'description' => 'The specified workspace does not exist or you have no access.'], + ], + 'changeSet' => [ [ - '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' => 'Response parameters changed', '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' => 'Response parameters changed', 'api' => 'GetIntegrationPolicy'], + ['description' => 'Response parameters changed', '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' => 'Request parameters changed', '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' => 'Request parameters changed', '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' => 'Cms'], + ], + 'ram' => [ + 'productCode' => 'Cms', + 'productName' => 'Cloud Monitor', + 'ramCodes' => ['cms'], + 'ramLevel' => 'SERVICE', + 'ramConditions' => [ + [ + 'name' => 'acs:Service', + 'schema' => ['type' => 'String', 'description' => ''], + ], + [ + 'name' => 'acs:ResourceGroupId', + 'schema' => ['type' => 'String', 'description' => ''], + ], ], + 'ramActions' => [], + 'resourceTypes' => [], ], ]; |