'1.0', 'info' => [ 'style' => 'ROA', 'product' => 'Cms', 'version' => '2024-03-30', ], 'directories' => [ [ 'id' => 372127, 'title' => null, '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', ], ], [ 'id' => 372150, 'title' => null, 'type' => 'directory', 'children' => [ 'CreateChat', 'CreateDigitalEmployee', 'GetDigitalEmployee', 'UpdateDigitalEmployee', 'ListDigitalEmployees', 'DeleteDigitalEmployee', 'CreateThread', 'GetThread', 'GetThreadData', 'ListThreads', 'UpdateThread', 'DeleteThread', ], ], [ 'id' => 372163, 'title' => null, 'type' => 'directory', 'children' => [ 'UpdateIntegrationPolicy', 'DeleteIntegrationPolicy', 'CreateIntegrationPolicy', 'UpdateAddonRelease', 'ListIntegrationPolicyStorageRequirements', 'ListIntegrationPolicyPodMonitors', 'ListIntegrationPolicyDashboards', 'ListIntegrationPolicyCustomScrapeJobRules', 'ListIntegrationPolicies', 'ListAddonReleases', 'GetIntegrationPolicy', 'GetAddonRelease', 'DeleteAddonRelease', 'CreateAddonRelease', ], ], [ 'id' => 372178, 'title' => null, 'type' => 'directory', 'children' => [ 'GetServiceObservability', 'DeleteService', 'UpdateService', 'GetService', 'CreateService', 'ListServices', 'ListServices', ], ], [ 'id' => 372185, 'title' => null, 'type' => 'directory', 'children' => [ 'CreatePrometheusVirtualInstance', 'ListPrometheusVirtualInstances', 'GetAggTaskGroup', 'CreateAggTaskGroup', 'DeleteAggTaskGroup', 'UpdateAggTaskGroupStatus', 'UpdateAggTaskGroup', 'ListAggTaskGroups', 'DeletePrometheusInstance', 'DeletePrometheusView', 'GetPrometheusInstance', 'GetPrometheusView', 'ListPrometheusDashboards', 'UpdatePrometheusView', 'UpdatePrometheusInstance', 'ListPrometheusViews', 'ListPrometheusInstances', 'CreatePrometheusInstance', 'CreatePrometheusView', ], ], [ 'id' => 372210, 'title' => null, 'type' => 'directory', 'children' => [ 'ListAlertActions', 'UpdateSubscription', 'CreateAlertWebhook', 'DeleteAlertWebhooks', 'ListAlertWebhooks', 'UpdateAlertWebhook', 'UpdateNotifyStrategy', ], ], [ 'id' => 372218, 'title' => null, 'type' => 'directory', 'children' => [ 'CreateTicket', ], ], [ 'id' => 372220, 'title' => null, 'type' => 'directory', 'children' => [ 'TagResources', 'UntagResources', 'ListTagResources', 'ChangeResourceGroup', ], ], [ 'id' => 372225, 'title' => null, 'type' => 'directory', 'children' => [ 'DescribeRegions', ], ], [ 'id' => 372227, 'title' => null, 'type' => 'directory', 'children' => [ 'GetCmsService', ], ], [ 'id' => 372229, 'title' => null, 'type' => 'directory', 'children' => [ 'CreateBizTrace', 'CreateServiceObservability', 'DeleteBizTrace', 'GetAddon', 'GetAddonCodeTemplate', 'GetAddonSchema', 'GetBizTrace', 'GetIntegrationVersionForCS', 'GetPrometheusUserSetting', 'ListAddons', 'ListBizTraces', 'ListIntegrationPolicyAddons', 'ListIntegrationPolicyCollectors', 'ListIntegrationPolicyServiceMonitors', 'UpdateBizTrace', 'UpdatePrometheusUserSetting', ], ], ], 'components' => [ 'schemas' => [ 'AddonMeta' => [ 'description' => '', 'visibility' => 'Public', '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', 'example' => '', 'backendName' => 'alias', ], 'icon' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'assets/logos/ecs.svg', 'backendName' => 'icon', ], 'keywords' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Monitor', 'extendType' => 'true', ], 'backendName' => 'keywords', ], 'once' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true/false', 'backendName' => 'once', ], 'environments' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', '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', ], 'policies' => [ 'description' => '', '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', ], 'protocols' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', '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', ], ], 'extendType' => 'true', ], 'backendName' => 'protocols', ], 'metricCheckRule' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'promQL' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'up{job="acs-ecs"}==1', 'extendType' => 'true', ], 'backendName' => 'promQL', ], ], 'backendName' => 'metricCheckRule', ], 'needRestartAfterIntegration' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true/false', 'backendName' => 'needRestartAfterIntegration', ], 'enableServiceAccount' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true/false', 'backendName' => 'enableServiceAccount', ], 'bindEntity' => [ 'description' => '', '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', ], ], 'backendName' => 'bindEntity', ], 'bindDefaultPolicy' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true/false', 'backendName' => 'bindDefaultPolicy', ], ], 'backendName' => 'policies', ], 'dependencies' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'features' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'additionalProperties' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true/false', ], 'backendName' => 'features', ], 'services' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'cmee', 'extendType' => 'true', ], 'backendName' => 'services', ], 'clusterTypes' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'ManagedKubernetes/Default', 'extendType' => 'true', ], 'backendName' => 'clusterTypes', ], ], 'backendName' => 'dependencies', ], 'policyType' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'ECS', 'backendName' => 'policyType', ], 'commonSchemaRefs' => [ 'description' => '', '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', ], ], 'extendType' => 'true', ], 'backendName' => 'commonSchemaRefs', ], ], 'extendType' => 'true', ], 'backendName' => 'environments', ], 'categories' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'infrastructure', 'extendType' => 'true', ], 'backendName' => 'categories', ], 'dashboards' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '', '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', ], ], 'extendType' => 'true', ], 'backendName' => 'dashboards', ], 'weight' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'backendName' => 'weight', ], 'latestReleaseCreateTime' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '2025-10-25 09:12:12', 'backendName' => 'latestReleaseCreateTime', ], ], ], 'AlertEventIntegrationPolicyForModify' => [ 'title' => 'A short description of struct', 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'transformerSetting' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/TransformAction', ], 'backendName' => 'transformerSetting', ], 'description' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'test', 'backendName' => 'description', ], 'filterSetting' => [ 'description' => '', 'visibility' => 'Public', 'backendName' => 'filterSetting', '$ref' => '#/components/schemas/FilterSetting', ], 'integrationSetting' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '{"region":"cn-hangzhou"}', 'backendName' => 'integrationSetting', ], 'type' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'ALERT_CUSTOM', 'backendName' => 'type', ], 'alertEventIntegrationPolicyName' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'test integration', 'backendName' => 'alertEventIntegrationPolicyName', ], ], ], 'AlertEventIntegrationPolicyForView' => [ 'title' => 'A short description of struct', 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'workspace' => [ 'title' => 'workspace', 'description' => 'workspace', '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', ], 'transformerSetting' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/TransformAction', ], 'backendName' => 'transformerSetting', ], 'createTime' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '2025-03-11T08:21:58Z', 'backendName' => 'createTime', ], 'enable' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'enabled', ], 'integrationSetting' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '{"region":"cn-hangzhou"}', 'backendName' => 'integrationSetting', ], 'alertEventIntegrationPolicyName' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => '', 'backendName' => 'alertEventIntegrationPolicyName', ], ], ], 'AlertRuleAction' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'actions' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'myTestAction', 'extendType' => 'true', ], 'backendName' => 'actions', ], ], ], 'AlertRuleAlertMetricFilterDef' => [ 'description' => 'Alert Rule Alert Metric Filter Definition Object.', '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', ], 'supportedOpts' => [ 'description' => 'List of supported options.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Supported options.', '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', ], ], 'extendType' => 'true', ], 'backendName' => 'supportedOpts', 'itemName' => 'opt', ], ], ], 'AlertRuleAlertMetricFilterDef_array' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/AlertRuleAlertMetricFilterDef', ], ], 'AlertRuleAlertMetricInput' => [ 'description' => 'Predefined Metric Input Configuration.', '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.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Filter Item Configuration.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/AlertRuleAlertMetricInputFilterValue', ], 'backendName' => 'filterValues', ], 'paramValues' => [ 'title' => '', 'description' => 'List of input parameters. The metric\'s supported parameters and filter conditions can be queried via ListAlertMetrics.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Predefined Metric Parameter Configuration.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/AlertRuleAlertMetricInputParamValue', ], 'backendName' => 'paramValues', ], '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', ], ], ], 'AlertRuleAlertMetricInputFilterValue' => [ 'description' => 'Filter Condition Configuration Object.', 'visibility' => 'Public', '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', ], ], ], 'AlertRuleAlertMetricInputParamValue' => [ 'description' => '', 'visibility' => 'Public', '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', ], ], ], 'AlertRuleAlertMetricParamDef' => [ 'description' => '', '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', ], 'values' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', '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', ], ], 'extendType' => 'true', ], 'backendName' => 'values', 'itemName' => 'value', ], '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', ], ], ], 'AlertRuleAlertMetricParamDef_array' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/AlertRuleAlertMetricParamDef', ], ], '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', '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', ], 'caseList' => [ 'title' => '', 'description' => 'Applicable condition type: SLS_CONDITION.'."\n" .'SLS alert condition list.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'SLS alert condition object.', 'visibility' => 'Public', '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', ], '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" ."\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', 'type' => 'string', 'example' => 'HasData', 'backendName' => 'type', 'enum' => [ 'HasData', 'HasDataCount', 'HasDataMatch', 'HasDataMatchCount', ], ], ], 'extendType' => 'true', ], 'backendName' => 'caseList', 'sensitive' => false, ], 'compareList' => [ 'title' => '', 'description' => 'Applicable condition type: APM_CONDITION.'."\n" .'APM alert comparison condition list.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'APM alert condition object.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'aggregate' => [ 'title' => '', 'description' => 'Time series post-aggregation functions:'."\n" .'- count'."\n" .'- sum '."\n" .'- avg'."\n" .'- min'."\n" .'- max'."\n" .'- p90'."\n" .'- p95'."\n" .'- p99', 'visibility' => 'Public', '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', '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', ], 'valueLevelList' => [ 'title' => '', 'description' => 'List of alert severity levels for different values.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Alert severity levels for different values, used in multi-level severity scenarios.', 'visibility' => 'Public', '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', ], ], 'extendType' => 'true', ], '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', ], ], 'extendType' => 'true', ], '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' => '', ], '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', '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', ], ], 'relation' => [ 'title' => '', 'description' => 'Applicable condition type: APM_CONDITION.'."\n" .'Logical relationship between multiple conditions. Valid values: and, or.', 'visibility' => 'Public', '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', ], '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', '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', ], 'escalations' => [ 'title' => '', 'description' => 'List of conditions; for an alert rule with multiple severity levels, each level corresponds to one condition object.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Alert condition object.', 'visibility' => 'Public', '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" .'- INFO', 'visibility' => 'Public', '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', ], ], 'extendType' => 'true', ], 'backendName' => 'escalations', ], ], 'backendName' => 'simpleEscalation', ], 'compositeEscalation' => [ 'title' => '', 'description' => 'Applicable condition type: CMS_BASIC_CONDITION.'."\n" .'Valid only when escalationType=composite; composite metric alert condition.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'relation' => [ 'title' => '', 'description' => 'Relationship between multiple metric conditions; valid values are "and" or "or".', 'visibility' => 'Public', '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', ], 'escalations' => [ 'title' => '', 'description' => 'List of multi-metric composite conditions.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Condition object.', 'visibility' => 'Public', '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', ], ], 'extendType' => 'true', ], 'backendName' => 'escalations', ], ], 'backendName' => 'compositeEscalation', ], 'expressEscalation' => [ 'title' => '', 'description' => 'Applicable condition type: CMS_BASIC_CONDITION.'."\n" .'Valid only when escalationType=composite; multi-metric composite alert condition.', 'visibility' => 'Public', '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', ], ], 'backendName' => 'expressEscalation', ], 'noDataPolicy' => [ 'title' => '', 'description' => 'Applicable condition type: CMS_BASIC_CONDITION.'."\n" .'Handling method 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', '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', 'type' => 'string', 'example' => 'LT', 'backendName' => 'oper', ], 'value' => [ 'description' => 'Alert triggering threshold.', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '60', 'backendName' => 'value', ], ], ], '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', 'type' => 'object', 'properties' => [ 'dsList' => [ 'title' => '', 'description' => 'Applicable data source type: SLS_MULTI_DS.'."\n" .'List of sub-data sources.', 'visibility' => 'Public', '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', ], 'type' => [ 'title' => '', 'description' => 'Type of SLS data sub-source:'."\n" ."\n" .'- SLS_LOG_DS: LogStore data source.'."\n" .'- SLS_METRIC_DS: MetricStore data source.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'SLS_LOG_DS', 'backendName' => 'type', 'default' => 'SLS_LOG_DS', 'enum' => [ 'SLS_LOG_DS', 'SLS_METRIC_DS', ], ], ], 'extendType' => 'true', ], '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', ], 'type' => [ 'title' => '', 'description' => 'Data source type.'."\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', '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', ], 'appType' => [ 'title' => '', 'description' => 'Applicable data source type: APM_DS.'."\n" .'Application type: '."\n" ."\n" .'- apm.', 'visibility' => 'Public', 'type' => 'string', 'enumValueTitles' => [ 'apm' => '', ], 'example' => 'apm', 'backendName' => 'appType', ], ], ], 'AlertRuleLabelFilter' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'opt' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'AND', 'backendName' => 'opt', 'default' => 'AND', 'enum' => [ 'AND', 'OR', ], ], 'labels' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'additionalProperties' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'cn-shanghai', ], 'backendName' => 'labels', ], ], ], 'AlertRuleNotification' => [ 'description' => 'Alert Notification Configuration Object.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'slackWebhooks' => [ 'description' => 'List of Slack webhook notification object IDs.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Slack webhook notification object ID.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'mySlackWebhookId', 'extendType' => 'true', ], 'backendName' => 'slackWebhooks', ], 'wxWebhooks' => [ 'description' => 'List of WeChat webhook notification object IDs.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'WeChat webhook notification object ID.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'myWxWebhookId', 'extendType' => 'true', ], 'backendName' => 'wxWebhooks', ], 'notifyTime' => [ 'title' => '', 'description' => 'Notification time window; notifications are sent only during this period.', 'visibility' => 'Public', 'backendName' => 'notifyTime', '$ref' => '#/components/schemas/AlertRuleTimeSpan', ], 'dingWebhooks' => [ 'description' => 'List of DingTalk webhook notification object IDs.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'DingTalk webhook notification object ID.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'myDingWebhookId', 'extendType' => 'true', ], 'backendName' => 'dingWebhooks', ], 'customWebhooks' => [ 'description' => 'List of custom webhook notification object IDs.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Custom webhook notification object ID.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'myCustomWebhookId', 'extendType' => 'true', ], 'backendName' => 'customWebhooks', ], 'groups' => [ 'description' => 'List of contact group IDs.', 'visibility' => 'Public', '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', ], 'fsWebhooks' => [ 'description' => 'List of Feishu webhook notification object IDs.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Feishu webhook notification object ID.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'myFsWebhookId', 'extendType' => 'true', ], 'backendName' => 'fsWebhooks', ], 'version' => [ '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', ], 'contacts' => [ 'description' => 'List of contact IDs.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Contact ID.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'myContactId', 'extendType' => 'true', ], 'backendName' => 'contacts', ], ], ], 'AlertRuleNotificationFilter' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'slackWebhooks' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'webhook ID', 'visibility' => 'Public', 'type' => 'string', 'example' => 'myWebhookId', 'extendType' => 'true', ], 'backendName' => 'slackWebhooks', ], 'wxWebhooks' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'webhook ID', 'visibility' => 'Public', 'type' => 'string', 'example' => 'myWebhookId', 'extendType' => 'true', ], 'backendName' => 'wxWebhooks', ], 'dingWebhooks' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'webhook ID', 'visibility' => 'Public', 'type' => 'string', 'example' => 'myWebhookId', 'extendType' => 'true', ], 'backendName' => 'dingWebhooks', ], 'customWebhooks' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'webhook ID', 'visibility' => 'Public', 'type' => 'string', 'example' => 'myWebhookId', 'extendType' => 'true', ], 'backendName' => 'customWebhooks', ], 'groups' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'myContactGroup', 'extendType' => 'true', ], 'backendName' => 'groups', ], 'fsWebhooks' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'webhook ID', 'visibility' => 'Public', 'type' => 'string', 'example' => 'myWebhookId', 'extendType' => 'true', ], 'backendName' => 'fsWebhooks', ], 'contacts' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'myContactId', 'extendType' => 'true', ], 'backendName' => 'contacts', ], ], ], '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', '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', ], 'groupFieldList' => [ 'title' => '', 'description' => 'Applicable query type: SLS_MULTI_QUERY.'."\n" .'List of grouping field names.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Grouping field name.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'host_name', 'extendType' => 'true', ], 'backendName' => 'groupFieldList', ], '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', 'type' => 'string', '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" ."\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', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'Subquery.', 'visibility' => 'Public', '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' => '', ], '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', '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', ], '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', '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', ], ], 'extendType' => 'true', ], 'backendName' => 'filters', ], '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', 'type' => 'array', 'items' => [ 'description' => 'Aggregation dimensions of the metric.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'rpcType', 'extendType' => 'true', ], 'backendName' => 'groupBy', ], ], 'sensitive' => false, 'extendType' => 'true', ], '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', ], 'type' => [ 'title' => '', 'description' => 'Query type.'."\n" ."\n" .'Valid values:'."\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" ."\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', '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', ], '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', 'type' => 'string', 'enumValueTitles' => [ 'GROUP' => 'GROUP', 'INSTANCE' => 'INSTANCE', 'USER' => 'USER', ], 'example' => 'USER', 'backendName' => 'relationType', ], 'groupId' => [ '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', ], 'namespace' => [ 'title' => '', 'description' => 'Applicable query type: CMS_BASIC_QUERY.'."\n" .'Namespace of the metric.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'acs_ecs_dashboard', 'backendName' => 'namespace', ], 'dimensions' => [ 'title' => '', 'description' => 'Applicable query type: CMS_BASIC_QUERY.'."\n" .'List of filtering dimensions for the resource.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Basic cloud monitoring resource filtering dimensions.', 'visibility' => 'Public', 'type' => 'object', 'additionalProperties' => [ 'description' => 'Dimension value.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'i-f8zbbutcvfpx7gn457pi', ], 'extendType' => 'true', ], 'backendName' => 'dimensions', ], 'serviceIds' => [ 'description' => 'Service ID list.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Service ID.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'i-bp1234567890abcdef'."\n", 'extendType' => 'true', ], 'backendName' => 'serviceIds', ], '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', ], ], 'backendName' => 'entityFilter', ], 'domain' => [ 'description' => '资源所属的领域。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'rum', 'backendName' => 'domain', ], 'metricSet' => [ 'description' => '监控指标集合。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'cpu_usage', 'backendName' => 'metricSet', ], 'metric' => [ 'description' => '指标名。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'memory', 'backendName' => 'metric', ], ], ], 'AlertRuleSend' => [ 'description' => 'Alert Delivery Configuration Object.', 'visibility' => 'Public', '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' => [ 'title' => '', 'description' => 'Whether to deliver alert events to ARMS Alert Management.', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'sendToArms', ], ], ], 'AlertRuleSlsQueryJoin' => [ 'description' => 'SLS Query Connection Configuration.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'conditions' => [ 'description' => 'List of connection conditions.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'Set operation condition.', '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' => '', ], 'secondField' => [ 'title' => '', 'description' => 'Right-hand operand of the condition, formatted as $..', 'visibility' => 'Public', 'type' => 'string', 'deprecated' => false, 'hasServerDefaultValue' => false, 'example' => '$0.__topic__', 'pattern' => '', 'readOnly' => false, 'backendName' => 'secondField', 'sensitive' => false, 'extMonitorInfo' => false, 'descriptionEn' => 'right parameter of join condition', 'default' => '', ], 'firstField' => [ 'title' => '', 'description' => 'Left-hand operand of the condition, formatted as $..', 'visibility' => 'Public', 'type' => 'string', 'deprecated' => false, 'hasServerDefaultValue' => false, 'example' => '$0.__topic__', 'pattern' => '', 'readOnly' => false, 'backendName' => 'firstField', 'sensitive' => false, 'extMonitorInfo' => false, 'descriptionEn' => 'left parameter of join condition', 'default' => '', ], ], 'deprecated' => false, 'hasServerDefaultValue' => false, 'readOnly' => false, 'sensitive' => false, 'extMonitorInfo' => false, 'descriptionEn' => 'join condition', 'extendType' => 'true', 'unordered' => false, ], 'backendName' => 'conditions', ], 'type' => [ 'title' => '', '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" ."\n" .'See also: https://help.aliyun.com/zh/sls/user-guide/set-query-statistics-statement', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'CrossJoin', 'pattern' => '', 'backendName' => 'type', 'sensitive' => false, 'default' => '', 'enum' => [ 'CrossJoin', 'FullJoin', 'InnerJoin', 'LeftExclude', 'RightExclude', 'LeftJoin', 'RightJoin', 'NoJoin', 'Concat', ], ], ], ], 'AlertRuleTimeSpan' => [ 'description' => 'Time Window Configuration Object.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'dayOfWeek' => [ 'title' => '', 'description' => 'Day of the week.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Day of the week.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'extendType' => 'true', 'enum' => [ '1', '2', '3', '4', '5', '6', '7', ], ], 'backendName' => 'dayOfWeek', ], 'gmtOffset' => [ 'title' => '', 'description' => 'Default time zone is Beijing Time: +0800.', 'visibility' => 'Public', 'type' => 'string', 'example' => '+0800', 'backendName' => 'gmtOffset', ], 'startTime' => [ 'title' => '', 'description' => 'Start time, in HH:mm format.', 'visibility' => 'Public', 'type' => 'string', 'example' => '09:00', 'backendName' => 'startTime', ], 'endTime' => [ 'title' => '', 'description' => 'End time, in HH:mm format.', 'visibility' => 'Public', 'type' => 'string', 'example' => '23:00', 'backendName' => 'endTime', ], ], ], 'BizTraceConfig' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'workspace' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'default-cms-xxxxxxx-cn-hangzhou', 'backendName' => 'workspace', ], 'bizTraceId' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'e339260ed64c95d', 'backendName' => 'bizTraceId', ], 'bizTraceName' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'just test', 'backendName' => 'bizTraceName', ], 'bizTraceCode' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'label_env', 'backendName' => 'bizTraceCode', ], 'ruleConfig' => [ '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', ], 'advancedConfig' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '{"sample":{"strategy":"BY_APP"}}', 'backendName' => 'advancedConfig', ], 'createTime' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '2025-12-12 00:00:00', 'backendName' => 'createTime', ], 'regionId' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'cn-beijing', 'backendName' => 'regionId', ], ], ], 'CmsEventForView' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'id' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '"event-1234567890"', 'backendName' => 'id', ], 'dedupId' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '"dedup-abc123"', 'backendName' => 'dedupId', ], 'type' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '"Alert"', 'backendName' => 'type', ], 'subtype' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '"HighCPUUsage"', 'backendName' => 'subtype', ], 'source' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '"ECS"', 'backendName' => 'source', ], 'time' => [ 'description' => '', 'visibility' => 'Public', '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', ], 'severity' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '"CRITICAL"', 'backendName' => 'severity', ], 'status' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Running', 'backendName' => 'status', ], 'resource' => [ 'description' => '', 'visibility' => 'Public', 'backendName' => 'resource', '$ref' => '#/components/schemas/EventResourceForEventView', ], 'labels' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'example' => '{\'source\': \'system\'}', 'backendName' => 'labels', ], 'annotations' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'example' => '{ "description": "High load detected on server", "operator": "auto" }', 'backendName' => 'annotations', ], 'dataschema' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '"https://schema.alibabacloud.com/cms/alert/v1"', 'backendName' => 'dataschema', ], 'datacontenttype' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '"application/json"', 'backendName' => 'datacontenttype', ], 'data' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'any', 'example' => '{ "metricName": "cpu_usage", "value": 95.2, "threshold": 80 }', 'backendName' => 'data', ], 'receiveTime' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1743846610000', 'backendName' => 'receiveTime', ], 'workspace' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '"ws-abc123"', 'backendName' => 'workspace', ], 'workspaceTags' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'example' => '{ "department": "finance", "project": "payment-gateway" }', 'backendName' => 'workspaceTags', ], 'sysId' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '"sys-event-987654321"', 'backendName' => 'sysId', ], 'integrationUuid' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '"integration-xyz"', 'backendName' => 'integrationUuid', ], 'sourcetype' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '"CloudMonitor"', 'backendName' => 'sourcetype', ], ], ], 'ContactForIncidentView' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'contactId' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '"contact-123456"', 'backendName' => 'contactId', ], 'name' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '', 'backendName' => 'name', ], ], ], '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', ], ], ], 'EntityDiscoverRule' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'ipMatchRule' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', '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', ], ], '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', ], 'backendName' => 'fieldRules', ], 'annotations' => [ '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', ], 'tagKey' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'instanceId', 'backendName' => 'tagKey', ], 'tagValues' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'i-bp1gj8wyq4fxk28k6iy2'."\n", 'extendType' => 'true', ], 'backendName' => 'tagValues', ], ], 'extendType' => 'true', ], 'backendName' => 'annotations', ], 'resourceGroupId' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'rg-acfm2m7atreujs1', 'backendName' => 'resourceGroupId', ], 'entityTypes' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'acs.ecs.instance', 'extendType' => 'true', ], 'backendName' => 'entityTypes', ], 'regionIds' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'cn-shanghai', 'extendType' => 'true', ], 'backendName' => 'regionIds', ], 'tags' => [ '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', ], 'tagKey' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'project', 'backendName' => 'tagKey', ], 'tagValues' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'demo', 'extendType' => 'true', ], 'backendName' => 'tagValues', ], ], 'extendType' => 'true', ], 'backendName' => 'tags', ], 'labels' => [ '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', ], 'tagKey' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'project', 'backendName' => 'tagKey', ], 'tagValues' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'demo', 'extendType' => 'true', ], 'backendName' => 'tagValues', ], ], 'extendType' => 'true', ], 'backendName' => 'labels', ], ], ], 'EntityGroupBase' => [ 'title' => '', 'description' => '', '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', ], 'entityQueries' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', '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', ], ], 'extendType' => 'true', ], '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' => '', 'visibility' => 'Public', 'backendName' => 'entityRules', '$ref' => '#/components/schemas/EntityDiscoverRule', ], 'entityGroupName' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '', 'backendName' => 'entityGroupName', ], 'userId' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '1654218***343050', 'backendName' => 'userId', ], ], ], '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', ], ], 'backendName' => 'entity', ], 'tags' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'example' => '{ "env": "prod", "project": "payment-gateway" }', 'backendName' => 'tags', ], ], ], 'EventResourceForIncidentView' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'tags' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '', 'backendName' => 'tags', ], 'probs' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '"{"name":"web-server-01","ip":"10.0.0.1"}"', 'backendName' => 'prons', ], 'entityType' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '"Instance"', 'backendName' => 'entityType', ], 'entityId' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'default', 'backendName' => 'entityId', ], 'domain' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'rum', 'backendName' => 'domain', ], ], ], 'FilterSetting' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'expression' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '1 and 2 or 3', 'backendName' => 'expression', ], 'conditions' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'op' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'EQ', 'backendName' => 'op', ], 'field' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'severity', 'backendName' => 'field', ], 'value' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'CRITICAL', 'backendName' => 'value', ], ], 'extendType' => 'true', ], 'maxItems' => 10, 'backendName' => 'conditions', ], 'relation' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'AND', 'backendName' => 'relation', ], ], ], 'IncidentContactStruct' => [ 'description' => 'Event Contact Structure.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'contactId' => [ 'description' => 'Contact ID.', 'visibility' => 'Public', 'type' => 'string', 'example' => '627415', 'backendName' => 'contactId', ], 'channel' => [ 'description' => 'Channel list.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Channel name.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'ecs', 'extendType' => 'true', ], 'backendName' => 'channel', ], 'contactType' => [ 'description' => 'Contact type.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'GROUP', 'backendName' => 'contactType', ], ], ], 'IncidentEscalationPolicyForModify' => [ 'title' => 'A short description of struct', 'description' => '', 'visibility' => 'Public', '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', ], 'escalationStageList' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/IncidentEscalationStageForView', ], 'backendName' => 'escalationStageList', ], ], ], 'IncidentEscalationPolicyForView' => [ 'title' => 'A short description of struct', 'description' => '', 'visibility' => 'Public', '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', ], 'escalationStageList' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/IncidentEscalationStageForView', ], 'backendName' => 'escalationStageList', ], ], ], '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', ], 'notifyChannels' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/NotifyChannel', ], 'backendName' => 'notifyChannels', ], ], ], 'IncidentEscalationStageStruct' => [ 'description' => 'Event Escalation Phase 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', ], 'contact' => [ 'description' => 'Contact list.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Event Contact Structure.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/IncidentContactStruct', ], 'backendName' => 'contactList', ], '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', ], ], ], 'IncidentEscalationStruct' => [ 'description' => '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', ], 'stage' => [ 'description' => 'Phase.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Event Escalation Phase Structure.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/IncidentEscalationStageStruct', ], 'backendName' => 'stageList', ], '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', ], ], ], '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', ], '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', 'example' => '', 'backendName' => 'textIndex', ], ], ], 'IncidentEventStruct' => [ 'description' => 'Event structure.', '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', ], 'resource' => [ 'description' => 'Describes the resource information associated with the event.', 'visibility' => 'Public', 'type' => 'object', 'additionalProperties' => [ 'description' => 'map', 'visibility' => 'Public', 'type' => 'string', 'example' => 'map', ], 'backendName' => 'resource', ], 'count' => [ 'description' => 'Count.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'backendName' => 'count', ], 'groupBy' => [ 'description' => 'Used for grouping dimensions.', 'visibility' => 'Public', 'type' => 'object', 'additionalProperties' => [ 'description' => 'map', 'visibility' => 'Public', 'type' => 'string', 'example' => 'map', ], 'backendName' => 'groupBy', ], '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', ], 'dimension' => [ 'description' => 'Dimension.', 'visibility' => 'Public', 'type' => 'object', 'additionalProperties' => [ 'description' => 'map', 'visibility' => 'Public', 'type' => 'string', 'example' => 'map', ], 'backendName' => 'dimension', ], 'status' => [ 'description' => 'Status.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => 'Running', 'backendName' => 'status', ], ], ], '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', ], 'escalations' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/IncidentEscalationPolicyForView', ], 'backendName' => 'escalations', ], 'owners' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/ContactForIncidentView', ], 'backendName' => 'owners', ], 'participants' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/ContactForIncidentView', ], 'backendName' => 'participants', ], 'groupingKeys' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'additionalProperties' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '{ "resourceId": "i-bp123456", "severity": "Critical" }', ], 'backendName' => 'groupingKeys', ], 'relatedResources' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/EventResourceForIncidentView', ], 'backendName' => 'relatedResources', ], 'solution' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '', 'backendName' => 'solution', ], 'rootCauseCategory' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '"Network"', 'backendName' => 'rootCauseCategory', ], ], ], 'IncidentMemberStruct' => [ 'description' => 'Event Member Structure.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'acknowledge' => [ 'description' => 'Acknowledgement Information Structure.', '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', ], ], 'backendName' => 'acknowledge', ], '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', ], 'escalation' => [ 'description' => 'Escalation phase information.', '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', ], ], 'backendName' => 'escalation', ], 'scheduleGroup' => [ 'description' => 'Schedule 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', ], ], 'backendName' => 'schedule', ], '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', ], 'contacts' => [ 'description' => 'Contact list.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Contact details.', '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', ], ], 'extendType' => 'true', ], 'backendName' => 'contacts', ], ], ], 'IncidentNoteStruct' => [ 'description' => 'Event record structure.', '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', ], 'operator' => [ 'description' => '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', ], ], 'backendName' => 'opera', ], ], ], 'IncidentPlanCorporationStruct' => [ 'description' => 'Event contingency collaboration structure.', 'visibility' => 'Public', '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', ], ], ], 'IncidentPlanFieldPath' => [ 'description' => 'A structure used to define field mapping paths in an event contingency plan.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'fieldAlias' => [ 'description' => 'Field alias.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Service name.'."\n", 'backendName' => 'alias', ], 'fieldPath' => [ 'description' => 'List of field paths.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Field path.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'service.name', 'extendType' => 'true', ], 'backendName' => 'name', ], ], ], 'IncidentPlanStruct' => [ 'description' => 'Event contingency plan structure.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'escalationId' => [ 'description' => 'List of escalation policy IDs.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Escalation policy ID.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'escalation-001', 'extendType' => 'true', ], 'backendName' => 'escalationId', ], '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', ], 'resourceFiled' => [ 'description' => 'List of resource field mapping paths.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Resource field mapping path.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/IncidentPlanFieldPath', ], 'backendName' => 'resourceField', ], 'corporation' => [ 'description' => 'List of teams or roles involved in collaboration.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Event contingency plan structure.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/IncidentPlanCorporationStruct', ], 'backendName' => 'corporation', ], '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', ], 'groupBy' => [ 'description' => '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', ], 'backendName' => 'groupBy', ], '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', ], ], ], 'IncidentResourceDetail' => [ 'description' => 'A structure used to describe the details of resources associated with an event.', 'visibility' => 'Public', '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', ], ], ], 'IncidentResourceStruct' => [ 'description' => 'A structure used to describe resources associated with 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', ], ], ], 'IncidentResponsePlanForView' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'type' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '"Standard"', 'backendName' => 'type', ], 'source' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '"MANUAL"', 'backendName' => 'source', ], 'escalationId' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '"escalation-123"', 'extendType' => 'true', ], 'backendName' => 'escalationId', ], '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', ], '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', 'example' => '', 'backendName' => 'description', ], 'enabled' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'enabled', ], 'createTime' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '"2025-04-05T10:30:00Z"', 'backendName' => 'createTime', ], 'updateTime' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '"2025-04-06T09:15:00Z"', 'backendName' => 'updateTime', ], ], ], 'IncidentStruct' => [ 'description' => 'A core structure representing a complete incident.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'severity' => [ 'description' => 'Incident severity level.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'P1', 'backendName' => 'severity', ], 'escalations' => [ 'description' => 'List of escalation policies.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Incident escalation structure.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/IncidentEscalationStruct', ], 'backendName' => 'escalations', ], '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', ], ], ], 'IncidentTimeline' => [ 'description' => 'A structure used to record timeline nodes during incident handling.', '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', ], ], ], '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', ], 'changeType' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '"Open -> In Progress"', 'backendName' => 'changeType', ], 'title' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '', 'backendName' => 'title', ], 'content' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'any', 'example' => '"{"action":"restart","resourceId":"i-bp123456"}"', 'backendName' => 'content', ], 'workspace' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '"ws-xyz789"', 'backendName' => 'workspace', ], 'operator' => [ 'description' => '', 'visibility' => 'Public', 'backendName' => 'operator', '$ref' => '#/components/schemas/ContactForIncidentView', ], ], ], 'MaintainWindowForModify' => [ 'title' => 'A short description of struct', 'description' => 'Silencing 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', ], 'effectTimeRange' => [ 'description' => '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', ], 'dayInWeek' => [ 'title' => '', 'description' => 'Effective days (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', ], 'backendName' => 'dayInWeek', ], 'endTimeInMinute' => [ 'title' => '', 'description' => 'End time (in minutes).', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1439', 'minimum' => '0', 'example' => '60', 'backendName' => 'endTimeInMinute', ], ], 'backendName' => 'effectTimeRange', ], 'endTime' => [ 'title' => '', 'description' => 'Effective end time.', 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-09-05 09:30:40', 'backendName' => 'endTime', ], ], ], 'MaintainWindowForView' => [ 'title' => 'A short description of struct', 'description' => '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', ], 'effectTimeRange' => [ 'description' => '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', ], 'dayInWeek' => [ 'title' => '', 'description' => 'Effective days (Monday to Sunday).', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '0–6 denotes Sunday to Saturday.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'extendType' => 'true', ], 'backendName' => 'dayInWeek', ], 'endTimeInMinute' => [ 'title' => '', 'description' => 'End time (in minutes).', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1439', 'minimum' => '0', 'example' => '360', 'backendName' => 'endTimeInMinute', ], ], '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', ], 'startTime' => [ 'title' => '', 'description' => 'Effective start time.', 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-11-26 10:02:01', 'backendName' => 'startTime', ], 'endTime' => [ 'title' => '', 'description' => 'Effective end time.', 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-11-26 12:02:01', 'backendName' => 'endTime', ], ], ], 'MergeContact' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'gmtModified' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '2025-03-11T08:21:58.789Z', 'backendName' => 'gmtModified', ], 'name' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '', 'backendName' => 'name', ], 'gmtCreate' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '2025-03-11T08:21:58.789Z', 'backendName' => 'gmtCreate', ], 'identifier' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'user-12345', 'backendName' => 'identifier', ], 'phoneCode' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '86', 'backendName' => 'phoneCode', ], 'phone' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '13800138000', 'backendName' => 'phone', 'sensitive' => true, ], 'phoneVerify' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'phoneVerify', ], 'email' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'zhangsan@company.com', 'backendName' => 'email', 'sensitive' => true, ], 'emailVerify' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'emailVerify', ], 'lang' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'zh-CN', 'backendName' => 'lang', ], 'source' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'dingtalk', 'backendName' => 'source', ], 'extend' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'example' => '', 'backendName' => 'extend', ], ], ], 'MergeContactGroup' => [ 'description' => '', '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', ], 'contacts' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'user-12345', 'extendType' => 'true', ], 'backendName' => 'contacts', ], 'extend' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'example' => '', 'backendName' => 'extend', ], 'source' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'dingtalk', 'backendName' => 'source', ], ], ], 'MergeRobot' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '', 'backendName' => 'name', ], 'webhook' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=abc123', 'backendName' => 'webhook', ], 'type' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'dingtalk', 'backendName' => 'type', ], 'createTime' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '2025-03-11T08:21:58.789Z', 'backendName' => 'gmtCreate', ], 'gmtModified' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '2025-03-11T08:21:58.789Z', 'backendName' => 'gmtModified', ], 'identifier' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'robot-12345', 'backendName' => 'identifier', ], 'lang' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'zh-CN', 'backendName' => 'lang', ], 'extend' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'dailyNoc' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'dailyNoc', ], 'dingSignKey' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'abc123', 'backendName' => 'dingSignKey', ], 'enableOutgoing' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'false', 'backendName' => 'enableOutgoing', ], 'cardTemplate' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'incident-card-template', 'backendName' => 'cardTemplate', ], 'dailyNocTime' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '09:00', 'backendName' => 'dailyNocTime', ], 'token' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'token-abc123', 'backendName' => 'token', 'sensitive' => true, ], ], 'backendName' => 'extend', ], 'source' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'dingtalk', 'backendName' => 'source', ], ], ], 'MergeWebhook' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'gmtCreate' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '2025-03-11T08:21:58.789Z', 'backendName' => 'gmtCreate', ], 'name' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '', 'backendName' => 'name', ], 'gmtModified' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'example' => '2025-03-11T08:21:58.789Z', 'backendName' => 'gmtModified', ], 'identifier' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'webhook-12345', 'backendName' => 'identifier', ], 'webhook' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=abc123', 'backendName' => 'webhook', ], 'type' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'dingtalk', 'backendName' => 'type', ], 'headers' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '{"Authorization": "Bearer abc123"}', 'backendName' => 'headers', ], 'method' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'POST', 'backendName' => 'method', ], 'contentType' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'application/json', 'backendName' => 'contentType', ], 'lang' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'zh-CN', 'backendName' => 'lang', ], 'extend' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '{"timeout": 3000}', 'backendName' => 'extend', ], 'source' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'dingtalk', 'backendName' => 'source', ], ], ], 'NotifyChannel' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'channelType' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '"DingTalk"', 'backendName' => 'channelType', ], 'receivers' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '[]', 'extendType' => 'true', ], 'backendName' => 'receivers', ], 'enabledSubChannels' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '[]', 'extendType' => 'true', ], 'backendName' => 'enabledSubChannels', ], ], ], 'NotifyStrategyForModify' => [ 'title' => 'A short description of struct', 'description' => 'Entity for viewing.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'routes' => [ 'title' => '', 'description' => 'Notification channel routing configuration.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'channels' => [ 'title' => '', 'description' => 'Notification channel.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'enabledSubChannels' => [ 'title' => '', 'description' => 'Enabled notification types.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Notification channel.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'SMS', 'extendType' => 'true', ], 'backendName' => 'enabledSubChannels', ], 'receivers' => [ 'title' => '', 'description' => 'Channel recipient.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Designated recipient.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'contactId', 'extendType' => 'true', ], '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', ], ], ], 'extendType' => 'true', ], 'backendName' => 'channels', ], 'filterSetting' => [ 'description' => 'Routing conditions.', 'visibility' => 'Public', 'backendName' => 'filterSetting', '$ref' => '#/components/schemas/FilterSetting', ], 'effectTimeRange' => [ 'title' => '', 'description' => 'Valid 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', ], 'dayInWeek' => [ 'title' => '', 'description' => 'Effective days (Monday to Sunday).', 'visibility' => 'Public', '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', ], ], 'backendName' => 'effectTimeRange', ], 'severities' => [ 'description' => 'Severity level list.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Severity levels: CRITICAL, WARNING, INFO.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'INFO', 'extendType' => 'true', ], 'backendName' => 'severities', ], ], 'extendType' => 'true', ], 'required' => true, 'backendName' => 'routes', ], 'notifyStrategyName' => [ 'title' => '', 'description' => 'Name.', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'Policy name.'."\n", 'backendName' => 'name', ], 'description' => [ 'title' => '', 'description' => 'Description.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'test', 'backendName' => 'description', ], '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', ], ], 'required' => true, 'backendName' => 'groupingSetting', ], 'customTemplateEntries' => [ 'title' => '', 'description' => 'Notification channel template.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Template details.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'templateUuid' => [ 'title' => '', 'description' => 'Template UUID.', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => '123123-12-31-231-23-12-3123', 'backendName' => 'templateUuid', ], 'targetType' => [ 'title' => '', 'description' => 'Notification type.', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'SMS', 'backendName' => 'targetType', ], ], 'extendType' => 'true', ], 'backendName' => 'customTemplateEntries', ], 'ignoreRestoredNotification' => [ 'title' => '', 'description' => 'Whether to notify on recovery.', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'false', 'backendName' => 'ignoreRestoredNotification', ], ], ], 'NotifyStrategyForView' => [ 'title' => 'A short description of struct', 'description' => 'Entity for viewing.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'routes' => [ 'title' => '', 'description' => 'Notification channel routing configuration.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Routing object.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'channels' => [ 'title' => '', 'description' => 'Notification channel.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Notification channel.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'enabledSubChannels' => [ 'title' => '', 'description' => 'Enabled notification types.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Channel.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'SMS', 'extendType' => 'true', ], 'backendName' => 'enabledSubChannels', ], 'receivers' => [ 'title' => '', 'description' => 'Channel recipient.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Recipient.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'user1', 'extendType' => 'true', ], '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', ], ], ], 'extendType' => 'true', ], 'backendName' => 'channels', ], 'filterSetting' => [ 'description' => 'Routing settings.', 'visibility' => 'Public', 'backendName' => 'filterSetting', '$ref' => '#/components/schemas/FilterSetting', ], 'effectTimeRange' => [ 'title' => '', 'description' => 'Field.', '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', ], 'dayInWeek' => [ 'title' => '', 'description' => 'Effective days (Monday to Sunday).', 'visibility' => 'Public', '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', ], ], 'backendName' => 'effectTimeRange', ], 'severities' => [ 'description' => 'Severity level list.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Severity levels: CRITICAL, WARNING, INFO.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'INFO', 'extendType' => 'true', ], 'backendName' => 'severities', ], ], 'extendType' => 'true', ], 'required' => true, 'backendName' => 'routes', ], 'workspace' => [ 'title' => 'workspace', 'description' => 'workspace', 'visibility' => 'Public', 'type' => 'string', 'example' => 'workspace-test', 'backendName' => 'workspace', ], 'notifyStrategyName' => [ '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', ], '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', ], 'description' => [ 'title' => '', 'description' => 'Description.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'test', 'backendName' => 'description', ], 'updateTime' => [ 'title' => '', 'description' => 'Update Time.', 'visibility' => 'Public', 'type' => 'string', 'example' => '2025-05-30T02:29:09Z', 'backendName' => 'updateTime', ], 'groupingSetting' => [ 'title' => '', 'description' => 'Grouping Setting.', 'visibility' => 'Public', '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', ], 'silenceSec' => [ 'title' => '', 'description' => 'Silence duration in seconds.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '300', 'backendName' => 'silenceSec', ], ], 'required' => true, 'backendName' => 'groupingSetting', ], 'customTemplateEntries' => [ 'title' => '', 'description' => 'Notification channel template.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Notification template configuration.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'templateUuid' => [ 'title' => '', 'description' => 'Template UUID.', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => '123-12-312-312-31-23', 'backendName' => 'templateUuid', ], 'targetType' => [ 'title' => '', 'description' => 'Notification type.', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'SMS', 'backendName' => 'targetType', ], ], 'extendType' => 'true', ], 'backendName' => 'customTemplateEntries', ], 'ignoreRestoredNotification' => [ 'title' => '', 'description' => 'Whether to notify on recovery.', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'ignoreRestoredNotification', ], 'userId' => [ 'title' => '', 'description' => 'User ID.', 'visibility' => 'Public', 'type' => 'string', 'example' => '123123****', 'backendName' => 'userId', ], ], ], 'PrometheusManagedInstance' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'prometheusInstanceId' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'rum-xxx', 'backendName' => 'prometheusInstanceId', ], 'prometheusInstanceName' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'rum-xxx', 'backendName' => 'prometheusInstanceName', ], 'regionId' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'cn-hangzhou', 'backendName' => 'regionId', ], 'workspace' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'workspace-test', 'backendName' => 'workspace', ], 'createTime' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '2025-03-11T08:21:58Z', 'backendName' => 'createTime', ], 'instanceType' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'test', 'backendName' => 'instanceType', ], 'status' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Running', 'backendName' => 'status', ], ], ], 'PushingSetting' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'templateUuid' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '"template-abc123"', 'backendName' => 'templateUuid', ], 'alertActionIds' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '"action-123"', 'extendType' => 'true', ], 'backendName' => 'alertActionIds', ], 'restoreActionIds' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '"restore-789"', 'extendType' => 'true', ], 'backendName' => 'restoreActionIds', ], ], ], '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', ], ], ], 'RumDnsResponse' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'domain' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'rum', 'backendName' => 'domain', ], 'result' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'result', ], 'message' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '""', 'backendName' => 'message', ], ], ], 'SubscriptionForModify' => [ 'title' => 'A short description of struct', 'description' => 'Entity for viewing.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'notifyStrategyId' => [ 'title' => '', 'description' => 'Notification policy UUID.', 'visibility' => 'Public', 'type' => 'string', 'example' => '123123', 'backendName' => 'notifyStrategyId', ], 'subscriptionName' => [ 'title' => '', 'description' => 'Name.', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'Test subscription.'."\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', ], 'pushingSetting' => [ 'title' => '', 'description' => 'Push settings.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'templateUuid' => [ 'title' => '', 'description' => 'Template UUID.', 'visibility' => 'Public', 'type' => 'string', 'example' => '123123123', 'backendName' => 'templateUuid', ], 'restoreActionIds' => [ 'title' => '', 'description' => 'Action integration plan ID list.', 'visibility' => 'Public', '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', ], 'alertActionIds' => [ 'title' => '', 'description' => 'Alert push action plan ID list.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Action integration ID.', 'visibility' => 'Public', 'type' => 'string', 'example' => '123123123', 'extendType' => 'true', ], 'backendName' => 'alertActionIds', ], ], 'backendName' => 'pushingSetting', ], ], ], 'SubscriptionForView' => [ 'title' => 'A short description of struct', 'description' => 'Entity for viewing.', 'visibility' => 'Public', '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', ], 'pushingSetting' => [ 'title' => '', 'description' => 'Push settings.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'templateUuid' => [ 'title' => '', 'description' => 'Template UUID.', 'visibility' => 'Public', 'type' => 'string', 'example' => '123123123', 'backendName' => 'templateUuid', ], 'restoreActionIds' => [ 'title' => '', 'description' => 'Recovery push action integration ID list.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Action integration 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', ], 'alertActionIds' => [ 'title' => '', 'description' => 'Alert push action integration ID list.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Action integration ID.', 'visibility' => 'Public', 'type' => 'string', 'example' => '123123123', 'extendType' => 'true', ], 'backendName' => 'alertActionIds', ], ], 'backendName' => 'pushingSetting', ], ], ], 'Tag' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'key' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'env', 'maxLength' => 128, 'backendName' => 'key', ], 'value' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'test', 'maxLength' => 256, 'backendName' => 'value', ], ], ], 'TransformAction' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'mapping' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'additionalProperties' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '{"warning":"WARNING"}', ], 'backendName' => 'mapping', ], 'variable' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'var1', 'backendName' => 'variable', ], 'filterSetting' => [ 'description' => '', 'visibility' => 'Public', 'backendName' => 'filterSetting', '$ref' => '#/components/schemas/FilterSetting', ], 'source' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'data.subject', 'backendName' => 'source', ], 'labelKey' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'labelkey1', 'backendName' => 'labelKey', ], 'type' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'SET_FIELD', 'backendName' => 'type', ], 'value' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'value1', 'backendName' => 'value', ], 'regExp' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '(.*):(.*)', 'backendName' => 'regExp', ], 'target' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'SUBJECT', 'backendName' => 'target', ], ], ], 'TransformerForModify' => [ 'title' => 'A short description of struct', 'description' => 'Data transformer.', 'visibility' => 'Public', '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', ], 'actions' => [ 'title' => '', 'description' => 'Transformation operation.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Processing action.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/TransformAction', ], 'backendName' => 'actions', ], ], ], 'TransformerForView' => [ 'title' => 'A short description of struct', 'description' => 'Data transformer.', '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.', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'false', 'backendName' => 'enabled', ], 'sortId' => [ 'title' => '', 'description' => 'Sort order.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'backendName' => 'sortId', ], 'transformerId' => [ 'title' => 'transformer Id', 'description' => 'transformer Id', 'visibility' => 'Public', 'type' => 'string', 'example' => '1123123123123', 'backendName' => 'transformerId', ], 'quitAfterMatch' => [ 'title' => '', 'description' => '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', ], 'updateTime' => [ 'title' => '', 'description' => 'Update Time.', 'visibility' => 'Public', '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', ], 'actions' => [ 'title' => '', 'description' => 'Transformation operation.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Processing action.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/TransformAction', ], 'backendName' => 'actions', ], 'userId' => [ 'title' => '', 'description' => 'User ID.', 'visibility' => 'Public', 'type' => 'string', 'example' => '123123123**', 'backendName' => 'userId', ], ], ], 'WorkspaceFilterSetting' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'tagSelector' => [ 'description' => '', 'visibility' => 'Public', 'backendName' => 'tagSelector', '$ref' => '#/components/schemas/FilterSetting', ], 'workspaceUuids' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '"ws-abc123"', 'extendType' => 'true', ], 'backendName' => 'workspaceUuids', ], ], ], ], ], 'apis' => [ 'PutWorkspace' => [ 'summary' => 'Create Workspace', 'path' => '/workspace/{workspaceName}', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ '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' => [ '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', 'required' => true, 'example' => 'sls-project-test-001', 'maxLength' => 128, 'minLength' => 1, 'default' => '', ], ], 'required' => false, ], ], [ 'name' => 'workspaceName', 'in' => 'path', 'schema' => [ 'description' => 'Name of the workspace', 'type' => 'string', 'required' => true, 'example' => 'workspace-test-001', 'maxLength' => 56, 'minLength' => 1, ], ], ], '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'GetWorkspace' => [ 'summary' => 'Get Workspace', 'path' => '/workspace/{workspaceName}', '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' => 'workspaceName', 'in' => 'path', 'schema' => [ 'title' => '实例 ID。', 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'workspace-test-001', ], ], ], '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"createTime\\": \\"2025-03-11T08:21:58Z\\",\\n \\"description\\": \\"workspace test\\",\\n \\"lastModifyTime\\": \\"2025-03-11T08:21:58Z\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"slsProject\\": \\"sls-project-test-001\\",\\n \\"workspaceName\\": \\"workspace-test-001\\",\\n \\"displayName\\": \\"workspace-test\\"\\n}","type":"json"}]', 'title' => 'Get Workspace', 'translator' => 'machine', ], 'ListWorkspaces' => [ 'summary' => 'Get Workspace List', 'path' => '/workspace', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREcms5OJOSH', ], ], 'parameters' => [ [ 'name' => 'workspaceName', 'in' => 'query', 'schema' => [ 'description' => 'Workspace name, fuzzy search', 'type' => 'string', 'required' => false, 'example' => 'workspace-test-001', ], ], [ 'name' => 'nextToken', 'in' => 'query', 'schema' => [ 'description' => 'Pagination Token', 'type' => 'string', 'required' => false, 'example' => 'xxxxxxxxxx', ], ], [ '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', ], ], [ 'name' => 'workspaceNameList', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'description' => 'Workspace name, exact match', 'type' => 'array', 'items' => [ 'description' => 'Workspace name, exact match', 'type' => 'string', 'required' => false, 'example' => 'workspace-test-001', ], 'required' => false, 'example' => 'workspace-test-001', ], ], [ 'name' => 'region', 'in' => 'query', 'schema' => [ 'description' => 'Region', 'type' => 'string', 'required' => false, 'example' => 'cn-heyuan', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'maxResults' => [ 'description' => 'Page size'."\n" .'Default value:'."\n" .' 50'."\n" .'Maximum value:'."\n" .' 50', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'nextToken' => [ 'description' => 'Pagination Token', 'type' => 'string', 'example' => 'xxxxxxxxxx', ], 'requestId' => [ 'title' => 'Id of the request', 'description' => 'Request ID'."\n" ."\n", 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', ], 'total' => [ 'title' => '当总结果个数大于MaxResults时，用于翻页的token。', 'description' => 'Total count', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'workspaces' => [ 'title' => '数组，返回示例目录。', 'description' => 'List of workspaces', 'type' => 'array', 'items' => [ 'title' => 'WorkspaceItemType', 'description' => 'WorkspaceItemType', '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' => '', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"maxResults\\": 10,\\n \\"nextToken\\": \\"xxxxxxxxxx\\",\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"total\\": 1,\\n \\"workspaces\\": [\\n {\\n \\"createTime\\": \\"2025-03-11T08:21:58Z\\",\\n \\"displayName\\": \\"workspace-test\\",\\n \\"description\\": \\"workspace test\\",\\n \\"lastModifyTime\\": \\"2025-03-11T08:21:58Z\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"slsProject\\": \\"sls-project-test-001\\",\\n \\"workspaceName\\": \\"workspace-test-001\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Get Workspace List', 'translator' => 'machine', ], 'DeleteWorkspace' => [ 'summary' => 'Delete Workspace', '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' => 'Workspace Name', 'type' => 'string', 'required' => true, 'example' => 'workspace-test-001', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', ], ], ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', ], 'GetCloudResource' => [ 'summary' => '查询云资源中心', 'path' => '/cloudresource', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREcms5OJOSH', ], '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', ], ], ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => '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' => 'query', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => '.entity with(domain=\'acs\', type=\'acs.k8s.node\') | limit 0, 10', ], ], ], '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', ], ], ], ], ], '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}","type":"json"}]', ], 'DeleteCloudResource' => [ 'summary' => '删除云资源中心', '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' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', ], 'CreateEntityStore' => [ 'summary' => 'Create storage related to EntityStore', 'path' => '/workspace/{workspaceName}/entitystore', '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' => 'workspaceName', 'in' => 'path', 'schema' => [ 'description' => 'workspace name', 'type' => 'string', 'required' => true, 'example' => 'workspace-test-001', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"workspaceName\\": \\"workspace-test-001\\"\\n}","type":"json"}]', 'title' => 'Create EntityStore', 'translator' => 'machine', ], 'GetEntityStore' => [ 'summary' => 'Get EntityStore related storage information', 'path' => '/workspace/{workspaceName}/entitystore', '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' => 'workspaceName', 'in' => 'path', 'schema' => [ 'description' => 'Workspace name'."\n" ."\n", 'type' => 'string', 'required' => true, 'example' => 'workspace-test-001', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], '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', ], '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', ], 'security' => [ [ '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' => 'Content encoding type for the compression algorithm', 'type' => 'string', 'required' => false, 'example' => 'gzip', 'default' => 'gzip', ], ], [ 'name' => 'workspace', 'in' => 'path', 'schema' => [ 'description' => 'Workspace name', 'type' => 'string', 'required' => true, 'example' => 'workspace-test-001', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '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', ], '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', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ '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', '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' => '{}', ], ], ], ], ], ], ], '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', 'translator' => 'machine', ], 'DeleteEntityStore' => [ 'summary' => 'Delete EntityStore related storage', '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' => 'workspace name', 'type' => 'string', 'required' => true, 'example' => 'workspace-test-001', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => 'request ID', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], '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' => 'Workspace name', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'Request Body', 'type' => 'object', 'properties' => [ 'description' => [ 'description' => 'Umodel description', 'type' => 'string', 'required' => false, 'example' => 'workspace test', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'GetUmodel' => [ 'summary' => 'Get Umodel configuration information', 'path' => '/workspace/{workspace}/umodel', '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, 'example' => 'workspace-test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'commonSchemaRef' => [ 'description' => 'This field does not need to be filled currently', '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', ], ], ], ], 'description' => [ 'description' => 'Umodel description', 'type' => 'string', 'example' => 'workspace test', ], 'regionId' => [ 'description' => 'Region', 'type' => 'string', 'example' => 'cn-heyuan', ], 'requestId' => [ 'description' => 'Request ID', 'type' => 'string', 'example' => '123-123123-sdf-435-3123', ], 'workspace' => [ 'description' => 'Workspace name', 'type' => 'string', 'example' => 'workspace-test', ], ], ], ], ], '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' => 'Get Umodel configuration information', 'translator' => 'machine', ], 'UpdateUmodel' => [ 'summary' => 'Update Umodel configuration information', 'path' => '/workspace/{workspace}/umodel', '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' => 'workspace', 'in' => 'path', 'schema' => [ 'description' => 'Workspace name', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'Request Body', 'type' => 'object', 'properties' => [ 'description' => [ 'description' => 'Description.', 'type' => 'string', 'required' => false, 'example' => 'workspace test', ], ], 'required' => false, ], ], ], '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', ], ], ], ], ], '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', ], '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' => 'workspace name', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => 'request ID', 'type' => 'string', 'example' => '123123-3213-345-9941-345345345', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], '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, 'example' => 'workspace-test', ], ], [ 'name' => 'method', 'in' => 'query', 'schema' => [ 'description' => 'Method', 'type' => 'string', 'required' => true, 'example' => 'ListData', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '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" .'}', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Return result', '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'UpsertUmodelData' => [ 'summary' => 'Write Umodel Elements', 'path' => '/workspace/{workspace}/umodel/data', 'methods' => [ 'patch', ], 'schemes' => [ 'https', ], 'security' => [ [ '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' => 'Workspace name', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', ], ], [ 'name' => 'method', 'in' => 'query', 'schema' => [ 'description' => 'Method', 'type' => 'string', 'required' => false, 'example' => 'Upsert', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'List of elements', 'type' => 'object', 'properties' => [ 'elements' => [ 'description' => 'Element content', 'type' => 'array', 'items' => [ 'description' => 'Element content', 'type' => 'any', 'required' => false, 'example' => '{}', ], 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => 'Request ID.', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', 'title' => 'Add or Overwrite Umodel (Elements)', 'translator' => 'machine', ], 'DeleteUmodelData' => [ 'summary' => 'Delete Umodel Elements', 'path' => '/workspace/{workspace}/umodel/data', 'methods' => [ 'delete', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', 'schema' => [ 'description' => 'Workspace name', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', ], ], [ 'name' => 'domain', 'in' => 'query', 'schema' => [ 'description' => 'Can specify the name of a specific Umodel data, leaving it blank means all', 'type' => 'string', 'required' => false, 'example' => 'apm', ], ], [ 'name' => 'name', 'in' => 'query', 'schema' => [ 'description' => 'Can specify the name of a specific Umodel data, leaving it blank means all', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => 'Request ID', 'type' => 'string', 'example' => '111111-222-333-1111-33333', ], ], ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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', ], ], ], ], ], ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', ], ], [ 'name' => 'group', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'enumValueTitles' => [], 'example' => 'apm-common', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****', ], ], ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ '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' => '', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', ], ], [ 'name' => 'group', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'card-service-daily01', ], ], [ 'name' => 'version', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => '0.1.0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-************', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-************\\"\\n}","type":"json"}]', 'title' => 'UpsertUmodelCommonSchemaRef', ], 'CreateChat' => [ 'summary' => '创建对话', 'path' => '/chat', 'methods' => [ 'post', ], 'schemes' => [ 'https', 'sse', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/octet-stream', ], 'produces' => [ 'application/octet-stream', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', '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, ], ], ], '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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"}]', ], 'CreateDigitalEmployee' => [ 'summary' => '创建DigitalEmployee', 'path' => '/digital-employee', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', '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', ], ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '', 'type' => 'string', 'example' => '3B311FD9-A60B-55E0-A896-A0C73*********', ], 'name' => [ 'description' => '', 'type' => 'string', 'example' => 'test', ], ], ], ], ], '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', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'name', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], 'errorCodes' => [ 404 => [ [ 'errorCode' => 'InvalidDigitalEmployee.NotFound', 'errorMessage' => 'The specified DigitalEmployee does not exist.', ], ], ], '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"}]', ], 'UpdateDigitalEmployee' => [ 'summary' => '更新UpdateDigitalEmployee', 'path' => '/digital-employee/{name}', 'methods' => [ 'patch', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'name', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', '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, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-***', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-***\\"\\n}","type":"json"}]', ], 'ListDigitalEmployees' => [ 'summary' => '列出资源DigitalEmployee', 'path' => '/digital-employee', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '10', 'title' => '', ], ], [ 'name' => 'nextToken', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'xxxxxx', 'title' => '', ], ], [ 'name' => 'name', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'employeeType', 'in' => 'query', 'schema' => [ 'type' => 'string', 'enum' => [ 'system', 'custom', ], ], ], [ 'name' => 'displayName', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'tags', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '标签', 'type' => 'array', 'items' => [ 'title' => '标签', '$ref' => '#/components/schemas/Tag', ], ], ], [ 'name' => 'resourceGroupId', 'in' => 'query', 'schema' => [ 'title' => '资源组 ID', 'type' => 'string', 'example' => 'rg-ae******ey', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], ], ], ], ], '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', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'name', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', ], 'CreateThread' => [ 'summary' => '创建会话', 'path' => '/digitalEmployee/{name}/thread', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'name', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ '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, ], ], ], '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_id01', ], ], ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'name', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'threadId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'thread_id01', ], ], ], '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', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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"}]', ], 'GetThreadData' => [ 'summary' => '获取会话数据', 'path' => '/digitalEmployee/{name}/thread/{threadId}/data', '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' => 'name', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'threadId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'thread_id01', ], ], [ 'name' => 'nextToken', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'xxxxxxxxxx', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', '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' => '当前数字员工信息', ], ], ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'name', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'status', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'Running', ], ], [ 'name' => 'threadId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'thread_id01', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', ], ], [ 'name' => 'nextToken', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'xxxxxx', ], ], [ '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, ], ], ], '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', ], ], ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'name', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'threadId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'thread-t71rrw-1s7r7z9gu0v2s', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '', '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', ], ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', ], 'threadId' => [ 'description' => '', 'type' => 'string', 'example' => 'thread_id01', ], 'version' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '0.1.0', ], ], ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'name', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'threadId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'thread_id01', ], ], ], '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', ], ], ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', '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, ], ], 'required' => false, ], ], [ 'name' => 'integrationPolicyId', 'in' => 'path', 'schema' => [ 'description' => 'Access center policy ID', 'type' => 'string', 'required' => true, 'example' => 'polixy-xxxxxxxxx', ], ], ], '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' => '0CEC5375-C554-562B-A65F-9A629907C1F0', ], ], ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'force', 'in' => 'query', 'schema' => [ 'description' => 'Whether to forcibly delete the cloud-native all-in-one machine,'."\n" .'default value: `false`.', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'policyId', 'in' => 'path', 'schema' => [ 'description' => 'Policy environment ID.', 'type' => 'string', 'required' => true, 'example' => 'policy-273c360bed1948818c5fb861886bc405', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CD8BA7D6-995D-578D-9941-78B0FECD14B5\\"\\n}","type":"json"}]', 'title' => 'Delete Access Center Policy', 'translator' => 'machine', ], 'CreateIntegrationPolicy' => [ 'summary' => 'Create Access 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.', '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', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ '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' => [ 'title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5', ], 'created' => [ 'description' => 'Whether it is created.', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], '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 interface is used to support users in creating event integration.', 'translator' => 'machine', ], 'UpdateAddonRelease' => [ 'summary' => 'Upgrade Access Component', 'path' => '/integration-policies/{policyId}/addon-releases/{releaseName}', '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' => 'releaseName', 'in' => 'path', 'schema' => [ 'title' => 'Release 的名称。', 'description' => 'The name of the Release.', 'type' => 'string', 'required' => true, 'example' => 'test-gpu-integration-name', ], ], [ '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', ], ], 'required' => false, ], ], [ 'name' => 'policyId', 'in' => 'path', 'schema' => [ 'title' => '策略环境 ID。', 'description' => 'Policy environment ID.', 'type' => 'string', 'required' => true, 'example' => 'policy-xxxxxxxxxxxx', ], ], ], '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9F00A7AF-2728-5424-B321-79D39C00A1EC\\"\\n}","type":"json"}]', 'title' => 'Update Access Component Configuration', 'translator' => 'machine', ], 'ListIntegrationPolicyStorageRequirements' => [ 'summary' => 'Get Storage Requirements Information for Access Center Policy', 'path' => '/integration-policies/{policyId}/storage-requirements', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'policyId', 'in' => 'path', 'schema' => [ 'title' => '接入中心策略ID', 'description' => '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', ], ], [ 'name' => 'storageType', 'in' => 'query', 'schema' => [ 'title' => '存储类型', 'description' => 'Storage Type, LogStore/Prometheus/TraceStore/EventStore/EntityStore.', 'type' => 'string', 'required' => false, 'example' => 'LogStore', ], ], [ 'name' => 'addonReleaseName', 'in' => 'query', 'schema' => [ 'title' => 'AddonRelease的名称。', 'description' => 'Name of AddonRelease.', 'type' => 'string', 'required' => false, 'example' => 'kafka-17201012937917', ], ], ], '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', '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', ], ], ], 'spec' => [ 'description' => 'Resource spec', '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)', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'example' => 'system-key=value', 'description' => 'Tags to be applied to the target storage (injected as system tags)', ], ], 'tags' => [ 'description' => 'Tags to be applied to the target storage (injected as regular tags)', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'example' => 'key=value', 'description' => 'Tags to be applied to the target storage (injected as regular tags)', ], ], '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', ], ], ], 'addonReleaseNames' => [ 'description' => 'Collection of AddonReleases.', 'type' => 'array', 'items' => [ 'description' => 'Name of the AddonRelease.', 'type' => 'string', 'example' => 'kafka-17201238912', ], ], ], ], ], ], ], ], ], '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' => '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', ], 'ListIntegrationPolicyPodMonitors' => [ 'summary' => 'Get PodMonitor Resources of Access Center Policy', 'path' => '/integration-policies/{policyId}/pod-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' => '接入中心策略ID。', 'description' => 'Access center policy ID.', 'type' => 'string', 'required' => true, 'example' => 'policy-1d4634924c8ba599822c601fcee3', ], ], [ 'name' => 'addonReleaseName', 'in' => 'query', 'schema' => [ 'title' => 'Addon Release名称。', 'description' => 'Addon Release name.', 'type' => 'string', 'required' => false, 'example' => 'release-123456789', ], ], [ 'name' => 'namespace', 'in' => 'query', 'schema' => [ 'title' => '命名空间。', 'description' => 'Namespace.', 'type' => 'string', 'required' => false, 'example' => 'default', ], ], [ 'name' => 'encryptYaml', 'in' => 'query', 'schema' => [ 'title' => '是否加密Yaml。', 'description' => 'Whether to encrypt Yaml.', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], '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', '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', ], ], ], ], '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', ], ], ], ], ], '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 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', ], 'ListIntegrationPolicyDashboards' => [ 'summary' => 'Policy Dashboard List', 'path' => '/integration-policies/{policyId}/dashboards', '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' => 'Policy ID.', 'type' => 'string', 'required' => true, 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e', ], ], [ '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', ], ], ], ], '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', ], ], ], ], ], ], ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'policyId', 'in' => 'path', 'schema' => [ 'title' => '接入中心策略ID。', 'description' => 'Access center policy ID.', 'type' => 'string', 'required' => true, 'example' => 'policy-d95435164593aece55f9999ce45c', ], ], [ 'name' => 'addonReleaseName', 'in' => 'query', 'schema' => [ 'title' => 'Addon Release名称。', 'description' => 'Addon Release name.', 'type' => 'string', 'required' => false, 'example' => 'release12345678', ], ], [ 'name' => 'encryptYaml', 'in' => 'query', 'schema' => [ 'title' => '是否加密Yaml。', 'description' => 'Whether to encrypt Yaml.', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'namespace', 'in' => 'query', 'schema' => [ 'title' => '命名空间。', 'description' => 'Namespace.', 'type' => 'string', 'required' => false, 'example' => 'arms-prom', ], ], ], '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', 'type' => 'array', 'items' => [ 'description' => 'Custom service discovery rules', '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', 'type' => 'array', 'items' => [ 'description' => 'Custom configurations', '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' => '{}', ], ], ], ], ], ], ], ], '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', ], ], ], ], ], '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', 'translator' => 'machine', ], 'ListIntegrationPolicies' => [ 'summary' => 'Query Access Center Policy List Information', 'path' => '/integration-policies', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'policyId', 'in' => 'query', 'schema' => [ 'description' => 'Policy ID.', 'type' => 'string', 'required' => false, 'example' => 'policy-93817a401f78435596d745a97d2e85a1', ], ], [ 'name' => 'policyName', 'in' => 'query', 'schema' => [ 'description' => 'Rule name.', 'type' => 'string', 'required' => false, 'example' => 'prod-database', ], ], [ 'name' => 'policyType', 'in' => 'query', 'schema' => [ 'description' => 'Policy type', 'type' => 'string', 'required' => false, 'example' => 'CS', ], ], [ 'name' => 'addonName', 'in' => 'query', 'schema' => [ 'description' => 'Addon name.', 'type' => 'string', 'required' => false, 'example' => 'cs-default', ], ], [ 'name' => 'filterRegionIds', 'in' => 'query', 'schema' => [ 'description' => 'Used for Region query, separated by commas', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing,cn-hangzhou', 'title' => '指定筛选的regionId（目前仅支持单regioinId，暂不支持多值）。', ], ], [ 'name' => 'resourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'Resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-xxxxx', ], ], [ 'name' => 'tag', 'in' => 'query', 'style' => 'json', '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', ], 'value' => [ 'description' => 'Tag value', 'type' => 'string', 'required' => false, 'example' => 'value', ], ], 'required' => false, ], 'required' => false, ], ], [ 'name' => 'nextToken', 'in' => 'query', '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', 'required' => false, 'example' => 'mvnX6zqg3P', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => 'Maximum number of results to return. Default is 30, with a maximum of 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', ], ], [ 'name' => 'entityGroupIds', 'in' => 'query', 'schema' => [ 'description' => 'Filter for entity IDs, separated by commas', 'type' => 'string', 'required' => false, 'example' => 'eg-1,eg-2,eg-3', ], ], [ 'name' => 'workspace', 'in' => 'query', 'schema' => [ 'description' => 'Workspace.', 'type' => 'string', 'required' => false, 'example' => 'demo', ], ], [ 'name' => 'query', 'in' => 'query', 'schema' => [ 'description' => 'Used for general queries', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'prometheusInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'Instance ID.', 'type' => 'string', 'required' => false, 'example' => 'cmee-622d27c2e87d49debceeebc7c642610e', ], ], [ 'name' => 'bindResourceId', 'in' => 'query', 'schema' => [ 'title' => '绑定的资源Id', 'description' => 'Bound resource ID', 'type' => 'string', 'required' => false, 'example' => '622d27c2e87d49debceeebc7c642610e', ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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', ], ], ], 'entityGroup' => [ 'description' => 'Entity group', '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', 'type' => 'string', 'example' => 'test-eg', ], 'entityRules' => [ 'description' => 'Entity group', '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', ], ], ], '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', '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', ], ], ], 'csUmodelStatus' => [ 'description' => 'Container environment umodel installation status.', 'type' => 'boolean', 'example' => 'true', ], ], ], ], 'requestId' => [ 'title' => 'Id of the request', 'description' => 'ID of the request', 'type' => 'string', 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5', ], 'totalCount' => [ 'description' => 'Total number of entries', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], ], ], ], ], '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', ], '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' => 'Policy environment ID.', 'type' => 'string', 'required' => true, 'example' => 'policy-xxxxxxxxxxxx', ], ], [ 'name' => 'addonName', 'in' => 'query', 'schema' => [ 'title' => '组件 Addon 名称。', 'description' => 'Addon component name.', 'type' => 'string', 'required' => false, 'example' => 'cs-gpu', ], ], [ 'name' => 'parentAddonReleaseId', 'in' => 'query', 'schema' => [ 'title' => '父级 AddonReleaseId。', 'description' => 'Parent AddonReleaseId.', 'type' => 'string', 'required' => false, 'example' => 'policy-xxxxxxxxxxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ 'releases' => [ 'description' => 'Set of add-on component information.', '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.', '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', ], ], ], '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', ], ], ], ], '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], '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' => 'policyId', 'in' => 'path', 'schema' => [ 'description' => 'Policy ID.', 'type' => 'string', 'required' => true, 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'policy' => [ 'description' => 'Access 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', ], ], ], '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', ], 'entityRules' => [ 'description' => 'Entity rules.', 'type' => 'object', 'properties' => [ 'annotations' => [ 'description' => 'Annotations.', 'type' => 'array', 'items' => [ 'description' => 'Annotations.', 'type' => 'object', 'properties' => [ 'op' => [ 'description' => 'Operation to be performed.', 'type' => 'string', 'example' => 'add', ], 'tagKey' => [ 'description' => 'Tag key.', 'type' => 'string', 'example' => 'use', ], 'tagValues' => [ 'description' => 'Tag values.', 'type' => 'array', 'items' => [ 'description' => 'Tag values.', 'type' => 'string', 'example' => 'db', ], ], ], ], ], 'entityTypes' => [ 'description' => 'List of entity types.', 'type' => 'array', 'items' => [ 'description' => 'Entity type.', 'type' => 'string', 'example' => 'CS', ], ], 'fieldRules' => [ 'description' => 'List of 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.', 'type' => 'array', 'items' => [ 'description' => 'Field content.', 'type' => 'string', 'example' => 'test-value', ], ], 'op' => [ 'description' => 'Operation to be performed.', 'type' => 'string', 'example' => 'add', ], ], ], ], 'instanceIds' => [ 'description' => 'Instance ID.', 'type' => 'array', 'items' => [ 'description' => 'Instance ID.', 'type' => 'string', 'example' => 'i-uf6bsi1aivfbn581buj6,i-uf6eu25p75drryo4712u', ], ], 'ipMatchRule' => [ 'description' => 'IP matching 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', ], ], ], 'labels' => [ 'description' => 'Labels.', 'type' => 'array', 'items' => [ 'description' => 'Label `key` value.', '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', ], 'tagValues' => [ 'description' => 'List of tag values.', 'type' => 'array', 'items' => [ 'description' => 'Tag value.', 'type' => 'string', 'example' => 'value1', ], ], ], ], ], 'regionIds' => [ 'description' => 'List of region IDs.', 'type' => 'array', 'items' => [ 'description' => 'Region ID.', 'type' => 'string', 'example' => 'cn-beijing', ], ], 'resourceGroupId' => [ 'description' => 'Resource group ID.', 'type' => 'string', 'example' => 'rg-aek3aqsuvlv3yyq', ], 'tags' => [ 'description' => 'Tag values.', 'type' => 'array', 'items' => [ 'description' => 'Resource tag value.', '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', ], 'tagValues' => [ 'description' => 'List of tag values.', 'type' => 'array', 'items' => [ 'description' => 'Tag value.', 'type' => 'string', 'example' => 'values', ], ], ], ], ], ], ], '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', ], ], ], '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', ], ], ], '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', ], 'tags' => [ 'description' => 'Tag keys.', 'type' => 'array', 'items' => [ 'description' => 'Tags.', 'type' => 'object', 'properties' => [ 'key' => [ 'description' => 'Tag key.', 'type' => 'string', 'example' => 'use', ], 'value' => [ 'description' => 'Tag value.', 'type' => 'string', 'example' => 'db', ], ], ], ], 'userId' => [ 'description' => 'User ID.', 'type' => 'string', 'example' => 'u123456', ], 'workspace' => [ 'description' => 'Workspace.', 'type' => 'string', 'example' => 'prometheus', ], 'csUmodelStatus' => [ 'type' => 'boolean', 'description' => 'Cs umodel status', ], ], ], 'requestId' => [ 'title' => 'Id of the request', 'description' => 'ID of the request.', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'releaseName', 'in' => 'path', 'schema' => [ 'title' => 'AddonRelease 的名称。', 'description' => 'The name of the AddonRelease.', 'type' => 'string', 'required' => true, 'example' => 'test-gpu-integration-name', ], ], [ 'name' => 'policyId', 'in' => 'path', 'schema' => [ 'title' => '环境 ID。', 'description' => 'Environment ID.', 'type' => 'string', 'required' => true, 'example' => 'policy-xxxxxxxxxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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":""}', ], 'release' => [ 'description' => 'Detailed information.', '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', ], '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.', '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', ], ], ], ], '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', ], 'workspace' => [ 'title' => '工作空间。', 'description' => 'Workspace.', 'type' => 'string', 'example' => 'default', ], 'entityRules' => [ 'title' => '实体详情。', 'description' => 'Entity details.', '$ref' => '#/components/schemas/EntityGroupBase', ], ], ], 'requestId' => [ 'title' => '请求 ID。', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'releaseName', 'in' => 'query', 'schema' => [ 'title' => 'AddonRelease 的名称。', 'description' => 'The name of the AddonRelease.', 'type' => 'string', 'required' => false, 'example' => 'test-gpu-integration-name', ], ], [ 'name' => 'force', 'in' => 'query', 'schema' => [ 'title' => '是否硬性删除，默认 false。', 'description' => 'Whether to force deletion, default is false.', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => '是', 'false' => '否', ], 'example' => 'false', ], ], [ 'name' => 'policyId', 'in' => 'path', 'schema' => [ 'title' => '环境 ID。', 'description' => 'Environment ID.', 'type' => 'string', 'required' => true, 'example' => 'policy-xxxxxxxxxxxxx', ], ], [ 'name' => 'addonName', '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => '请求 ID。', 'description' => 'Request ID.', 'type' => 'string', 'example' => '264C3E89-BE6E-5F82-A484-CE9C2196C7DC', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-BE6E-5F82-A484-CE9C2196C7DC\\"\\n}","type":"json"}]', 'title' => 'Uninstall Access Component', 'translator' => 'machine', ], 'CreateAddonRelease' => [ 'summary' => 'Install the access component, representing a single access attempt', 'path' => '/integration-policies/{policyId}/addon-releases', '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' => [ 'title' => '请求体参数。', 'description' => 'Request body parameters.', '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' => '云服务环境', ], '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', ], ], 'required' => false, ], ], [ 'name' => 'policyId', 'in' => 'path', 'schema' => [ 'title' => '环境策略 ID。', 'description' => 'Environment policy ID.', 'type' => 'string', 'required' => true, 'example' => 'policy-yyyyyyyyyy', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '返回数据。', 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ 'release' => [ 'title' => '接入组件信息。', 'description' => 'Accessed component information.', 'type' => 'object', 'properties' => [ 'addonName' => [ 'title' => '接入监控的组件 Addon 名称。', 'description' => 'The Addon name of the component being monitored.', 'type' => 'string', 'example' => 'cs-gpu', ], 'alertRuleCount' => [ 'title' => '告警组数量。', 'description' => 'Number of alert groups.', 'type' => 'integer', 'format' => 'int64', 'example' => '6', ], 'conditions' => [ 'title' => '组件安装阶段信息。', 'description' => 'Component installation phase information.', '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', ], ], ], ], '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', ], ], ], 'requestId' => [ 'title' => '请求 ID。', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], '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' => 'CMS2.0 Workspace', 'type' => 'string', 'required' => true, 'example' => 'my-test-ws', ], ], [ 'name' => 'type', 'in' => 'path', 'schema' => [ 'description' => 'Application Observability Type', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'rum' => '用户体验监控', 'apm' => '应用性能监控', ], 'example' => 'apm', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '4852B9B5-345C-5CBC-A15F-786D83ECCBBA', ], 'type' => [ 'description' => 'Application Observability Type', 'type' => 'string', 'enumValueTitles' => [ 'rum' => 'rum', 'apm' => 'apm', ], 'example' => 'apm', ], 'regionId' => [ 'description' => 'Region', 'type' => 'string', 'example' => 'cn-hangzhou', ], 'workspace' => [ 'description' => 'Workspace Name', 'type' => 'string', 'example' => 'default-cms-1654218***343050-cn-hangzhou', ], 'status' => [ 'description' => 'Resource Initialization Status', 'type' => 'string', 'enumValueTitles' => [ 'Running' => '正常', ], 'example' => 'Running', ], 'entryPointInfo' => [ 'description' => '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', ], ], ], 'feeType' => [ 'description' => 'Billing Type', 'type' => 'string', 'example' => 'arms=serverless;xtrace=serverless', ], 'settings' => [ 'description' => 'System Configuration', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'example' => '{"trace_aggregate":"enable"}', 'description' => 'Configuration Key-Value Pairs', ], ], 'quotas' => [ 'description' => 'Quota Configuration', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'example' => '{"arms_agent_hour": "48"}', 'description' => 'Quota Configuration Keys', ], ], ], ], ], ], '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"}]', 'title' => 'Get Application Observability', 'extraInfo' => 'settIngs系统配置支持如下：'."\n" .'* trace_aggregate : enable / disable，用于开源探针接入场景控制是否关闭指标生成', 'translator' => 'machine', ], 'DeleteService' => [ 'summary' => 'Delete Service', 'path' => '/workspace/{workspace}/service/{serviceId}', 'methods' => [ 'delete', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', 'schema' => [ 'description' => 'Workspace name', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'title' => '工作空间', ], ], [ 'name' => 'serviceId', 'in' => 'path', 'schema' => [ 'description' => 'Service ID', 'type' => 'string', 'required' => true, 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', 'title' => '应用服务id', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => 'Request ID', 'type' => 'string', 'example' => '51B6A3E8-EA9E-5143-BE11-8E5F83474C95', 'title' => '请求id', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"51B6A3E8-EA9E-5143-BE11-8E5F83474C95\\"\\n}","type":"json"}]', 'title' => 'Delete Application Observability Service', 'translator' => 'machine', ], 'UpdateService' => [ 'summary' => 'Update Service', 'path' => '/workspace/{workspace}/service/{serviceId}', 'methods' => [ 'put', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', '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' => '工作空间', ], ], [ 'name' => 'serviceId', 'in' => 'path', 'schema' => [ 'description' => 'Service ID', 'type' => 'string', 'required' => true, 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', 'title' => '应用资源id', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'Request body parameters.', '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', ], ], 'required' => false, 'title' => '应用服务', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => 'Request ID.', 'type' => 'string', 'example' => '123-0F43-23423-AC43-34234', 'title' => '请求id', ], 'serviceId' => [ 'description' => 'Service ID.', 'type' => 'string', 'example' => 'em87vd@c2e25bcfe0e21ce0***', 'title' => '应用服务id', ], ], ], ], ], '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', ], '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' => 'Workspace name', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'title' => '工作空间', ], ], [ 'name' => 'serviceId', 'in' => 'path', 'schema' => [ 'description' => 'Service ID.', 'type' => 'string', 'required' => true, 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', 'title' => '应用服务id', ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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', ], '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' => '标签', 'type' => 'object', 'properties' => [ 'key' => [ 'title' => '标签key', 'type' => 'string', 'example' => 'env', ], 'value' => [ 'title' => '标签value', 'type' => 'string', 'example' => 'prod', ], ], ], ], ], 'title' => '应用服务', ], ], ], ], ], 'errorCodes' => [ 404 => [ [ 'errorCode' => 'InvalidService.NotFound', 'errorMessage' => 'The specified Service does not exist.', ], ], ], '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', 'translator' => 'machine', ], 'CreateService' => [ 'summary' => 'Create Service', '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.', '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' => '标签数组', 'type' => 'array', 'items' => [ 'title' => '标签', 'type' => 'object', 'properties' => [ 'key' => [ 'title' => '标签key', 'type' => 'string', 'example' => 'env', ], 'value' => [ 'title' => '标签value', 'type' => 'string', 'example' => 'prod', ], ], ], ], ], 'required' => false, ], ], [ 'name' => 'workspace', 'in' => 'path', 'schema' => [ 'description' => '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' => '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', ], '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', ], 'ListServices' => [ 'summary' => 'List Resource Services', 'path' => '/workspace/{workspace}/services', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'nextToken', 'in' => 'query', 'schema' => [ 'description' => 'Token for the next query, an empty value indicates the last page.', 'type' => 'string', 'required' => false, 'example' => '7-b81a-4bc9-bbfa-a50cc6988667', 'title' => '翻页的 token，从 NextToken 开始按字典序返回文件信息列表。第一次调用此接口时，设置为空。', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'description' => 'The maximum number of records to return in this request.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => '查询一页数量，最大500。', 'maximum' => '500', 'minimum' => '0', 'exclusiveMinimum' => false, ], ], [ 'name' => 'workspace', 'in' => 'path', 'schema' => [ 'description' => 'Workspace name', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'title' => '工作空间', ], ], [ 'name' => 'serviceType', 'in' => 'query', 'schema' => [ 'description' => 'Service type', 'type' => 'string', 'required' => false, 'example' => 'apm', 'enum' => [ 'TRACE', 'XTRACE', 'RUM', ], 'title' => '类型：TRACE（应用监控）/ RUM（用户体验监控）/ XTRACE（OT版）', ], ], [ 'name' => 'serviceName', 'in' => 'query', 'schema' => [ 'title' => '应用服务名称', 'type' => 'string', 'example' => 'app-demo', ], ], [ 'name' => 'resourceGroupId', 'in' => 'query', 'schema' => [ 'title' => '资源组id', 'type' => 'string', 'example' => 'rg-aekxxzuad5zzzz', ], ], [ 'name' => 'tags', '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', ], ], ], ], ], ], 'responses' => [ 200 => [ '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.', 'type' => 'array', 'items' => [ 'description' => 'Service information.', '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版）', ], 'serviceStatus' => [ 'description' => 'Service status, valid only when serviceType=RUM.', 'type' => 'string', 'example' => 'Running', 'title' => '应用体验监控的服务状态，running/stopped/created/suspend', ], 'displayName' => [ 'description' => 'Display name, valid only when serviceType=RUM.', 'type' => 'string', 'example' => 'test', 'title' => '别名', ], 'pid' => [ 'description' => 'Historical compatible ARMS application ID', 'type' => 'string', 'example' => 'kgcsf@192197e828d51aa', 'title' => '对应ARMS应用pid', ], 'description' => [ 'description' => 'Service description, valid only when serviceType=RUM.', 'type' => 'string', 'example' => 'workspace api monitor test', 'title' => '应用描述信息。', ], 'attributes' => [ 'description' => 'Extended information.', 'type' => 'string', 'example' => '{"language":"java"}', 'title' => '特征信息，key:value格式', ], 'workspace' => [ 'description' => 'Workspace.', 'type' => 'string', 'example' => 'default-cms-1192928460540589-cn-hangzhou', 'title' => '工作空间', ], 'resourceGroupId' => [ 'title' => '资源组id', 'type' => 'string', 'example' => 'rg-aekxxzuad5zzzz', ], ], 'title' => '应用服务', ], 'title' => '应用服务列表', ], ], ], ], ], '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', 'translator' => 'machine', ], 'CreatePrometheusVirtualInstance' => [ 'summary' => 'Create Prometheus Monitoring Instance', 'path' => '/virtual-instances', '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' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', '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', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'namespace', 'in' => 'query', 'schema' => [ 'title' => '可选云产品', 'description' => 'Optional cloud product', 'type' => 'string', 'required' => false, 'example' => 'ack-csi-fuse', ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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.', 'type' => 'array', 'items' => [ 'description' => 'Instance information.', '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', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"instances\\": [\\n {\\n \\"instanceId\\": \\"rw-b8cfbbe94194ac37fe83f3d2d16a\\",\\n \\"httpApiUrl\\": \\"http://xxxxxxxx\\",\\n \\"userId\\": \\"17073812345\\",\\n \\"regionId\\": \\"cn-shanghai-cloudspe\\",\\n \\"namespace\\": \\"arms-prom\\",\\n \\"createdAt\\": \\"1750315319946\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Get Prometheus Virtual Instance List', 'description' => 'Used for creating a site monitoring task', 'translator' => 'machine', ], 'GetAggTaskGroup' => [ 'summary' => 'Describes the 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' => 'Output parameter structure.', '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', ], ], ], ], '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', ], ], ], '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], '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' => '聚合任务组的源 Prometheus 实例 id', 'description' => 'The source Prometheus instance ID of the aggregation task group.', 'type' => 'string', 'required' => true, 'example' => 'pq4apob9jm', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '入参结构体', 'description' => 'Input parameter structure.', '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.', 'type' => 'array', 'items' => [ 'description' => 'Value of the resource tag.', 'type' => 'object', 'properties' => [ '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, ], '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', ], ], 'required' => false, ], ], [ 'name' => 'overrideIfExists', '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', ], ], ], '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', ], ], ], ], ], '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', 'translator' => 'machine', ], 'DeleteAggTaskGroup' => [ 'summary' => 'Delete 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 to which the aggregation task group belongs. The aggregation tasks read data from this instance.', 'type' => 'string', 'required' => true, 'example' => 'rw-pq4apob9jm', ], ], [ 'name' => 'groupId', 'in' => 'path', 'schema' => [ 'title' => '聚合任务组 id', 'description' => 'Aggregation task group ID.', 'type' => 'string', 'required' => true, 'example' => 'aggTaskGroup-xxx', ], ], ], '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', 'title' => 'Delete Aggregation Task Group', 'translator' => 'machine', ], 'UpdateAggTaskGroupStatus' => [ 'summary' => 'Update Aggregation Task Group Status', '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 to which the aggregation task group belongs. The aggregation tasks read data from this instance.', 'type' => 'string', 'required' => true, 'example' => 'rw-pq4apob9jm', ], ], [ 'name' => 'groupId', 'in' => 'path', 'schema' => [ 'title' => '聚合任务组 id', 'description' => 'Aggregation task group ID.', 'type' => 'string', 'required' => true, 'example' => 'aggTaskGroup-xxx', ], ], [ '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, ], ], ], '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', ], ], ], ], ], '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', 'translator' => 'machine', ], 'UpdateAggTaskGroup' => [ 'summary' => 'Apply Aggregation Task Group', 'path' => '/prometheus-instances/{instanceId}/agg-task-groups/{groupId}', '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 to which the aggregation task group belongs. The aggregation tasks read data from this instance.', 'type' => 'string', 'required' => true, 'example' => 'rw-pq4apob9jm', ], ], [ 'name' => 'groupId', 'in' => 'path', 'schema' => [ 'title' => '聚合任务组 id', 'description' => 'Aggregation task group ID.', 'type' => 'string', 'required' => true, 'example' => 'aggTaskGroup-xxxx', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '入参结构体', 'description' => 'Input parameter structure.', '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.', 'type' => 'array', 'items' => [ 'description' => 'Tags.', 'type' => 'object', 'properties' => [ '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, ], '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', ], ], 'required' => false, ], ], ], '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', ], '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', ], 'ListAggTaskGroups' => [ 'summary' => 'List Aggregation Task Groups', 'path' => '/prometheus-instances/{instanceId}/agg-task-groups', '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' => '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' => 'filterAggTaskGroupIds', '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"]', ], ], [ 'name' => 'filterAggTaskGroupNames', '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"]', ], ], [ 'name' => 'status', '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', ], ], ], [ 'name' => 'targetPrometheusId', 'in' => 'query', 'schema' => [ 'title' => '聚合任务组的目标 Prometheus 实例 id', 'description' => 'The target Prometheus instance ID for the aggregation task group.', 'type' => 'string', 'required' => false, 'example' => 'rw-pq4apob9jm', ], ], [ 'name' => 'tags', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '资源组标签'."\n" ."\n", 'description' => 'Resource group tags.', 'type' => 'array', 'items' => [ 'description' => 'Resource group tags.', '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', ], ], 'required' => false, ], 'required' => false, ], ], [ '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', ], ], [ 'name' => 'nextToken', 'in' => 'query', 'schema' => [ 'title' => '查询令牌', 'description' => 'Query token.', 'type' => 'string', 'required' => false, 'example' => '28036394xxx', 'maxLength' => 128, ], ], [ 'name' => 'query', 'in' => 'query', 'schema' => [ 'title' => '名称搜索，支持模糊匹配', 'description' => 'Name search, supports fuzzy matching.', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '出参结构体', 'description' => 'Output structure.', 'type' => 'object', 'properties' => [ 'aggTaskGroups' => [ 'title' => '聚合任务组列表', 'description' => 'List of aggregation task groups.', 'type' => 'array', 'items' => [ 'description' => 'Aggregation task.', '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', ], 'regionId' => [ 'title' => '地域 id'."\n" ."\n", 'description' => 'Region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', ], 'scheduleMode' => [ 'title' => '调度模式'."\n" ."\n", 'description' => 'Scheduling mode.', 'type' => 'string', 'example' => 'FixedRate', ], 'scheduleTimeExpr' => [ 'title' => '调度时间表达式'."\n" ."\n", 'description' => 'Scheduling time expression.', 'type' => 'string', 'example' => '@m', ], 'sourcePrometheusId' => [ 'title' => '聚合任务组的源 Prometheus 实例 id', 'description' => 'The source Prometheus instance ID of the aggregation task group.', 'type' => 'string', 'example' => 'rw-xxx', ], 'status' => [ 'title' => '聚合任务组状态'."\n" ."\n", 'description' => 'Status of the aggregation task group.', 'type' => 'string', 'example' => 'Running', ], 'targetPrometheusId' => [ 'title' => '聚合任务组的目标 Prometheus 实例 id', 'description' => 'The target Prometheus instance ID of the aggregation task group.', 'type' => 'string', 'example' => 'rw-xxx', ], 'toTime' => [ 'title' => '调度结束时间对应的秒级时间戳'."\n" ."\n", 'description' => 'The second-level timestamp corresponding to the end time of scheduling.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'updateTime' => [ 'title' => '聚合任务组的更新时间'."\n" ."\n", 'description' => 'Update time of the aggregation task group.', 'type' => 'string', 'example' => '1757409499000', ], ], ], ], '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', ], ], ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'prometheusInstanceId', 'in' => 'path', 'schema' => [ 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rw-abc123', ], ], ], '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' => '8FDE2569-626B-5176-9844-28877A*****', ], ], ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'prometheusViewId', 'in' => 'path', 'schema' => [ 'description' => 'Prometheus view ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rw-xxxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of response', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => 'ID of the request', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', ], ], ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREcmsCP2WWY', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'prometheusInstanceId', 'in' => 'path', 'schema' => [ 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'rw-abc123', ], ], [ 'name' => 'resourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'Resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2bhocin5e2na', ], ], [ 'name' => 'aliyunLang', 'in' => 'query', 'schema' => [ 'title' => '语言环境, 默认为中文 zh | en', 'description' => 'Language setting, default is Chinese zh | en', 'type' => 'string', 'required' => false, 'example' => 'zh', 'default' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', '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', ], ], ], ], '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', ], ], ], 'requestId' => [ 'title' => 'Id of the request', 'description' => 'Unique identifier for the request.', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', ], ], ], ], ], '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 \\"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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREcmsCP2WWY', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'prometheusViewId', 'in' => 'path', 'schema' => [ 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rw-xxxxxx', ], ], [ 'name' => 'resourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'Resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2bhocin5e2na', ], ], [ 'name' => 'aliyunLang', 'in' => 'query', 'schema' => [ 'title' => '语言环境, 默认为中文 zh | en', 'description' => 'Language environment, default is Chinese zh | en', 'type' => 'string', 'required' => false, 'example' => 'zh', 'default' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', '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', ], ], ], ], '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', ], ], ], ], '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', ], ], ], 'requestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusView\\": {\\n \\"authFreeReadPolicy\\": \\"{\\\\n \\\\\\"SourceIp\\\\\\": [\\\\n \\\\\\"192.168.1.0/24\\\\\\",\\\\n \\\\\\"172.168.2.22\\\\\\"\\\\n ],\\\\n \\\\\\"SourceVpc\\\\\\": [\\\\n \\\\\\"vpc-xx1\\\\\\",\\\\n \\\\\\"vpc-xx2\\\\\\"\\\\n ]\\\\n}\\",\\n \\"authToken\\": \\"eJxxxxxx\\",\\n \\"createTime\\": \\"2025-08-10T02:07:53Z\\",\\n \\"enableAuthFreeRead\\": true,\\n \\"enableAuthToken\\": true,\\n \\"httpApiInterUrl\\": \\"http://xxxxxxxx\\",\\n \\"httpApiIntraUrl\\": \\"http://xxxxxxxx\\",\\n \\"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', ], 'ListPrometheusDashboards' => [ 'summary' => 'Get Prometheus Instance Dashboard List', 'path' => '/prometheus-instances/{prometheusInstanceId}/dashboards', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'prometheusInstanceId', 'in' => 'path', 'allowEmptyValue' => false, 'schema' => [ 'title' => '实例id', 'description' => 'Instance ID', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'rw-abc123', ], ], [ 'name' => 'resourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'Resource Group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfm3gn5i6bigbi', ], ], [ 'name' => 'aliyunLang', 'in' => 'query', 'schema' => [ 'title' => '语言环境, 默认为中文 zh | en', 'description' => 'Language environment, default is Chinese zh | en', 'type' => 'string', 'required' => false, 'example' => 'zh', 'default' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'prometheusDashboards' => [ 'description' => 'List of Prometheus instance dashboards.', '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' => [ 'title' => '', 'description' => 'Dashboard name.', 'type' => 'string', 'example' => 'pod', ], 'title' => [ 'title' => '', 'description' => 'Dashboard title.', 'type' => 'string', 'example' => 'ceshi', ], 'url' => [ 'title' => '', 'description' => 'Dashboard URL address.', 'type' => 'string', 'example' => 'https://gnew.console.aliyun.com/d/xxx-17460385-807-7-6/cs-cost-application', ], 'tags' => [ 'description' => 'Tags.', 'type' => 'array', 'items' => [ 'description' => 'Tag values.', 'type' => 'string', 'example' => '[{\\"tagName\\":\\"key1\\",\\"tagDefinePrompt\\":\\"value1\\"}]', ], ], ], ], ], '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', ], ], ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'prometheusViewId', 'in' => 'path', 'schema' => [ 'description' => 'Prometheus view instance ID.', 'type' => 'string', 'required' => true, 'example' => 'rw-xxxxxxxx', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', '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.', '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, ], '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', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', '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', ], ], ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'prometheusInstanceId', 'in' => 'path', 'allowEmptyValue' => false, 'schema' => [ 'title' => 'prometheus实例ID', 'description' => 'Prometheus instance ID', 'type' => 'string', 'required' => true, 'example' => 'rw-xxxxxxx', ], ], [ '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, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', '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', ], ], ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'prometheusViewIds', 'in' => 'query', 'schema' => [ 'description' => 'List of Prometheus view instance IDs.', 'type' => 'string', 'required' => false, 'example' => 'view-xxx', ], ], [ 'name' => 'prometheusViewName', 'in' => 'query', 'schema' => [ 'description' => 'Prometheus view name.', 'type' => 'string', 'required' => false, 'example' => 'view1', ], ], [ 'name' => 'workspace', 'in' => 'query', 'schema' => [ 'description' => 'Workspace name', 'type' => 'string', 'required' => false, 'example' => 'workspace-test', ], ], [ 'name' => 'version', 'in' => 'query', 'schema' => [ 'title' => '实例版本：V1或V2', 'description' => 'Instance version: V1 or V2', 'type' => 'string', 'required' => false, 'example' => 'V2', 'enum' => [ 'V1', 'V2', ], ], ], [ 'name' => 'resourceType', 'in' => 'query', 'schema' => [ 'title' => '资源类型：PrometheusView', 'description' => 'Resource type.', 'type' => 'string', 'required' => false, 'example' => 'PROMETHEUSVIEW', ], ], [ 'name' => 'filterRegionIds', 'in' => 'query', 'schema' => [ 'description' => 'Filter by RegionID.', 'type' => 'string', 'required' => false, 'example' => 'cn-zhangjiakou,cn-beijing', 'title' => '指定筛选的regionId（目前仅支持单regioinId，暂不支持多值）。', ], ], [ 'name' => 'resourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'Resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfm3gn5i6bigbi', ], ], [ 'name' => 'tag', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'List of tags.', 'type' => 'array', 'items' => [ 'description' => 'List of tags.', 'type' => 'object', 'properties' => [ 'key' => [ 'description' => 'Tag key', 'type' => 'string', 'required' => false, 'example' => 'key1', ], 'value' => [ 'description' => 'Match value.', 'type' => 'string', 'required' => false, 'example' => 'value1', ], ], 'required' => false, ], 'required' => false, ], ], [ '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', ], ], [ 'name' => 'nextToken', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'title' => '查询令牌。', 'description' => 'Query token.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '44ANBjKZmQeKnaB1fXRq06w7sFYK3MUcCALMD9qQbmEiE', 'maxLength' => 128, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Response schema', '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.', 'type' => 'array', 'items' => [ 'description' => 'Prometheus view 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', ], ], ], ], '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', ], ], ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'prometheusInstanceIds', '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', ], ], [ 'name' => 'prometheusInstanceName', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'title' => '实例名称（支持部分匹配）', 'description' => 'Instance name (partial match supported)', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test', ], ], [ 'name' => 'workspace', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'title' => '实例归属的工作空间', 'type' => 'string', 'required' => false, 'docRequired' => false, ], ], [ 'name' => 'version', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'title' => '实例版本：V1或V2', 'description' => 'Instance version: V1 or V2', 'type' => 'string', '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' => [], ], ], [ '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', ], ], [ 'name' => 'resourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'Resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2bhocin5e2na', ], ], [ 'name' => 'tag', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'List of tags.', 'type' => 'array', 'items' => [ 'description' => 'Tag.', 'type' => 'object', 'properties' => [ 'key' => [ 'description' => 'Tag key', 'type' => 'string', 'required' => false, 'example' => 'testKey', ], 'value' => [ 'description' => 'Tag value.', 'type' => 'string', 'required' => false, 'example' => 'testValue', ], ], 'required' => false, ], 'required' => false, ], ], [ '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', ], ], [ 'name' => 'nextToken', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'title' => '查询令牌。', 'description' => 'Query token.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'xxxxxxxxxx', 'maxLength' => 128, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', '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.', 'type' => 'array', 'items' => [ 'description' => 'Prometheus 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', ], ], ], ], '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"maxResults\\": 10,\\n \\"nextToken\\": \\"xxxxxxxxxx\\",\\n \\"prometheusInstances\\": [\\n {\\n \\"accessType\\": \\"readWrite\\",\\n \\"createTime\\": \\"2025-08-10T02:07:53Z\\",\\n \\"instanceType\\": \\"remote-write\\",\\n \\"paymentType\\": \\"POSTPAY_GB\\",\\n \\"product\\": \\"arms\\",\\n \\"prometheusInstanceId\\": \\"rw-63549e054ff596a4149927961dff\\",\\n \\"prometheusInstanceName\\": \\"test-prom-name\\",\\n \\"regionId\\": \\"cn-nanjing\\",\\n \\"resourceType\\": \\"Prometheus\\",\\n \\"status\\": \\"Pending2Running\\",\\n \\"supportAuthTypes\\": [\\n \\"BasicAuth\\"\\n ],\\n \\"userId\\": \\"17073812345\\",\\n \\"version\\": \\"*\\",\\n \\"workspace\\": \\"default-cms-115214006-cn-hangzhou\\"\\n }\\n ],\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"totalCount\\": 66\\n}","type":"json"}]', 'title' => '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', ], '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' => '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.', 'type' => 'array', 'items' => [ 'description' => 'Tag values.', 'type' => 'object', 'properties' => [ 'key' => [ 'description' => 'Tag key.', 'type' => 'string', 'required' => false, 'example' => 'key1', ], 'value' => [ 'description' => 'Tag value.', 'type' => 'string', 'required' => false, 'example' => '110109200001214284', ], ], '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', ], ], ], 'required' => false, ], ], ], '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', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusInstanceId\\": \\"rw-abc123\\",\\n \\"requestId\\": \\"264C3E89-BE6E-5F82-A484-CE9C2196C7DC\\"\\n}","type":"json"}]', 'title' => 'Create Prometheus Instance', 'translator' => 'machine', ], 'CreatePrometheusView' => [ 'summary' => 'Create 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' => '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, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', '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*****', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'ListAlertActions' => [ 'summary' => 'Query Alert Actions', 'path' => '/alertActions', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ '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' => [ '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, ], ], [ 'name' => 'type', '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', ], ], ], [ 'name' => 'alertActionName', 'in' => 'query', 'schema' => [ 'description' => 'Name of the action integration.', 'type' => 'string', 'required' => false, 'example' => 'testName', ], ], [ 'name' => 'pageNumber', 'in' => 'query', 'schema' => [ 'description' => 'Page number. Default is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => [ 'description' => 'Page size. Default is 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', ], ], ], 'responses' => [ 200 => [ '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.', 'type' => 'array', 'items' => [ 'description' => 'List of alert action configurations.', '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', ], ], ], ], ], ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'workspace-test', ], ], [ 'name' => 'body', 'in' => 'body', 'allowEmptyValue' => false, 'schema' => [ 'description' => '', 'required' => false, '$ref' => '#/components/schemas/SubscriptionForModify', ], ], [ 'name' => 'subscriptionId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => '123123123123', ], ], ], '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', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', ], ], 403 => [ [ 'errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', ], ], [ [ 'errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', ], ], 500 => [ [ 'errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-******\\",\\n \\"subscriptionId\\": \\"123123123123\\"\\n}","type":"json"}]', 'title' => 'UpdateSubscription', ], 'CreateAlertWebhook' => [ 'summary' => '创建Webhook', 'path' => '/webhook', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', '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', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', ], 'alertWebhookId' => [ 'description' => '', 'type' => 'string', 'example' => 'test', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ResourceExist', 'errorMessage' => 'Resource already exist .', ], [ 'errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.', ], ], 500 => [ [ 'errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"alertWebhookId\\": \\"test\\"\\n}","type":"json"}]', 'title' => 'CreateAlertWebhook', ], 'DeleteAlertWebhooks' => [ 'summary' => '删除Webhook', 'path' => '/webhooks', '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' => 'webhookIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'required' => true, ], ], ], '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-***********', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.', ], ], 500 => [ [ 'errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E5B1D3D4-BB28-5996-8AD2-***********\\"\\n}","type":"json"}]', 'title' => 'DeleteAlertWebhooks', ], 'ListAlertWebhooks' => [ 'summary' => '查询Webhook', 'path' => '/webhooks', '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' => 'pageSize', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'default' => '100', ], ], [ 'name' => 'pageNumber', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ 'name' => 'webhookIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, ], 'required' => false, ], ], [ 'name' => 'name', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', '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', ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.', ], ], 500 => [ [ 'errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], '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', ], 'UpdateAlertWebhook' => [ 'summary' => '修改已存在的告警 Webhook 通知配置。', 'path' => '/webhook/{webhookId}', 'methods' => [ 'patch', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'webhookId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'body', 'in' => 'body', '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, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => '8A33DBEA-*****-*****-*****-*****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.', ], ], 404 => [ [ 'errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource %s is not found.', ], ], 500 => [ [ 'errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8A33DBEA-*****-*****-*****-*****\\"\\n}","type":"json"}]', 'title' => 'UpdateAlertWebhook', ], 'UpdateNotifyStrategy' => [ 'summary' => '修改已存在的告警通知策略', 'path' => '/notifyStrategies/{notifyStrategyId}', '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' => 'workspace', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'workspace-test', 'title' => '工作空间', ], ], [ 'name' => 'body', 'in' => 'body', 'allowEmptyValue' => false, 'schema' => [ 'description' => '', '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', ], ], ], '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*****', ], 'notifyStrategyId' => [ 'description' => '', 'type' => 'string', 'example' => '12312-31-23-123-1-23123', 'title' => '通知策略ID', ], ], ], ], ], '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.', ], ], [ [ 'errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', ], ], 500 => [ [ 'errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], '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', ], 'CreateTicket' => [ 'summary' => 'Create Ticket', 'path' => '/tickets', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation', ], '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' => 'accessTokenExpirationTime', 'in' => 'query', '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', 'required' => false, 'example' => '600', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Returned structure.', 'type' => 'object', 'properties' => [ 'ticket' => [ 'title' => 'Id of the request', 'description' => '免登录票据。', 'type' => 'string', 'example' => 'eyJ***************.eyJ******************.KUT****************', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ticket\\": \\"eyJ***************.eyJ******************.KUT****************\\"\\n}","type":"json"}]', 'title' => 'Create Login-free Ticket', 'translator' => 'machine', ], 'TagResources' => [ 'summary' => '打标签接口', 'path' => '/tags', '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' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'resourceType' => [ 'title' => '资源类型', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'Service', ], 'resourceId' => [ 'title' => '资源ID,最多 50个子项', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'required' => true, 'maxItems' => 50, 'minItems' => 1, ], 'tag' => [ 'title' => '对应新增标签列表，最多包含20个子项', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'required' => false, '$ref' => '#/components/schemas/Tag', ], 'required' => false, 'maxItems' => 20, ], ], 'required' => false, ], ], ], '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*********', ], ], ], ], ], '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.', ], ], 403 => [ [ 'errorCode' => 'NoPermission', 'errorMessage' => 'The operator is not permission for this operate', ], ], 500 => [ [ 'errorCode' => 'InvalidOperation.ConcurrentModification', 'errorMessage' => 'The resource is modified concurrently.', ], [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3B311FD9-A60B-55E0-A896-A0C73*********\\"\\n}","type":"json"}]', ], 'UntagResources' => [ 'summary' => '删标签接口', 'path' => '/tags', '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' => 'resourceType', 'in' => 'query', 'schema' => [ 'title' => '资源类型', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'Service', ], ], [ 'name' => 'resourceId', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '资源ID,最多 50个子项', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'required' => true, 'maxItems' => 50, 'minItems' => 1, ], ], [ 'name' => 'tagKey', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '对应标签键列表，最多包含20个子项', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'env', ], 'required' => false, ], ], [ 'name' => 'all', 'in' => 'query', 'schema' => [ 'title' => '是否全部删除，只针对tags为空时有效。取值范围： true false True False 默认是 false', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => '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*****', ], ], ], ], ], '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.', ], ], 403 => [ [ 'errorCode' => 'NoPermission', 'errorMessage' => 'The operator is not permission for this operate ', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', ], 'ListTagResources' => [ 'summary' => '查标签接口', 'path' => '/tags', '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' => 'resourceType', 'in' => 'query', 'schema' => [ 'title' => '资源类型', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'Service', ], ], [ 'name' => 'resourceId', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '资源ID,最多 50个子项', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'required' => false, ], ], [ 'name' => 'tag', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '对应新增标签列表，最多包含20个子项', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'required' => false, '$ref' => '#/components/schemas/Tag', ], 'required' => false, ], ], [ 'name' => 'nextToken', 'in' => 'query', 'schema' => [ 'title' => '下一个查询开始Token', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'xxxxxxxxxx', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => '请求id', 'description' => '', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-***', ], 'maxResults' => [ 'title' => '列表最大数量', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'nextToken' => [ 'title' => '下一个查询开始Token', 'description' => '', 'type' => 'string', 'example' => 'xxxxxxxxxx', ], 'tagResources' => [ 'title' => '资源列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'tagKey' => [ 'title' => '标签键', 'description' => '', 'type' => 'string', 'example' => 'env', ], 'tagValue' => [ 'title' => '标签值', 'description' => '', 'type' => 'string', 'example' => 'test', ], 'resourceId' => [ 'title' => '资源ID', 'description' => '', 'type' => 'string', 'example' => 'test', ], 'resourceType' => [ 'title' => '资源类型', 'description' => '', 'type' => 'string', 'example' => 'Service', ], ], ], ], ], ], ], ], '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.', ], ], 403 => [ [ 'errorCode' => 'NoPermission', 'errorMessage' => 'The operator is not permission for this operate', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'resourceType' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'Service', ], 'resourceId' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'resourceGroupId' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'rg-ae******ey', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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*****', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', ], 'DescribeRegions' => [ 'summary' => '查询地域信息列表', 'path' => '/regions', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'language', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'ja' => 'ja', 'en' => 'en', 'zh' => 'zh', ], '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' => '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)', ], ], ], ], ], ], ], ], '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', ], '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' => 'product', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'title' => '空：云产品开通prometheus场景使用。'."\n" .'prometheus：开通prometheuse服务（按上报量或写入量计费）'."\n" .'sls：开通sls日志服务', 'description' => '', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'prometheus' => 'prometheus', ], 'example' => 'prometheus', 'enum' => [ 'prometheus', ], ], ], [ 'name' => 'service', 'in' => 'query', 'allowEmptyValue' => true, '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', ], ], ], ], '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', ], ], ], ], ], 'errorCodes' => [], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"enabled\\": false,\\n \\"errorCode\\": \\"PROM_NOT_OPEN\\"\\n}","type":"json"}]', ], 'CreateBizTrace' => [ 'summary' => '创建业务链路', 'path' => '/bizTrace', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'workspace' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'default-cms-xxxxxxx-cn-hangzhou', ], 'bizTraceCode' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'label_env', ], 'bizTraceName' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'just test', ], 'ruleConfig' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '[{"entrancePid":"xxx@d9w3jd9j3","rpcMatcher":{"matchType":"EQUALS","pattern":"/"},"characteristics":{"operation":"OR","rules":[{"target":"CUSTOM_EXTRACT","id":"oi0b3bb7","key":"biz.test","matcher":{"matchType":"CONTAINS","pattern":["1"]}}]}}]'."\n", ], 'advancedConfig' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '{"sample":{"strategy":"BY_APP"}}', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', ], 'bizTraceId' => [ 'description' => '', 'type' => 'string', 'example' => 'e339260ed64c95d', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'default-cms-1654218965343050-cn-hangzhou', ], ], [ 'name' => 'type', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'rum' => '', 'apm' => '', ], 'example' => 'apm', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', ], 'DeleteBizTrace' => [ 'summary' => '删除业务链路', 'path' => '/bizTrace/{bizTraceId}', 'methods' => [ 'delete', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'bizTraceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'e339260ed64c95d', ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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*****', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', ], 'GetAddon' => [ 'summary' => '插件详情(Addon)', 'path' => '/addons/{addonName}', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'addonName', 'in' => 'path', 'schema' => [ 'title' => '查询参数', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'security-actiontrail', ], ], [ 'name' => 'version', 'in' => 'query', 'schema' => [ 'title' => 'Addon版本号', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '*', ], ], [ 'name' => 'aliyunLang', 'in' => 'query', 'schema' => [ 'title' => '语言环境,默认为中文 zh | en', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'data' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'alias' => [ 'description' => '', 'type' => 'string', 'example' => 'resume_vector_alias', ], 'categories' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'example' => '[{\'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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"alias\\": \\"resume_vector_alias\\",\\n \\"categories\\": [\\n \\"alibaba-cloud-service\\"\\n ],\\n \\"dashboards\\": [\\n {\\n \\"description\\": \\"test\\",\\n \\"name\\": \\"rum_api_dot_metric_set\\",\\n \\"url\\": \\"http://iac-service-transfer.oss-cn-hangzhou.aliyuncs.com/78c5_288850010070719968_bdcf7cca781844c8ac4add133791713f\\"\\n }\\n ],\\n \\"description\\": \\"o11y-demo-cn-heyuan\\",\\n \\"environments\\": [\\n {\\n \\"enable\\": false,\\n \\"label\\": \\"容器环境\\",\\n \\"dependencies\\": {\\n \\"clusterTypes\\": [\\n \\"ManagedKubernetes/Default\\"\\n ],\\n \\"features\\": {\\n \\"key\\": true\\n },\\n \\"services\\": [\\n \\"Prometheus\\"\\n ]\\n },\\n \\"description\\": \\"Observability integration.\\",\\n \\"name\\": \\"cs-default-umodel-1752755202744_k8s.metric.high_level_metric_deployment_cn-hangzhou/c0a686118449c4390b9cc0a07ea3e0e85\\",\\n \\"policies\\": {\\n \\"alertDefaultStatus\\": \\"true\\",\\n \\"defaultInstall\\": true,\\n \\"enableServiceAccount\\": true,\\n \\"metricCheckRule\\": {\\n \\"promQL\\": [\\n \\"up=1\\"\\n ]\\n },\\n \\"needRestartAfterIntegration\\": true,\\n \\"protocols\\": [\\n {\\n \\"description\\": \\"Support OpenTelemetry Protocol\\",\\n \\"icon\\": \\"icon URL\\",\\n \\"label\\": \\"OpenTelemetry\\",\\n \\"name\\": \\"OpenTelemetry\\"\\n }\\n ],\\n \\"targetAddonName\\": \\"cs-default\\"\\n },\\n \\"policyType\\": \\"CS\\",\\n \\"commonSchemaRefs\\": [\\n {\\n \\"group\\": \\"acs-ecs\\",\\n \\"version\\": \\"0.1.3\\"\\n }\\n ]\\n }\\n ],\\n \\"icon\\": \\"https://xxxxx\\",\\n \\"keywords\\": [\\n \\"metrics\\"\\n ],\\n \\"language\\": \\"zh\\",\\n \\"latestReleaseCreateTime\\": \\"2023-09-12 12:30:30\\",\\n \\"name\\": \\"rum_api_dashboard_explorer_link_metric_set\\",\\n \\"once\\": true,\\n \\"scene\\": \\"middleware\\",\\n \\"version\\": \\"*\\",\\n \\"weight\\": \\"10\\"\\n },\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8\\"\\n}","type":"json"}]', 'title' => 'GetAddon', ], 'GetAddonCodeTemplate' => [ 'summary' => '插件schema详情(Addon)', 'path' => '/addons/{addonName}/alert-code-template', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'addonName', 'in' => 'path', 'schema' => [ 'title' => 'Addon的名称信息', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'apm-opentelemetry', ], ], [ '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, 'example' => 'Client', ], ], [ 'name' => 'version', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '0.1.0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of 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-***', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'addonName', 'in' => 'path', 'schema' => [ 'title' => 'Addon的名称信息', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'cloud-rds-audit-log', ], ], [ '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' => 'version', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '0.1.1', ], ], ], 'responses' => [ 200 => [ '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', ], 'validation' => [ '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', ], ], ], ], ], ], 'requestId' => [ 'description' => '', 'type' => 'string', 'example' => 'E5B1D3D4-BB28-5996-8AD2-***********', ], 'type' => [ 'description' => '', 'type' => 'string', 'example' => 'response_time', ], ], ], ], ], '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', ], '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' => 'bizTraceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'e339260ed64c95d', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****', ], 'item' => [ 'description' => '', '$ref' => '#/components/schemas/BizTraceConfig', ], ], ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'clusterId', 'in' => 'query', 'schema' => [ 'title' => '集群ID。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'c502646fd0d1249baaf792b3a1b589e1b', ], ], [ 'name' => 'clusterType', 'in' => 'query', 'schema' => [ 'title' => '集群类型。取值：acs.ack.cluster,acs.asi.cluster。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'acs.ack.cluster', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'integrationVersion' => [ 'title' => '接入中心版本。', 'description' => '', 'type' => 'string', 'example' => 'V1', ], 'requestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CD9BCF34-EA09-5643-BC11-AF41C8DFAE5A', ], ], ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ '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' => '语言环境, 默认为中文 zh | en', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'zh', 'default' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', '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', ], ], ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => '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' => 'search', 'in' => 'query', 'schema' => [ 'title' => 'addon名称', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '105095', ], ], [ 'name' => 'regexp', 'in' => 'query', 'schema' => [ 'title' => '查询字段, 是否正则匹配, 默认为false'."\n", 'description' => '', 'type' => 'boolean', 'required' => false, ], ], ], 'responses' => [ 200 => [ '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*****', ], ], ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', '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', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'nextToken', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'aa9d0e569b88098a0e3155c29b473201a', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', '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', ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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"}]', ], 'ListIntegrationPolicyAddons' => [ 'summary' => '策略addon列表', 'path' => '/integration-policies/{policyId}/addons', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'policyId', 'in' => 'path', 'schema' => [ 'title' => '环境id', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'policy-3563e6bf338141b3b92c118e2c318c37', ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'policyId', 'in' => 'path', 'schema' => [ 'title' => '接入中心策略ID。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'env-d95435164593aece55f9999ce45c', ], ], [ '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', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'collectors' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'collectorName' => [ 'description' => '', 'type' => 'string', 'example' => 'collector-kkxx', ], 'collectorType' => [ 'description' => '', 'type' => 'string', 'example' => 'Exporter', ], 'conditions' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'firstTransitionTime' => [ 'description' => '', 'type' => 'string', 'example' => '2024-08-27T13:59:23+08:00', ], 'lastTransitionTime' => [ 'description' => '', 'type' => 'string', 'example' => '2024-08-27T13:59:23+08:00', ], 'message' => [ 'description' => '', 'type' => 'string', 'example' => 'success', ], 'reason' => [ 'description' => '', 'type' => 'string', 'example' => 'Probe', ], 'status' => [ 'description' => '', 'type' => 'string', 'example' => 'True', ], 'type' => [ 'description' => '', 'type' => 'string', 'example' => 'Ready', ], ], ], ], 'managed' => [ 'description' => '', 'type' => 'boolean', 'example' => 'false', ], 'state' => [ 'description' => '', 'type' => 'string', 'example' => 'xx', ], 'version' => [ 'description' => '', 'type' => 'string', 'example' => '2.6.2', ], 'workloads' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'hostIp' => [ 'description' => '', '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'policyId', 'in' => 'path', 'schema' => [ 'title' => '接入中心策略ID。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e', ], ], [ 'name' => 'addonReleaseName', 'in' => 'query', 'schema' => [ 'title' => 'Addon Release名称。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'release-12345678', ], ], [ 'name' => 'namespace', 'in' => 'query', 'schema' => [ 'title' => '命名空间。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'arms-prom', ], ], [ 'name' => 'encryptYaml', 'in' => 'query', 'schema' => [ 'title' => '是否加密Yaml。', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], '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', ], ], ], ], ], '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', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'bizTraceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'e339260ed64c95d', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'bizTraceName' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'just test', ], 'workspace' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'default-cms-xxxxxxx-cn-hangzhou', ], 'ruleConfig' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '[{"entrancePid":"xxx@d9w3jd9j3","rpcMatcher":{"matchType":"EQUALS","pattern":"/"},"characteristics":{"operation":"OR","rules":[{"target":"CUSTOM_EXTRACT","id":"oi0b3bb7","key":"biz.test","matcher":{"matchType":"CONTAINS","pattern":["1"]}}]}}]', ], 'advancedConfig' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '{"sample":{"strategy":"BY_APP"}}', ], ], 'required' => false, ], ], ], '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', ], ], ], ], ], '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' => [], ], ], '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', ], ], [ '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*****', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', 'title' => 'UpdatePrometheusUserSetting', ], ], 'endpoints' => [ [ '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', ], [ 'regionId' => 'cn-shanghai-finance-1', 'endpoint' => 'metrics.cn-shanghai-finance-1.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen-finance-1', 'endpoint' => 'metrics.cn-shenzhen-finance-1.aliyuncs.com', ], [ 'regionId' => 'cn-beijing-finance-1', 'endpoint' => 'metrics.cn-beijing-finance-1.aliyuncs.com', ], [ 'regionId' => 'cn-heyuan-acdr-1', 'endpoint' => 'metrics.cn-heyuan-acdr-1.aliyuncs.com', ], [ 'regionId' => 'cn-north-2-gov-1', 'endpoint' => 'metrics.cn-north-2-gov-1.aliyuncs.com', ], ], ];