@alicloud/adb20211201 2.0.6 → 2.0.7

package/dist/client.d.ts

@@ -1345,6 +1345,15 @@ export declare class CreateDBClusterRequest extends $tea.Model {
      * 1880808684
      */
     backupSetId?: string;
+    /**
+     * @remarks
+     * The region ID of the source cluster.
+     *
+     * >  This parameter must be specified for cloning clusters across regions.
+     *
+     * @example
+     * cn-beijing
+     */
     cloneSourceRegionId?: string;
     /**
      * @remarks
@@ -2190,6 +2199,9 @@ export declare class CreateOssSubDirectoryResponse extends $tea.Model {
 }
 export declare class CreatePerformanceViewRequest extends $tea.Model {
     /**
+     * @remarks
+     * The type of the view.
+     *
      * @example
      * Basic
      */
@@ -2242,7 +2254,12 @@ export declare class CreatePerformanceViewRequest extends $tea.Model {
     viewDetail?: CreatePerformanceViewRequestViewDetail;
     /**
      * @remarks
+     * The name of the view.
+     *
      * This parameter is required.
+     *
+     * @example
+     * viewname
      */
     viewName?: string;
     static names(): {
@@ -2257,6 +2274,9 @@ export declare class CreatePerformanceViewRequest extends $tea.Model {
 }
 export declare class CreatePerformanceViewShrinkRequest extends $tea.Model {
     /**
+     * @remarks
+     * The type of the view.
+     *
      * @example
      * Basic
      */
@@ -2309,7 +2329,12 @@ export declare class CreatePerformanceViewShrinkRequest extends $tea.Model {
     viewDetailShrink?: string;
     /**
      * @remarks
+     * The name of the view.
+     *
      * This parameter is required.
+     *
+     * @example
+     * viewname
      */
     viewName?: string;
     static names(): {
@@ -2324,6 +2349,11 @@ export declare class CreatePerformanceViewShrinkRequest extends $tea.Model {
 }
 export declare class CreatePerformanceViewResponseBody extends $tea.Model {
     /**
+     * @remarks
+     * The details about the access denial.
+     *
+     * >  This parameter is returned only if Resource Access Management (RAM) permission verification failed.
+     *
      * @example
      * {
      *     "PolicyType": "AccountLevelIdentityBasedPolicy",
@@ -2348,6 +2378,9 @@ export declare class CreatePerformanceViewResponseBody extends $tea.Model {
      */
     createStatus?: string;
     /**
+     * @remarks
+     * The request ID.
+     *
      * @example
      * E031AABF-BD56-5966-A063-4283EF18DB45
      */
@@ -2802,7 +2835,12 @@ export declare class DeletePerformanceViewRequest extends $tea.Model {
     resourceOwnerId?: number;
     /**
      * @remarks
+     * The name of the view.
+     *
      * This parameter is required.
+     *
+     * @example
+     * view_dwd_plan_double_term
      */
     viewName?: string;
     static names(): {
@@ -2835,11 +2873,17 @@ export declare class DeletePerformanceViewResponseBody extends $tea.Model {
      */
     accessDeniedDetail?: string;
     /**
+     * @remarks
+     * The delete status.
+     *
      * @example
      * SUCCESS
      */
     deleteStatus?: boolean;
     /**
+     * @remarks
+     * The request ID.
+     *
      * @example
      * 1AD222E9-E606-4A42-BF6D-8A4442913CEF
      */
@@ -4077,7 +4121,7 @@ export declare class DescribeApsActionLogsRequest extends $tea.Model {
     DBClusterId?: string;
     /**
      * @remarks
-     * The end time of the logs to be queried. Specify the time in the ISO 8601 standard in the **yyyy-MM-ddTHH:mm:ssZ** format. The time must be in UTC.
+     * The end time of the logs to be queried. Specify the time in the ISO 8601 standard in the **yyyy-MM-ddTHH:mmZ** format. The time must be in UTC.
      *
      * >  The end time must be later than the start time. The maximum time range that can be specified is 30 days.
      *
@@ -4147,7 +4191,7 @@ export declare class DescribeApsActionLogsRequest extends $tea.Model {
     stage?: string;
     /**
      * @remarks
-     * The start time of the logs to be queried. Specify the time in the ISO 8601 standard in the **yyyy-MM-ddTHH:mm:ssZ** format. The time must be in UTC.
+     * The start time of the logs to be queried. Specify the time in the ISO 8601 standard in the **yyyy-MM-ddTHH:mmZ** format. The time must be in UTC.
      *
      * This parameter is required.
      *
@@ -4850,6 +4894,7 @@ export declare class DescribeBackupsRequest extends $tea.Model {
     });
 }
 export declare class DescribeBackupsResponseBody extends $tea.Model {
+    freeBackupSize?: number;
     /**
      * @remarks
      * The queried backup sets.
@@ -4879,6 +4924,7 @@ export declare class DescribeBackupsResponseBody extends $tea.Model {
      * CE17270B-F8F8-5A31-9DB4-DADDFDAD7940
      */
     requestId?: string;
+    totalBackupSize?: number;
     /**
      * @remarks
      * The total number of entries returned.
@@ -4916,7 +4962,7 @@ export declare class DescribeBackupsResponse extends $tea.Model {
 export declare class DescribeClusterAccessWhiteListRequest extends $tea.Model {
     /**
      * @remarks
-     * The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.
+     * The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.
      *
      * This parameter is required.
      *
@@ -7824,7 +7870,12 @@ export declare class DescribePerformanceViewAttributeRequest extends $tea.Model
     resourceOwnerId?: number;
     /**
      * @remarks
+     * The name of the view.
+     *
      * This parameter is required.
+     *
+     * @example
+     * Basic
      */
     viewName?: string;
     static names(): {
@@ -7839,6 +7890,11 @@ export declare class DescribePerformanceViewAttributeRequest extends $tea.Model
 }
 export declare class DescribePerformanceViewAttributeResponseBody extends $tea.Model {
     /**
+     * @remarks
+     * The details about the access denial.
+     *
+     * >  This parameter is returned only if Resource Access Management (RAM) permission verification failed.
+     *
      * @example
      * {
      *     "PolicyType": "AccountLevelIdentityBasedPolicy",
@@ -7852,26 +7908,54 @@ export declare class DescribePerformanceViewAttributeResponseBody extends $tea.M
      */
     accessDeniedDetail?: string;
     /**
+     * @remarks
+     * The type of the view.
+     *
      * @example
      * Basic
      */
     createFromViewType?: string;
     /**
+     * @remarks
+     * The cluster ID.
+     *
+     * >  You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/129857.html) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.
+     *
      * @example
      * amv-bp198m028ih55xxxx
      */
     DBClusterId?: string;
     /**
+     * @remarks
+     * Specifies whether to populate the names of the metrics in the original monitoring view when you view the monitoring view. Valid values:
+     *
+     * *   **true**
+     * *   **false**
+     *
      * @example
      * true
      */
     fillOriginViewKeys?: boolean;
     /**
+     * @remarks
+     * The request ID.
+     *
      * @example
      * E031AABF-BD56-5966-A063-4283EF18DB45
      */
     requestId?: string;
+    /**
+     * @remarks
+     * The information about the monitoring view.
+     */
     viewDetail?: DescribePerformanceViewAttributeResponseBodyViewDetail;
+    /**
+     * @remarks
+     * The name of the view.
+     *
+     * @example
+     * Basic
+     */
     viewName?: string;
     static names(): {
         [key: string]: string;
@@ -7940,6 +8024,11 @@ export declare class DescribePerformanceViewsRequest extends $tea.Model {
 }
 export declare class DescribePerformanceViewsResponseBody extends $tea.Model {
     /**
+     * @remarks
+     * The details about the access denial.
+     *
+     * >  This parameter is returned only if Resource Access Management (RAM) permission verification failed.
+     *
      * @example
      * {
      *     "PolicyType": "AccountLevelIdentityBasedPolicy",
@@ -7953,10 +8042,17 @@ export declare class DescribePerformanceViewsResponseBody extends $tea.Model {
      */
     accessDeniedDetail?: string;
     /**
+     * @remarks
+     * The request ID.
+     *
      * @example
      * 3A8F6106-6AFD-5A34-9C80-8DE2C42D06E8
      */
     requestId?: string;
+    /**
+     * @remarks
+     * the list of view.
+     */
     views?: DescribePerformanceViewsResponseBodyViews[];
     static names(): {
         [key: string]: string;
@@ -12719,8 +12815,6 @@ export declare class ModifyBackupPolicyRequest extends $tea.Model {
      *
      * >  To ensure data security, we recommend that you specify at least two values.
      *
-     * This parameter is required.
-     *
      * @example
      * Monday,Wednesday,Friday,Sunday
      */
@@ -13002,9 +13096,9 @@ export declare class ModifyDBClusterRequest extends $tea.Model {
     computeResource?: string;
     /**
      * @remarks
-     * The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.
+     * The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.
      *
-     * >  You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/454250.html) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters within a region.
+     * >  You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/454250.html) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region.
      *
      * This parameter is required.
      *
@@ -13041,6 +13135,10 @@ export declare class ModifyDBClusterRequest extends $tea.Model {
      */
     regionId?: string;
     reservedNodeCount?: number;
+    /**
+     * @example
+     * LegacyForm
+     */
     reservedNodeSize?: string;
     resourceOwnerAccount?: string;
     /**
@@ -13066,7 +13164,7 @@ export declare class ModifyDBClusterRequest extends $tea.Model {
 export declare class ModifyDBClusterResponseBody extends $tea.Model {
     /**
      * @remarks
-     * The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.
+     * The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.
      *
      * @example
      * amv-bp1r053byu48p****
@@ -13707,6 +13805,9 @@ export declare class ModifyPerformanceViewRequest extends $tea.Model {
      * The name of the monitoring view.
      *
      * This parameter is required.
+     *
+     * @example
+     * Basic
      */
     viewName?: string;
     static names(): {
@@ -13760,6 +13861,9 @@ export declare class ModifyPerformanceViewShrinkRequest extends $tea.Model {
      * The name of the monitoring view.
      *
      * This parameter is required.
+     *
+     * @example
+     * Basic
      */
     viewName?: string;
     static names(): {
@@ -15859,6 +15963,7 @@ export declare class DescribeBackupsResponseBodyItemsBackup extends $tea.Model {
      * 2022-06-02T16:00Z
      */
     backupEndTime?: string;
+    backupExpiredTime?: string;
     /**
      * @remarks
      * The backup set ID.
@@ -18861,11 +18966,17 @@ export declare class DescribeExcessivePrimaryKeysResponseBodyDetectionItems exte
     /**
      * @remarks
      * The detection result.
+     *
+     * @example
+     * OK
      */
     message?: string;
     /**
      * @remarks
      * The name of the detection item.
+     *
+     * @example
+     * test
      */
     name?: string;
     /**
@@ -18985,11 +19096,17 @@ export declare class DescribeJobResourceUsageResponseBodyDataJobAcuUsageAcuUsage
      */
     reservedAcuNumber?: number;
     /**
+     * @remarks
+     * The number of spot ACUs.
+     *
      * @example
      * 16ACU
      */
     spotAcuNumber?: number;
     /**
+     * @remarks
+     * The percent of spot ACUs.
+     *
      * @example
      * 0.9
      */
@@ -19191,11 +19308,20 @@ export declare class DescribePatternPerformanceResponseBodyPerformances extends
 }
 export declare class DescribePerformanceViewAttributeResponseBodyViewDetailCategoriesKeys extends $tea.Model {
     /**
+     * @remarks
+     * The name of the metric.
+     *
      * @example
      * AnalyticDB_CPU
      */
     keyName?: string;
     /**
+     * @remarks
+     * Specifies whether to select the metric. Valid values:
+     *
+     * *   **true**
+     * *   **false**
+     *
      * @example
      * true
      */
@@ -19212,10 +19338,22 @@ export declare class DescribePerformanceViewAttributeResponseBodyViewDetailCateg
 }
 export declare class DescribePerformanceViewAttributeResponseBodyViewDetailCategories extends $tea.Model {
     /**
+     * @remarks
+     * The name of the metric category. Valid values:
+     *
+     * *   **Node**
+     * *   **DiskData**
+     * *   **WorkLoad**
+     * *   **ResourceGroup**
+     *
      * @example
      * Node
      */
     category?: string;
+    /**
+     * @remarks
+     * The metrics.
+     */
     keys?: DescribePerformanceViewAttributeResponseBodyViewDetailCategoriesKeys[];
     static names(): {
         [key: string]: string;
@@ -19228,13 +19366,26 @@ export declare class DescribePerformanceViewAttributeResponseBodyViewDetailCateg
     });
 }
 export declare class DescribePerformanceViewAttributeResponseBodyViewDetail extends $tea.Model {
+    /**
+     * @remarks
+     * The metric category.
+     */
     categories?: DescribePerformanceViewAttributeResponseBodyViewDetailCategories[];
     /**
+     * @remarks
+     * Specifies whether to enable the filter interaction feature. Valid values:
+     *
+     * *   **true**
+     * *   **false**
+     *
      * @example
      * true
      */
     chartLinked?: boolean;
     /**
+     * @remarks
+     * The number of charts to display in each row.
+     *
      * @example
      * 2
      */
@@ -19251,15 +19402,28 @@ export declare class DescribePerformanceViewAttributeResponseBodyViewDetail exte
 }
 export declare class DescribePerformanceViewsResponseBodyViews extends $tea.Model {
     /**
+     * @remarks
+     * The time when created.
+     *
      * @example
      * 2024-06-18T07:06:53.000+00:00
      */
     createTime?: string;
     /**
+     * @remarks
+     * The time when updated.
+     *
      * @example
      * 2024-06-18T07:07:32.000+00:00
      */
     updateTime?: string;
+    /**
+     * @remarks
+     * The name of the view.
+     *
+     * @example
+     * Basic
+     */
     viewName?: string;
     static names(): {
         [key: string]: string;
@@ -21474,12 +21638,16 @@ export default class Client extends OpenApi {
      */
     createOssSubDirectory(request: CreateOssSubDirectoryRequest): Promise<CreateOssSubDirectoryResponse>;
     /**
+     * Creates a custom monitoring view.
+     *
      * @param tmpReq - CreatePerformanceViewRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns CreatePerformanceViewResponse
      */
     createPerformanceViewWithOptions(tmpReq: CreatePerformanceViewRequest, runtime: $Util.RuntimeOptions): Promise<CreatePerformanceViewResponse>;
     /**
+     * Creates a custom monitoring view.
+     *
      * @param request - CreatePerformanceViewRequest
      * @returns CreatePerformanceViewResponse
      */
@@ -21598,12 +21766,16 @@ export default class Client extends OpenApi {
      */
     deleteElasticPlan(request: DeleteElasticPlanRequest): Promise<DeleteElasticPlanResponse>;
     /**
+     * Deletes a monitoring view.
+     *
      * @param request - DeletePerformanceViewRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns DeletePerformanceViewResponse
      */
     deletePerformanceViewWithOptions(request: DeletePerformanceViewRequest, runtime: $Util.RuntimeOptions): Promise<DeletePerformanceViewResponse>;
     /**
+     * Deletes a monitoring view.
+     *
      * @param request - DeletePerformanceViewRequest
      * @returns DeletePerformanceViewResponse
      */
@@ -22470,23 +22642,31 @@ export default class Client extends OpenApi {
      */
     describePatternPerformance(request: DescribePatternPerformanceRequest): Promise<DescribePatternPerformanceResponse>;
     /**
+     * Queries the information about a monitoring view.
+     *
      * @param request - DescribePerformanceViewAttributeRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns DescribePerformanceViewAttributeResponse
      */
     describePerformanceViewAttributeWithOptions(request: DescribePerformanceViewAttributeRequest, runtime: $Util.RuntimeOptions): Promise<DescribePerformanceViewAttributeResponse>;
     /**
+     * Queries the information about a monitoring view.
+     *
      * @param request - DescribePerformanceViewAttributeRequest
      * @returns DescribePerformanceViewAttributeResponse
      */
     describePerformanceViewAttribute(request: DescribePerformanceViewAttributeRequest): Promise<DescribePerformanceViewAttributeResponse>;
     /**
+     * Queries a list of monitoring views.
+     *
      * @param request - DescribePerformanceViewsRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns DescribePerformanceViewsResponse
      */
     describePerformanceViewsWithOptions(request: DescribePerformanceViewsRequest, runtime: $Util.RuntimeOptions): Promise<DescribePerformanceViewsResponse>;
     /**
+     * Queries a list of monitoring views.
+     *
      * @param request - DescribePerformanceViewsRequest
      * @returns DescribePerformanceViewsResponse
      */
@@ -23633,7 +23813,7 @@ export default class Client extends OpenApi {
      * *   If the cluster has a built-in dataset loaded, make sure that the cluster has reserved storage resources of at least 24 AnalyticDB compute units (ACUs). Otherwise, the built-in dataset cannot be used.
      * *   When the scaling process is about to end, transient connections may occur. We recommend that you scale your cluster during off-peak hours or make sure that your application is configured to automatically reconnect to your cluster.
      * *   You can change an AnalyticDB for MySQL cluster from Data Warehouse Edition to Data Lakehouse Edition, but not the other way around. For more information, see Change a cluster from Data Warehouse Edition to Data Lakehouse Edition.
-     * *   For information about the endpoints of the current service, see [Endpoints](https://help.aliyun.com/document_detail/612373.html).
+     * *   For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](https://help.aliyun.com/document_detail/612373.html).
      *
      * @param request - ModifyDBClusterRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -23650,7 +23830,7 @@ export default class Client extends OpenApi {
      * *   If the cluster has a built-in dataset loaded, make sure that the cluster has reserved storage resources of at least 24 AnalyticDB compute units (ACUs). Otherwise, the built-in dataset cannot be used.
      * *   When the scaling process is about to end, transient connections may occur. We recommend that you scale your cluster during off-peak hours or make sure that your application is configured to automatically reconnect to your cluster.
      * *   You can change an AnalyticDB for MySQL cluster from Data Warehouse Edition to Data Lakehouse Edition, but not the other way around. For more information, see Change a cluster from Data Warehouse Edition to Data Lakehouse Edition.
-     * *   For information about the endpoints of the current service, see [Endpoints](https://help.aliyun.com/document_detail/612373.html).
+     * *   For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](https://help.aliyun.com/document_detail/612373.html).
      *
      * @param request - ModifyDBClusterRequest
      * @returns ModifyDBClusterResponse