@alicloud/cms20240330 10.0.0 → 10.0.1

package/dist/client.d.ts

@@ -87,7 +87,7 @@ export default class Client extends OpenApi {
      */
     createAddonRelease(policyId: string, request: $_model.CreateAddonReleaseRequest): Promise<$_model.CreateAddonReleaseResponse>;
     /**
-     * Creates an aggregation task group.
+     * Create an aggregation task group.
      *
      * @param request - CreateAggTaskGroupRequest
      * @param headers - map
@@ -98,7 +98,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.CreateAggTaskGroupResponse>;
     /**
-     * Creates an aggregation task group.
+     * Create an aggregation task group.
      *
      * @param request - CreateAggTaskGroupRequest
      * @returns CreateAggTaskGroupResponse
@@ -312,7 +312,7 @@ export default class Client extends OpenApi {
      */
     createPipeline(workspace: string, request: $_model.CreatePipelineRequest): Promise<$_model.CreatePipelineResponse>;
     /**
-     * Creates a Prometheus instance for monitoring.
+     * Creates a Managed Service for Prometheus instance.
      *
      * @param request - CreatePrometheusInstanceRequest
      * @param headers - map
@@ -323,7 +323,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.CreatePrometheusInstanceResponse>;
     /**
-     * Creates a Prometheus instance for monitoring.
+     * Creates a Managed Service for Prometheus instance.
      *
      * @param request - CreatePrometheusInstanceRequest
      * @returns CreatePrometheusInstanceResponse
@@ -333,7 +333,7 @@ export default class Client extends OpenApi {
      * Creates a Prometheus view.
      *
      * @remarks
-     * 用于创建一个站点监控任务
+     * Creates a site monitoring task.
      *
      * @param request - CreatePrometheusViewRequest
      * @param headers - map
@@ -347,7 +347,7 @@ export default class Client extends OpenApi {
      * Creates a Prometheus view.
      *
      * @remarks
-     * 用于创建一个站点监控任务
+     * Creates a site monitoring task.
      *
      * @param request - CreatePrometheusViewRequest
      * @returns CreatePrometheusViewResponse
@@ -927,10 +927,10 @@ export default class Client extends OpenApi {
      */
     deleteWorkspace(workspaceName: string, request: $_model.DeleteWorkspaceRequest): Promise<$_model.DeleteWorkspaceResponse>;
     /**
-     * Query metadata
+     * Queries metric metadata.
      *
      * @remarks
-     * Queries the details of CloudMonitor metric metadata.
+     * Queries the details of CloudMonitor monitoring metrics metadata.
      *
      * @param tmpReq - DescribeMetricMetaListRequest
      * @param headers - map
@@ -941,10 +941,10 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeMetricMetaListResponse>;
     /**
-     * Query metadata
+     * Queries metric metadata.
      *
      * @remarks
-     * Queries the details of CloudMonitor metric metadata.
+     * Queries the details of CloudMonitor monitoring metrics metadata.
      *
      * @param request - DescribeMetricMetaListRequest
      * @returns DescribeMetricMetaListResponse
@@ -1128,7 +1128,15 @@ export default class Client extends OpenApi {
      */
     getCloudResource(): Promise<$_model.GetCloudResourceResponse>;
     /**
-     * Queries data from the Cloud Resource Center.
+     * Queries all entity information of a specific cloud service within a specified time range.
+     *
+     * @remarks
+     * ## Operation description
+     * - This operation queries all entities of a specific cloud service within a specified time range.
+     * - The `from` and `to` parameters specify the time range of the query in seconds-level timestamps.
+     * - The `spl` parameter supports entityStore query statements to filter or select the required entities and their properties.
+     * - If you need only specific fields, use the `project` clause in `spl` to filter them.
+     * - The response contains the specific property values of each entity and the corresponding list of property names for easy parsing and processing.
      *
      * @param request - GetCloudResourceDataRequest
      * @param headers - map
@@ -1139,7 +1147,15 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetCloudResourceDataResponse>;
     /**
-     * Queries data from the Cloud Resource Center.
+     * Queries all entity information of a specific cloud service within a specified time range.
+     *
+     * @remarks
+     * ## Operation description
+     * - This operation queries all entities of a specific cloud service within a specified time range.
+     * - The `from` and `to` parameters specify the time range of the query in seconds-level timestamps.
+     * - The `spl` parameter supports entityStore query statements to filter or select the required entities and their properties.
+     * - If you need only specific fields, use the `project` clause in `spl` to filter them.
+     * - The response contains the specific property values of each entity and the corresponding list of property names for easy parsing and processing.
      *
      * @param request - GetCloudResourceDataRequest
      * @returns GetCloudResourceDataResponse
@@ -1224,7 +1240,10 @@ export default class Client extends OpenApi {
      */
     getDataset(workspace: string, datasetName: string, request: $_model.GetDatasetRequest): Promise<$_model.GetDatasetResponse>;
     /**
-     * View data delivery task details
+     * Retrieves the details of a data delivery task.
+     *
+     * @remarks
+     * Deletes a specified site monitoring task.
      *
      * @param request - GetDeliveryTaskRequest
      * @param headers - map
@@ -1235,7 +1254,10 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetDeliveryTaskResponse>;
     /**
-     * View data delivery task details
+     * Retrieves the details of a data delivery task.
+     *
+     * @remarks
+     * Deletes a specified site monitoring task.
      *
      * @param request - GetDeliveryTaskRequest
      * @returns GetDeliveryTaskResponse
@@ -1276,7 +1298,7 @@ export default class Client extends OpenApi {
      */
     getEntityStoreData(workspace: string, request: $_model.GetEntityStoreDataRequest): Promise<$_model.GetEntityStoreDataResponse>;
     /**
-     * Retrieves the details of an Integration Center policy.
+     * Query integration center policy information.
      *
      * @param request - GetIntegrationPolicyRequest
      * @param headers - map
@@ -1287,7 +1309,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetIntegrationPolicyResponse>;
     /**
-     * Retrieves the details of an Integration Center policy.
+     * Query integration center policy information.
      *
      * @param request - GetIntegrationPolicyRequest
      * @returns GetIntegrationPolicyResponse
@@ -1372,7 +1394,12 @@ export default class Client extends OpenApi {
      */
     getMemoryHistory(workspace: string, memoryStoreName: string, memoryId: string, request: $_model.GetMemoryHistoryRequest): Promise<$_model.GetMemoryHistoryResponse>;
     /**
-     * Query a memory store.
+     * Queries a memory store.
+     *
+     * @remarks
+     * Typically used together with the QueryMetricMeta operation for querying metrics and the QueryMetricList/QueryMetricLast operation for querying monitoring data.
+     * ## Request type
+     * POST|GET.
      *
      * @param request - GetMemoryStoreRequest
      * @param headers - map
@@ -1383,7 +1410,12 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetMemoryStoreResponse>;
     /**
-     * Query a memory store.
+     * Queries a memory store.
+     *
+     * @remarks
+     * Typically used together with the QueryMetricMeta operation for querying metrics and the QueryMetricList/QueryMetricLast operation for querying monitoring data.
+     * ## Request type
+     * POST|GET.
      *
      * @param request - GetMemoryStoreRequest
      * @returns GetMemoryStoreResponse
@@ -1408,10 +1440,10 @@ export default class Client extends OpenApi {
      */
     getPipeline(workspace: string, pipelineName: string, request: $_model.GetPipelineRequest): Promise<$_model.GetPipelineResponse>;
     /**
-     * Retrieves the details of a specific Prometheus instance.
+     * Queries the details of a specified Managed Service for Prometheus instance.
      *
      * @remarks
-     * Gets the details of a Prometheus instance.
+     * Retrieves the details of a Managed Service for Prometheus instance.
      *
      * @param request - GetPrometheusInstanceRequest
      * @param headers - map
@@ -1422,10 +1454,10 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetPrometheusInstanceResponse>;
     /**
-     * Retrieves the details of a specific Prometheus instance.
+     * Queries the details of a specified Managed Service for Prometheus instance.
      *
      * @remarks
-     * Gets the details of a Prometheus instance.
+     * Retrieves the details of a Managed Service for Prometheus instance.
      *
      * @param request - GetPrometheusInstanceRequest
      * @returns GetPrometheusInstanceResponse
@@ -1450,10 +1482,10 @@ export default class Client extends OpenApi {
      */
     getPrometheusUserSetting(request: $_model.GetPrometheusUserSettingRequest): Promise<$_model.GetPrometheusUserSettingResponse>;
     /**
-     * Retrieves the details of a specified Prometheus view instance.
+     * Queries the details of a specified Prometheus view instance.
      *
      * @remarks
-     * Retrieves the details of a specified Prometheus view instance.
+     * Queries a specified Prometheus view instance.
      *
      * @param request - GetPrometheusViewRequest
      * @param headers - map
@@ -1464,10 +1496,10 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetPrometheusViewResponse>;
     /**
-     * Retrieves the details of a specified Prometheus view instance.
+     * Queries the details of a specified Prometheus view instance.
      *
      * @remarks
-     * Retrieves the details of a specified Prometheus view instance.
+     * Queries a specified Prometheus view instance.
      *
      * @param request - GetPrometheusViewRequest
      * @returns GetPrometheusViewResponse
@@ -1642,7 +1674,7 @@ export default class Client extends OpenApi {
      */
     listAddons(request: $_model.ListAddonsRequest): Promise<$_model.ListAddonsResponse>;
     /**
-     * Queries a list of aggregation task groups.
+     * Queries the list of aggregation task groups.
      *
      * @param tmpReq - ListAggTaskGroupsRequest
      * @param headers - map
@@ -1653,7 +1685,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListAggTaskGroupsResponse>;
     /**
-     * Queries a list of aggregation task groups.
+     * Queries the list of aggregation task groups.
      *
      * @param request - ListAggTaskGroupsRequest
      * @returns ListAggTaskGroupsResponse
@@ -1678,7 +1710,7 @@ export default class Client extends OpenApi {
      */
     listAlertActions(request: $_model.ListAlertActionsRequest): Promise<$_model.ListAlertActionsResponse>;
     /**
-     * Queries a list of alert webhooks.
+     * Queries alert chatbots.
      *
      * @param tmpReq - ListAlertRobotsRequest
      * @param headers - map
@@ -1689,7 +1721,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListAlertRobotsResponse>;
     /**
-     * Queries a list of alert webhooks.
+     * Queries alert chatbots.
      *
      * @param request - ListAlertRobotsRequest
      * @returns ListAlertRobotsResponse
@@ -1840,10 +1872,10 @@ export default class Client extends OpenApi {
      */
     listDeliveryTasks(request: $_model.ListDeliveryTasksRequest): Promise<$_model.ListDeliveryTasksResponse>;
     /**
-     * Queries a list of policies in the Integration Center.
+     * Queries the list of access center policies.
      *
      * @remarks
-     * Queries a list of integrations.
+     * Queries the integration list.
      *
      * @param tmpReq - ListIntegrationPoliciesRequest
      * @param headers - map
@@ -1854,10 +1886,10 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListIntegrationPoliciesResponse>;
     /**
-     * Queries a list of policies in the Integration Center.
+     * Queries the list of access center policies.
      *
      * @remarks
-     * Queries a list of integrations.
+     * Queries the integration list.
      *
      * @param request - ListIntegrationPoliciesRequest
      * @returns ListIntegrationPoliciesResponse
@@ -2034,7 +2066,7 @@ export default class Client extends OpenApi {
      */
     listMemoryStores(workspace: string, request: $_model.ListMemoryStoresRequest): Promise<$_model.ListMemoryStoresResponse>;
     /**
-     * Queries a list of pipelines in a workspace.
+     * Lists pipelines.
      *
      * @param request - ListPipelinesRequest
      * @param headers - map
@@ -2045,7 +2077,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListPipelinesResponse>;
     /**
-     * Queries a list of pipelines in a workspace.
+     * Lists pipelines.
      *
      * @param request - ListPipelinesRequest
      * @returns ListPipelinesResponse
@@ -2076,10 +2108,10 @@ export default class Client extends OpenApi {
      */
     listPrometheusDashboards(prometheusInstanceId: string, request: $_model.ListPrometheusDashboardsRequest): Promise<$_model.ListPrometheusDashboardsResponse>;
     /**
-     * Lists Prometheus instances.
+     * Retrieves a list of Managed Service for Prometheus instances.
      *
      * @remarks
-     * Lists Prometheus instances.
+     * Retrieves a list of Managed Service for Prometheus instances.
      *
      * @param tmpReq - ListPrometheusInstancesRequest
      * @param headers - map
@@ -2090,20 +2122,20 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListPrometheusInstancesResponse>;
     /**
-     * Lists Prometheus instances.
+     * Retrieves a list of Managed Service for Prometheus instances.
      *
      * @remarks
-     * Lists Prometheus instances.
+     * Retrieves a list of Managed Service for Prometheus instances.
      *
      * @param request - ListPrometheusInstancesRequest
      * @returns ListPrometheusInstancesResponse
      */
     listPrometheusInstances(request: $_model.ListPrometheusInstancesRequest): Promise<$_model.ListPrometheusInstancesResponse>;
     /**
-     * Lists the Prometheus view instances.
+     * Queries the list of Prometheus view instances.
      *
      * @remarks
-     * Lists the Prometheus view instances.
+     * Queries the list of Prometheus view instances.
      *
      * @param tmpReq - ListPrometheusViewsRequest
      * @param headers - map
@@ -2114,10 +2146,10 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListPrometheusViewsResponse>;
     /**
-     * Lists the Prometheus view instances.
+     * Queries the list of Prometheus view instances.
      *
      * @remarks
-     * Lists the Prometheus view instances.
+     * Queries the list of Prometheus view instances.
      *
      * @param request - ListPrometheusViewsRequest
      * @returns ListPrometheusViewsResponse
@@ -2214,7 +2246,7 @@ export default class Client extends OpenApi {
      */
     manageAlertRules(request: $_model.ManageAlertRulesRequest): Promise<$_model.ManageAlertRulesResponse>;
     /**
-     * This operation enables monitoring services, including CloudMonitor Enterprise, Managed Service for Prometheus, and Log Service.
+     * Activates CloudMonitor services, including Hybrid Cloud Monitoring, Managed Service for Prometheus, and Simple Log Service (SLS).
      *
      * @param request - OpenCmsServiceRequest
      * @param headers - map
@@ -2225,7 +2257,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.OpenCmsServiceResponse>;
     /**
-     * This operation enables monitoring services, including CloudMonitor Enterprise, Managed Service for Prometheus, and Log Service.
+     * Activates CloudMonitor services, including Hybrid Cloud Monitoring, Managed Service for Prometheus, and Simple Log Service (SLS).
      *
      * @param request - OpenCmsServiceRequest
      * @returns OpenCmsServiceResponse
@@ -2250,10 +2282,10 @@ export default class Client extends OpenApi {
      */
     putWorkspace(workspaceName: string, request: $_model.PutWorkspaceRequest): Promise<$_model.PutWorkspaceResponse>;
     /**
-     * Retrieves a list of alert rules.
+     * Queries alert rules.
      *
      * @remarks
-     * This topic provides an example of how to retrieve a list of alert rules. In this example, a successful response returns two alert rules: `ECS_Template1` and `ECS_Template2`.
+     * This topic provides an example on how to query a list of alert templates. The response shows that the alert template list contains two alert templates: `ECS_Template1` and `ECS_Template2`.
      *
      * @param tmpReq - QueryAlertRulesRequest
      * @param headers - map
@@ -2264,10 +2296,10 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.QueryAlertRulesResponse>;
     /**
-     * Retrieves a list of alert rules.
+     * Queries alert rules.
      *
      * @remarks
-     * This topic provides an example of how to retrieve a list of alert rules. In this example, a successful response returns two alert rules: `ECS_Template1` and `ECS_Template2`.
+     * This topic provides an example on how to query a list of alert templates. The response shows that the alert template list contains two alert templates: `ECS_Template1` and `ECS_Template2`.
      *
      * @param request - QueryAlertRulesRequest
      * @returns QueryAlertRulesResponse
@@ -2292,7 +2324,11 @@ export default class Client extends OpenApi {
      */
     searchContext(workspace: string, contextStoreName: string, request: $_model.SearchContextRequest): Promise<$_model.SearchContextResponse>;
     /**
-     * Search memories using query conditions and filters.
+     * Searches for memories based on query conditions and filters.
+     *
+     * @remarks
+     * This topic provides an example on how to create a threshold alert rule for the cpu_total metric of the Elastic Computing Service `acs_ecs_dashboard` instance `i-uf6j91r34rnwawoo****`. The alert contact group of the alert rule is `ECS_Group`, the alert rule name is `test123`, the alert rule ID is `a151cd6023eacee2f0978e03863cc1697c89508****`, the statistical method for the Critical level is `Average`, the comparison operator for the Critical level is `GreaterThanOrEqualToThreshold`, the threshold for the Critical level is `90`, and the retry count for the Critical level is `3`.
+     * > 2024-08-15: Statistics validation is added. Only the Statistics value that corresponds to the metric can be specified. For information about how to obtain the value of this parameter, see [Cloud service monitoring metrics](https://www.alibabacloud.com/help/en/cms/support/appendix-1-metrics).
      *
      * @param request - SearchMemoriesRequest
      * @param headers - map
@@ -2303,7 +2339,11 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.SearchMemoriesResponse>;
     /**
-     * Search memories using query conditions and filters.
+     * Searches for memories based on query conditions and filters.
+     *
+     * @remarks
+     * This topic provides an example on how to create a threshold alert rule for the cpu_total metric of the Elastic Computing Service `acs_ecs_dashboard` instance `i-uf6j91r34rnwawoo****`. The alert contact group of the alert rule is `ECS_Group`, the alert rule name is `test123`, the alert rule ID is `a151cd6023eacee2f0978e03863cc1697c89508****`, the statistical method for the Critical level is `Average`, the comparison operator for the Critical level is `GreaterThanOrEqualToThreshold`, the threshold for the Critical level is `90`, and the retry count for the Critical level is `3`.
+     * > 2024-08-15: Statistics validation is added. Only the Statistics value that corresponds to the metric can be specified. For information about how to obtain the value of this parameter, see [Cloud service monitoring metrics](https://www.alibabacloud.com/help/en/cms/support/appendix-1-metrics).
      *
      * @param request - SearchMemoriesRequest
      * @returns SearchMemoriesResponse
@@ -2454,7 +2494,11 @@ export default class Client extends OpenApi {
      */
     updateContext(workspace: string, contextStoreName: string, contextId: string, request: $_model.UpdateContextRequest): Promise<$_model.UpdateContextResponse>;
     /**
-     * Updates the configuration of a context store.
+     * Modifies the configuration of a context store.
+     *
+     * @remarks
+     * Only Alibaba Cloud accounts that have activated Network Analysis and Monitoring can create one-time detection tasks.
+     * This topic provides an example of how to create a one-time detection task. The detection task is named `task1`, the detection address is `http://www.aliyun.com`, the detection type is `HTTP`, and the number of detection points is `1`.
      *
      * @param request - UpdateContextStoreRequest
      * @param headers - map
@@ -2465,7 +2509,11 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateContextStoreResponse>;
     /**
-     * Updates the configuration of a context store.
+     * Modifies the configuration of a context store.
+     *
+     * @remarks
+     * Only Alibaba Cloud accounts that have activated Network Analysis and Monitoring can create one-time detection tasks.
+     * This topic provides an example of how to create a one-time detection task. The detection task is named `task1`, the detection address is `http://www.aliyun.com`, the detection type is `HTTP`, and the number of detection points is `1`.
      *
      * @param request - UpdateContextStoreRequest
      * @returns UpdateContextStoreResponse
@@ -2490,7 +2538,10 @@ export default class Client extends OpenApi {
      */
     updateDataset(workspace: string, datasetName: string, request: $_model.UpdateDatasetRequest): Promise<$_model.UpdateDatasetResponse>;
     /**
-     * Updates a delivery task. This operation uses PATCH semantics, meaning unspecified fields in the request body remain unchanged.
+     * Updates a data delivery task. The update uses patch semantics: fields that are not specified remain unchanged.
+     *
+     * @remarks
+     * Deletes a specified site monitoring task.
      *
      * @param request - UpdateDeliveryTaskRequest
      * @param headers - map
@@ -2501,7 +2552,10 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateDeliveryTaskResponse>;
     /**
-     * Updates a delivery task. This operation uses PATCH semantics, meaning unspecified fields in the request body remain unchanged.
+     * Updates a data delivery task. The update uses patch semantics: fields that are not specified remain unchanged.
+     *
+     * @remarks
+     * Deletes a specified site monitoring task.
      *
      * @param request - UpdateDeliveryTaskRequest
      * @returns UpdateDeliveryTaskResponse
@@ -2598,10 +2652,10 @@ export default class Client extends OpenApi {
      */
     updatePipeline(workspace: string, pipelineName: string, request: $_model.UpdatePipelineRequest): Promise<$_model.UpdatePipelineResponse>;
     /**
-     * Updates the information of a Prometheus instance.
+     * Updates the information of a Managed Service for Prometheus instance.
      *
      * @remarks
-     * This topic describes how to update a Prometheus instance.
+     * Updates the information of a Managed Service for Prometheus instance.
      *
      * @param request - UpdatePrometheusInstanceRequest
      * @param headers - map
@@ -2612,10 +2666,10 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdatePrometheusInstanceResponse>;
     /**
-     * Updates the information of a Prometheus instance.
+     * Updates the information of a Managed Service for Prometheus instance.
      *
      * @remarks
-     * This topic describes how to update a Prometheus instance.
+     * Updates the information of a Managed Service for Prometheus instance.
      *
      * @param request - UpdatePrometheusInstanceRequest
      * @returns UpdatePrometheusInstanceResponse