@alicloud/appstream-center20210901 5.10.1 → 5.11.0

package/dist/client.d.ts

@@ -549,6 +549,27 @@ export default class Client extends OpenApi {
      * @returns DeliverToUserSlsResponse
      */
     deliverToUserSls(request: $_model.DeliverToUserSlsRequest): Promise<$_model.DeliverToUserSlsResponse>;
+    /**
+     * Queries the resource and session events of the current account within the last 30 days by using paging.
+     *
+     * @remarks
+     * Queries the resource and session events of the current account. `StartTime` and `EndTime` must be specified at the same time, and the time range includes the start and end times. The service only retrieves logs from 30 days before the call time to the current time, so events outside this window are not returned. If multiple filter parameters are specified at the same time, the intersection is used. Results are returned in descending order of the event log time. To use page number-based pagination, specify `PageSize` and `PageNumber`. The current version does not use `MaxResults` and `NextToken`.
+     *
+     * @param request - DescribeEventsRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DescribeEventsResponse
+     */
+    describeEventsWithOptions(request: $_model.DescribeEventsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeEventsResponse>;
+    /**
+     * Queries the resource and session events of the current account within the last 30 days by using paging.
+     *
+     * @remarks
+     * Queries the resource and session events of the current account. `StartTime` and `EndTime` must be specified at the same time, and the time range includes the start and end times. The service only retrieves logs from 30 days before the call time to the current time, so events outside this window are not returned. If multiple filter parameters are specified at the same time, the intersection is used. Results are returned in descending order of the event log time. To use page number-based pagination, specify `PageSize` and `PageNumber`. The current version does not use `MaxResults` and `NextToken`.
+     *
+     * @param request - DescribeEventsRequest
+     * @returns DescribeEventsResponse
+     */
+    describeEvents(request: $_model.DescribeEventsRequest): Promise<$_model.DescribeEventsResponse>;
     /**
      * Queries the details of a development host.
      *
@@ -1562,6 +1583,27 @@ export default class Client extends OpenApi {
      * @returns ListWuyingServerResponse
      */
     listWuyingServer(request: $_model.ListWuyingServerRequest): Promise<$_model.ListWuyingServerResponse>;
+    /**
+     * Queries the available Wuying Workstation workload templates for a specified virtual node pool.
+     *
+     * @remarks
+     * Queries the available workload templates for a specified virtual node pool. Before calling this operation, call [ListWuyingServer](~~ListWuyingServer~~) to obtain the VirtualNodePoolId under the current account. This operation verifies the ownership of the node pool and returns up to 100 records sorted by the template configuration order. The template content is Base64-encoded after being UTF-8 encoded. You must perform Base64 decoding before use. The current version does not use MaxResults and NextToken for pagination.
+     *
+     * @param request - ListWuyingServerWorkloadTemplateRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListWuyingServerWorkloadTemplateResponse
+     */
+    listWuyingServerWorkloadTemplateWithOptions(request: $_model.ListWuyingServerWorkloadTemplateRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListWuyingServerWorkloadTemplateResponse>;
+    /**
+     * Queries the available Wuying Workstation workload templates for a specified virtual node pool.
+     *
+     * @remarks
+     * Queries the available workload templates for a specified virtual node pool. Before calling this operation, call [ListWuyingServer](~~ListWuyingServer~~) to obtain the VirtualNodePoolId under the current account. This operation verifies the ownership of the node pool and returns up to 100 records sorted by the template configuration order. The template content is Base64-encoded after being UTF-8 encoded. You must perform Base64 decoding before use. The current version does not use MaxResults and NextToken for pagination.
+     *
+     * @param request - ListWuyingServerWorkloadTemplateRequest
+     * @returns ListWuyingServerWorkloadTemplateResponse
+     */
+    listWuyingServerWorkloadTemplate(request: $_model.ListWuyingServerWorkloadTemplateRequest): Promise<$_model.ListWuyingServerWorkloadTemplateResponse>;
     /**
      * Queries the list of available zone IDs for a specified region, product type, and operating system type.
      *
@@ -1722,7 +1764,7 @@ export default class Client extends OpenApi {
      */
     modifyNodePoolAttribute(request: $_model.ModifyNodePoolAttributeRequest): Promise<$_model.ModifyNodePoolAttributeResponse>;
     /**
-     * Shares an image with other WUYING users or cancels the sharing of a shared image.
+     * Shares an image with other WUYING users or unshares a shared image.
      *
      * @param request - ModifyShareImageRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1730,7 +1772,7 @@ export default class Client extends OpenApi {
      */
     modifyShareImageWithOptions(request: $_model.ModifyShareImageRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifyShareImageResponse>;
     /**
-     * Shares an image with other WUYING users or cancels the sharing of a shared image.
+     * Shares an image with other WUYING users or unshares a shared image.
      *
      * @param request - ModifyShareImageRequest
      * @returns ModifyShareImageResponse
@@ -1781,6 +1823,216 @@ export default class Client extends OpenApi {
      * @returns PageListAppInstanceGroupUserResponse
      */
     pageListAppInstanceGroupUser(request: $_model.PageListAppInstanceGroupUserRequest): Promise<$_model.PageListAppInstanceGroupUserResponse>;
+    /**
+     * Queries delivery group reports by region, delivery group, status, user authorization relationship, or statistical date.
+     *
+     * @remarks
+     * Queries the delivery group ID, name, and status in delivery group reports. You can call [ListRegions](~~ListRegions~~) to obtain the business region, and then call [ListAppInstanceGroup](~~ListAppInstanceGroup~~) to obtain the delivery group. `AppInstanceGroupId` matches the exact ID, and `AppInstanceGroupName` filters by inclusion. If multiple filter conditions are passed at the same time, the intersection is taken. When filtering by date, `StatDate` specifies a single day, and `StartDate` and `EndDate` must be passed in pairs to represent a closed interval. If both a single day and an interval are passed, the results must meet both conditions. Before using `EndUserId`, make sure that the user has a valid authorization relationship.
+     *
+     * @param request - QueryAppInstanceGroupReportListRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns QueryAppInstanceGroupReportListResponse
+     */
+    queryAppInstanceGroupReportListWithOptions(request: $_model.QueryAppInstanceGroupReportListRequest, runtime: $dara.RuntimeOptions): Promise<$_model.QueryAppInstanceGroupReportListResponse>;
+    /**
+     * Queries delivery group reports by region, delivery group, status, user authorization relationship, or statistical date.
+     *
+     * @remarks
+     * Queries the delivery group ID, name, and status in delivery group reports. You can call [ListRegions](~~ListRegions~~) to obtain the business region, and then call [ListAppInstanceGroup](~~ListAppInstanceGroup~~) to obtain the delivery group. `AppInstanceGroupId` matches the exact ID, and `AppInstanceGroupName` filters by inclusion. If multiple filter conditions are passed at the same time, the intersection is taken. When filtering by date, `StatDate` specifies a single day, and `StartDate` and `EndDate` must be passed in pairs to represent a closed interval. If both a single day and an interval are passed, the results must meet both conditions. Before using `EndUserId`, make sure that the user has a valid authorization relationship.
+     *
+     * @param request - QueryAppInstanceGroupReportListRequest
+     * @returns QueryAppInstanceGroupReportListResponse
+     */
+    queryAppInstanceGroupReportList(request: $_model.QueryAppInstanceGroupReportListRequest): Promise<$_model.QueryAppInstanceGroupReportListResponse>;
+    /**
+     * Queries the number of successful connections, the number of failed connections, the success rate, and the average connection duration within a specified time range.
+     *
+     * @remarks
+     * Queries connection statistical reports. Before you invoke this operation, you can invoke [ListRegions](~~ListRegions~~) and [ListAppInstanceGroup](~~ListAppInstanceGroup~~) to obtain the `BizRegionId` and `AppInstanceGroupId` parameters. `ProductType`, `StartDate`, and `EndDate` are required for server-side validation. The statistical interval is `[StartDate, EndDate)`, which includes the start time but excludes the end time. Results are returned by page, with a maximum of 1,500 entries per page.
+     *
+     * @param request - QueryConnectionReportRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns QueryConnectionReportResponse
+     */
+    queryConnectionReportWithOptions(request: $_model.QueryConnectionReportRequest, runtime: $dara.RuntimeOptions): Promise<$_model.QueryConnectionReportResponse>;
+    /**
+     * Queries the number of successful connections, the number of failed connections, the success rate, and the average connection duration within a specified time range.
+     *
+     * @remarks
+     * Queries connection statistical reports. Before you invoke this operation, you can invoke [ListRegions](~~ListRegions~~) and [ListAppInstanceGroup](~~ListAppInstanceGroup~~) to obtain the `BizRegionId` and `AppInstanceGroupId` parameters. `ProductType`, `StartDate`, and `EndDate` are required for server-side validation. The statistical interval is `[StartDate, EndDate)`, which includes the start time but excludes the end time. Results are returned by page, with a maximum of 1,500 entries per page.
+     *
+     * @param request - QueryConnectionReportRequest
+     * @returns QueryConnectionReportResponse
+     */
+    queryConnectionReport(request: $_model.QueryConnectionReportRequest): Promise<$_model.QueryConnectionReportResponse>;
+    /**
+     * Queries the number of daily active users and streaming daily active users by date.
+     *
+     * @remarks
+     * Queries the daily active user (DAU) report. StartDate and EndDate are required. The date range is inclusive and cannot exceed 180 days. If ProductType is not specified or is unrecognized, the query defaults to `CloudApp`. You can use BizRegionId and AppInstanceGroupId to narrow the scope. If neither is specified, the query returns aggregated data for all business regions. Results are paginated, with a maximum of 1,500 records per page.
+     *
+     * @param request - QueryDauReportDataRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns QueryDauReportDataResponse
+     */
+    queryDauReportDataWithOptions(request: $_model.QueryDauReportDataRequest, runtime: $dara.RuntimeOptions): Promise<$_model.QueryDauReportDataResponse>;
+    /**
+     * Queries the number of daily active users and streaming daily active users by date.
+     *
+     * @remarks
+     * Queries the daily active user (DAU) report. StartDate and EndDate are required. The date range is inclusive and cannot exceed 180 days. If ProductType is not specified or is unrecognized, the query defaults to `CloudApp`. You can use BizRegionId and AppInstanceGroupId to narrow the scope. If neither is specified, the query returns aggregated data for all business regions. Results are paginated, with a maximum of 1,500 records per page.
+     *
+     * @param request - QueryDauReportDataRequest
+     * @returns QueryDauReportDataResponse
+     */
+    queryDauReportData(request: $_model.QueryDauReportDataRequest): Promise<$_model.QueryDauReportDataResponse>;
+    /**
+     * Queries the number of monthly active users for each month within a specified time range.
+     *
+     * @remarks
+     * Queries the monthly active user (MAU) report. `ProductType`, `StartDate`, and `EndDate` are required for server-side validation, and the time span cannot exceed 60 months. The API returns statistical values by month. To adapt to offline data generated on the next day, the last month in the query range uses the day before `EndDate` as the statistical cutoff date. Results are returned in pages, with a maximum of 1,500 entries per page.
+     *
+     * @param request - QueryMauReportDataRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns QueryMauReportDataResponse
+     */
+    queryMauReportDataWithOptions(request: $_model.QueryMauReportDataRequest, runtime: $dara.RuntimeOptions): Promise<$_model.QueryMauReportDataResponse>;
+    /**
+     * Queries the number of monthly active users for each month within a specified time range.
+     *
+     * @remarks
+     * Queries the monthly active user (MAU) report. `ProductType`, `StartDate`, and `EndDate` are required for server-side validation, and the time span cannot exceed 60 months. The API returns statistical values by month. To adapt to offline data generated on the next day, the last month in the query range uses the day before `EndDate` as the statistical cutoff date. Results are returned in pages, with a maximum of 1,500 entries per page.
+     *
+     * @param request - QueryMauReportDataRequest
+     * @returns QueryMauReportDataResponse
+     */
+    queryMauReportData(request: $_model.QueryMauReportDataRequest): Promise<$_model.QueryMauReportDataResponse>;
+    /**
+     * Queries the network RTT and low-RTT user statistics within a specified time range.
+     *
+     * @remarks
+     * Queries network round-trip time (RTT) reports. `ProductType`, `StartDate`, and `EndDate` are required for server-side validation. The statistical interval is `[StartDate, EndDate)`. The minimum, maximum, and average RTT values are measured in milliseconds. The low-RTT threshold is determined by the report statistical caliber, and the current API operation does not return this threshold. Results are returned in pages, with a maximum of 1,500 entries per page.
+     *
+     * @param request - QueryNetworkRttReportRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns QueryNetworkRttReportResponse
+     */
+    queryNetworkRttReportWithOptions(request: $_model.QueryNetworkRttReportRequest, runtime: $dara.RuntimeOptions): Promise<$_model.QueryNetworkRttReportResponse>;
+    /**
+     * Queries the network RTT and low-RTT user statistics within a specified time range.
+     *
+     * @remarks
+     * Queries network round-trip time (RTT) reports. `ProductType`, `StartDate`, and `EndDate` are required for server-side validation. The statistical interval is `[StartDate, EndDate)`. The minimum, maximum, and average RTT values are measured in milliseconds. The low-RTT threshold is determined by the report statistical caliber, and the current API operation does not return this threshold. Results are returned in pages, with a maximum of 1,500 entries per page.
+     *
+     * @param request - QueryNetworkRttReportRequest
+     * @returns QueryNetworkRttReportResponse
+     */
+    queryNetworkRttReport(request: $_model.QueryNetworkRttReportRequest): Promise<$_model.QueryNetworkRttReportResponse>;
+    /**
+     * Queries the total number of nodes, the number of subscription nodes, and the number of pay-as-you-go nodes by statistical granularity.
+     *
+     * @remarks
+     * Queries the node quantity report. `StartDate`, `EndDate`, and `StatDateType` are required. The query span limit is determined by the statistical granularity: up to 1 day for `1m` and `30m`, up to 15 days for `6h`, and up to 180 days for `1d`. Both the start and end boundaries are included in the query range. Results are returned in pages, with a maximum of 1,500 entries per page.
+     *
+     * @param request - QueryNodeReportDataRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns QueryNodeReportDataResponse
+     */
+    queryNodeReportDataWithOptions(request: $_model.QueryNodeReportDataRequest, runtime: $dara.RuntimeOptions): Promise<$_model.QueryNodeReportDataResponse>;
+    /**
+     * Queries the total number of nodes, the number of subscription nodes, and the number of pay-as-you-go nodes by statistical granularity.
+     *
+     * @remarks
+     * Queries the node quantity report. `StartDate`, `EndDate`, and `StatDateType` are required. The query span limit is determined by the statistical granularity: up to 1 day for `1m` and `30m`, up to 15 days for `6h`, and up to 180 days for `1d`. Both the start and end boundaries are included in the query range. Results are returned in pages, with a maximum of 1,500 entries per page.
+     *
+     * @param request - QueryNodeReportDataRequest
+     * @returns QueryNodeReportDataResponse
+     */
+    queryNodeReportData(request: $_model.QueryNodeReportDataRequest): Promise<$_model.QueryNodeReportDataResponse>;
+    /**
+     * Queries the total number of sessions, connected sessions, and streaming sessions by statistical granularity.
+     *
+     * @remarks
+     * Queries session quantity reports. `StartDate`, `EndDate`, and `StatDateType` are required. The query span limit is determined by the statistical granularity: up to 1 day for `1m` and `30m`, up to 15 days for `6h`, and up to 180 days for `1d`. Both the start and end boundaries are included in the query range. Results are returned in pages, with a maximum of 1,500 records per page.
+     *
+     * @param request - QuerySessionReportDataRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns QuerySessionReportDataResponse
+     */
+    querySessionReportDataWithOptions(request: $_model.QuerySessionReportDataRequest, runtime: $dara.RuntimeOptions): Promise<$_model.QuerySessionReportDataResponse>;
+    /**
+     * Queries the total number of sessions, connected sessions, and streaming sessions by statistical granularity.
+     *
+     * @remarks
+     * Queries session quantity reports. `StartDate`, `EndDate`, and `StatDateType` are required. The query span limit is determined by the statistical granularity: up to 1 day for `1m` and `30m`, up to 15 days for `6h`, and up to 180 days for `1d`. Both the start and end boundaries are included in the query range. Results are returned in pages, with a maximum of 1,500 records per page.
+     *
+     * @param request - QuerySessionReportDataRequest
+     * @returns QuerySessionReportDataResponse
+     */
+    querySessionReportData(request: $_model.QuerySessionReportDataRequest): Promise<$_model.QuerySessionReportDataResponse>;
+    /**
+     * Queries the cumulative duration of application usage by a specified user on an hourly basis and returns the top five applications for each hour.
+     *
+     * @remarks
+     * Queries the application usage of a specified user on an hourly basis. StartDate and EndDate use the yyyyMMdd format. If either parameter is not provided, it defaults to yesterday. Both dates must be within the last 90 days, and the start date cannot be later than the end date. The query range includes the start and end dates. UserId must be set to the ID of the user to be queried. A maximum of the top five applications by usage duration are returned for each hour.
+     *
+     * @param request - QueryUserAppUsageAggregateByHourRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns QueryUserAppUsageAggregateByHourResponse
+     */
+    queryUserAppUsageAggregateByHourWithOptions(request: $_model.QueryUserAppUsageAggregateByHourRequest, runtime: $dara.RuntimeOptions): Promise<$_model.QueryUserAppUsageAggregateByHourResponse>;
+    /**
+     * Queries the cumulative duration of application usage by a specified user on an hourly basis and returns the top five applications for each hour.
+     *
+     * @remarks
+     * Queries the application usage of a specified user on an hourly basis. StartDate and EndDate use the yyyyMMdd format. If either parameter is not provided, it defaults to yesterday. Both dates must be within the last 90 days, and the start date cannot be later than the end date. The query range includes the start and end dates. UserId must be set to the ID of the user to be queried. A maximum of the top five applications by usage duration are returned for each hour.
+     *
+     * @param request - QueryUserAppUsageAggregateByHourRequest
+     * @returns QueryUserAppUsageAggregateByHourResponse
+     */
+    queryUserAppUsageAggregateByHour(request: $_model.QueryUserAppUsageAggregateByHourRequest): Promise<$_model.QueryUserAppUsageAggregateByHourResponse>;
+    /**
+     * Queries the ranking of cumulative application usage duration for a specified user within a date range.
+     *
+     * @remarks
+     * Queries the ranking of application usage duration for a specified user within a statistical range. StartDate and EndDate use the yyyyMMdd format. If either parameter is not provided, it defaults to yesterday. Both dates must be within the last 90 days, and the start date cannot be later than the end date. The query range includes the start and end dates. UserId must be set to the ID of the user to be queried. The results are sorted in descending order of cumulative application usage duration.
+     *
+     * @param request - QueryUserAppUsageTimeRankRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns QueryUserAppUsageTimeRankResponse
+     */
+    queryUserAppUsageTimeRankWithOptions(request: $_model.QueryUserAppUsageTimeRankRequest, runtime: $dara.RuntimeOptions): Promise<$_model.QueryUserAppUsageTimeRankResponse>;
+    /**
+     * Queries the ranking of cumulative application usage duration for a specified user within a date range.
+     *
+     * @remarks
+     * Queries the ranking of application usage duration for a specified user within a statistical range. StartDate and EndDate use the yyyyMMdd format. If either parameter is not provided, it defaults to yesterday. Both dates must be within the last 90 days, and the start date cannot be later than the end date. The query range includes the start and end dates. UserId must be set to the ID of the user to be queried. The results are sorted in descending order of cumulative application usage duration.
+     *
+     * @param request - QueryUserAppUsageTimeRankRequest
+     * @returns QueryUserAppUsageTimeRankResponse
+     */
+    queryUserAppUsageTimeRank(request: $_model.QueryUserAppUsageTimeRankRequest): Promise<$_model.QueryUserAppUsageTimeRankResponse>;
+    /**
+     * Queries the connection status, last connection time, cumulative usage duration, and session persistence duration of users.
+     *
+     * @remarks
+     * Queries user usage reports. ProductType, StartDate, and EndDate are required for server-side validation, and the time span cannot exceed 60 months. During the query, the start and end times are converted to the `yyyyMMdd` format and aggregated based on a closed interval of natural days. The results are paginated in descending order of cumulative usage duration, with a maximum of 1,500 records per page. You can combine ConnectionStatus, UserId, BizRegionId, and AppInstanceGroupId for filtering.
+     *
+     * @param request - QueryUserUsageReportRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns QueryUserUsageReportResponse
+     */
+    queryUserUsageReportWithOptions(request: $_model.QueryUserUsageReportRequest, runtime: $dara.RuntimeOptions): Promise<$_model.QueryUserUsageReportResponse>;
+    /**
+     * Queries the connection status, last connection time, cumulative usage duration, and session persistence duration of users.
+     *
+     * @remarks
+     * Queries user usage reports. ProductType, StartDate, and EndDate are required for server-side validation, and the time span cannot exceed 60 months. During the query, the start and end times are converted to the `yyyyMMdd` format and aggregated based on a closed interval of natural days. The results are paginated in descending order of cumulative usage duration, with a maximum of 1,500 records per page. You can combine ConnectionStatus, UserId, BizRegionId, and AppInstanceGroupId for filtering.
+     *
+     * @param request - QueryUserUsageReportRequest
+     * @returns QueryUserUsageReportResponse
+     */
+    queryUserUsageReport(request: $_model.QueryUserUsageReportRequest): Promise<$_model.QueryUserUsageReportResponse>;
     /**
      * Removes model groups from a resource group.
      *