@alicloud/polardb20170801 5.5.2 → 5.6.0

package/dist/client.d.ts

@@ -301,8 +301,9 @@ export declare class DescribeAccountsResponseBodyAccounts extends $dara.Model {
      * @remarks
      * The type of the account. Valid values:
      *
-     * *   **Normal**: a standard account
-     * *   **Super**: a privileged account
+     * *   **Normal**: standard account.
+     * *   **Super**: privileged account.
+     * *   **ReadOnly**: global read-only account.
      *
      * @example
      * Normal
@@ -1478,6 +1479,7 @@ export declare class DescribeDBClusterAttributeResponseBodyDBNodes extends $dara
      * Primary
      */
     subCluster?: string;
+    subGroupDescription?: string;
     /**
      * @remarks
      * Availability zone ID.
@@ -4636,6 +4638,118 @@ export declare class DescribeGlobalSecurityIPGroupRelationResponseBodyGlobalSecu
         [key: string]: any;
     });
 }
+export declare class DescribeHistoryTasksResponseBodyItems extends $dara.Model {
+    /**
+     * @example
+     * {}
+     */
+    actionInfo?: string;
+    /**
+     * @example
+     * User
+     */
+    callerSource?: string;
+    /**
+     * @example
+     * 1816563541899***
+     */
+    callerUid?: string;
+    /**
+     * @example
+     * finish_task
+     */
+    currentStepName?: string;
+    /**
+     * @example
+     * polardb_mysql
+     */
+    dbType?: string;
+    /**
+     * @example
+     * 2025-03-03T07:30:57Z
+     */
+    endTime?: string;
+    /**
+     * @example
+     * pc-2zed3m89cw***
+     */
+    instanceId?: string;
+    /**
+     * @example
+     * pc-2zed3m89cw***
+     */
+    instanceName?: string;
+    /**
+     * @example
+     * Instance
+     */
+    instanceType?: string;
+    /**
+     * @example
+     * polardb
+     */
+    product?: string;
+    /**
+     * @example
+     * 100.0
+     */
+    progress?: number;
+    /**
+     * @example
+     * ""
+     */
+    reasonCode?: string;
+    /**
+     * @example
+     * cn-beijing
+     */
+    regionId?: string;
+    /**
+     * @example
+     * 0
+     */
+    remainTime?: number;
+    /**
+     * @example
+     * 2025-03-03T07:25:16Z
+     */
+    startTime?: string;
+    /**
+     * @example
+     * Succeed
+     */
+    status?: string;
+    /**
+     * @example
+     * {\\"steps\\":[{\\"step_name\\":\\"init_task\\"},{\\"step_name\\":\\"exec_task\\"},{\\"step_name\\":\\"finish_task\\"}]}
+     */
+    taskDetail?: string;
+    /**
+     * @example
+     * t-0mqt8qhnw04ipz0***
+     */
+    taskId?: string;
+    /**
+     * @example
+     * ChangeVariable
+     */
+    taskType?: string;
+    /**
+     * @example
+     * 1816563541899***
+     */
+    uid?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class DescribeLicenseOrdersResponseBodyItems extends $dara.Model {
     /**
      * @remarks
@@ -8281,8 +8395,8 @@ export declare class CreateDBClusterEndpointRequest extends $dara.Model {
      * @remarks
      * Specifies whether to enable automatic association of newly added nodes with the cluster endpoint. Valid values:
      *
-     * *   **Enable**: enables automatic association of newly added nodes with the cluster endpoint.
-     * *   **Disable** (default): disables automatic association of newly added nodes with the cluster endpoint.
+     * *   **Enable**
+     * *   **Disable** (default)
      *
      * @example
      * Disable
@@ -8417,11 +8531,6 @@ export declare class CreateDBClusterEndpointRequest extends $dara.Model {
      * *   **ON**
      * *   **OFF**
      *
-     * Enumerated values:
-     *
-     * *   on
-     * *   off
-     *
      * @example
      * on
      */
@@ -10624,6 +10733,15 @@ export declare class DeleteMaskingRulesRequest extends $dara.Model {
      * pc-*****************
      */
     DBClusterId?: string;
+    /**
+     * @remarks
+     * Deletes data masking or encryption rules. Valid values:
+     *
+     * v1: deletes data masking rules. v2: deletes data encryption rules.
+     *
+     * @example
+     * v1
+     */
     interfaceVersion?: string;
     /**
      * @remarks
@@ -12539,6 +12657,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $dara.Model
      * X86
      */
     architecture?: string;
+    autoUpgradeMinorVersion?: string;
     /**
      * @remarks
      * Maximum number of blktags in the file system.
@@ -14781,7 +14900,7 @@ export declare class DescribeDBClustersRequest extends $dara.Model {
     ownerId?: number;
     /**
      * @remarks
-     * The page number. The value must be an integer that is greater than 0. Default value: **1**.
+     * The page number. The value must be a positive integer that does not exceed the maximum value of the INTEGER data type. Default value: **1**.
      *
      * @example
      * 10
@@ -16602,6 +16721,143 @@ export declare class DescribeGlobalSecurityIPGroupRelationResponse extends $dara
         [key: string]: any;
     });
 }
+export declare class DescribeHistoryTasksRequest extends $dara.Model {
+    /**
+     * @example
+     * 0
+     */
+    fromExecTime?: number;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * 2025-01-02T11:31:03Z
+     */
+    fromStartTime?: string;
+    /**
+     * @example
+     * pc-2zed3m89cw***
+     */
+    instanceId?: string;
+    /**
+     * @example
+     * Instance
+     */
+    instanceType?: string;
+    ownerId?: number;
+    /**
+     * @example
+     * 1
+     */
+    pageNumber?: number;
+    /**
+     * @example
+     * 10
+     */
+    pageSize?: number;
+    /**
+     * @example
+     * cn-beijing
+     */
+    regionId?: string;
+    /**
+     * @example
+     * rg-************
+     */
+    resourceGroupId?: string;
+    resourceOwnerAccount?: number;
+    resourceOwnerId?: number;
+    securityToken?: string;
+    /**
+     * @example
+     * Running
+     */
+    status?: string;
+    /**
+     * @example
+     * t-0mqi38ho0cgjv***
+     */
+    taskId?: string;
+    /**
+     * @example
+     * ChangeVariable
+     */
+    taskType?: string;
+    /**
+     * @example
+     * 0
+     */
+    toExecTime?: number;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * 2025-01-03T11:31:03Z
+     */
+    toStartTime?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class DescribeHistoryTasksResponseBody extends $dara.Model {
+    items?: DescribeHistoryTasksResponseBodyItems[];
+    /**
+     * @example
+     * 1
+     */
+    pageNumber?: number;
+    /**
+     * @example
+     * 10
+     */
+    pageSize?: number;
+    /**
+     * @example
+     * F90D7C14-2D1C-5B88-9CD1-23AB2CF89***
+     */
+    requestId?: string;
+    /**
+     * @example
+     * 2
+     */
+    totalCount?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class DescribeHistoryTasksResponse extends $dara.Model {
+    headers?: {
+        [key: string]: string;
+    };
+    statusCode?: number;
+    body?: DescribeHistoryTasksResponseBody;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class DescribeLicenseOrderDetailsRequest extends $dara.Model {
     /**
      * @remarks
@@ -20617,7 +20873,11 @@ export declare class ModifyDBClusterRequest extends $dara.Model {
      * @remarks
      * The fault injection method. Valid values:
      *
-     * *   CrashSQLInjection: `Crash SQL`-based fault injection.
+     * *   0: `Crash SQL`-based fault injection.
+     *
+     * Valid values:
+     *
+     * *   CrashSQLInjection: CrashSQLInjection.
      *
      * @example
      * 0
@@ -21040,21 +21300,42 @@ export declare class ModifyDBClusterAndNodesParametersResponse extends $dara.Mod
 }
 export declare class ModifyDBClusterArchRequest extends $dara.Model {
     /**
+     * @remarks
+     * The ID of the cluster.
+     *
      * @example
      * pc-****************
      */
     DBClusterId?: string;
     /**
+     * @remarks
+     * Specifies whether to enable the hot standby storage cluster feature. Valid values:
+     *
+     * *   **on**: enables hot standby storage cluster.
+     * *   **equal**: Enable a peer-to-peer cluster.
+     *
      * @example
      * on
      */
     hotStandbyCluster?: string;
     /**
+     * @remarks
+     * The region ID.
+     *
+     * >  You can call the [DescribeRegions](https://help.aliyun.com/document_detail/98041.html) operation to query information about regions.
+     *
      * @example
      * cn-beijing
      */
     regionId?: string;
     /**
+     * @remarks
+     * The zone of the hot standby storage cluster. Valid values:
+     *
+     * *   **auto** (default): The zone is automatically selected.
+     *
+     * >  You can use the default value when HotStandbyCluster is set to on. If HotStandbyCluster is set to equal, specify the zone of the hot standby storage cluster. You can call the [DescribeZones](https://help.aliyun.com/document_detail/98041.html) operation to query information about zones.
+     *
      * @example
      * cn-beijing-i
      */
@@ -21072,16 +21353,25 @@ export declare class ModifyDBClusterArchRequest extends $dara.Model {
 }
 export declare class ModifyDBClusterArchResponseBody extends $dara.Model {
     /**
+     * @remarks
+     * The cluster ID.
+     *
      * @example
      * pc-**************
      */
     DBClusterId?: string;
     /**
+     * @remarks
+     * The order ID.
+     *
      * @example
      * 2148126708*****
      */
     orderId?: string;
     /**
+     * @remarks
+     * The request ID.
+     *
      * @example
      * 6A2EE5B4-CC9F-46E1-A747-E43BC9******
      */
@@ -24151,19 +24441,22 @@ export declare class ModifyMaskingRulesRequest extends $dara.Model {
     interfaceVersion?: string;
     /**
      * @remarks
-     * The parameter that is used to specify the masking rule that you want to modify and the value in the JSON format. All parameter values are of the string type. Example: `{"auto": {"databases": ["db1"], "tables": ["tb1"], "columns": ["c1,c2"] }, "description": "This rule will be applied to the columns c1 and c2 in table t1", "enabled": true, "applies_to": ["user"]}`. Parameters in the function:
+     * The parameter that is used to specify the masking rule that you want to modify and the value in the JSON format. All parameter values are of the string type. Example: `{"auto": {"databases": ["db1"], "tables": ["tb1"], "columns": ["c1,c2"] }, "description": "This rule will be applied to the columns c1 and c2 in table t1", "enabled": true, "applies_to": ["user"]}`. Where,
      *
      * *   `"auto"`: specifies that the dynamic masking algorithm is supported. This parameter is required.
      * *   `"databases"`: Optional. The names of databases to which the masking rule is applied. Separate the names with commas (,). If you leave this parameter empty, the masking rule applies to all databases in the cluster.
      * *   `"tables"`: Optional. The names of tables to which the masking rule is applied. Separate the names with commas (,). If you leave this parameter empty, the rule applies to all tables in the cluster.
      * *   `"columns"`: Required. The names of fields to which the masking rule is applied. Separate the names with commas (,).
-     * *   `"description"`: Optional. The description of the masking rule. The description can be up to 64 characters in length.
-     * *   `"enabled"`: Required. Specifies whether to enable the masking rule. Valid values: **true** and **false**.
+     * *   `"description"`: Optional. The description of the masking rule. The description is up to 64 characters in length.
+     * *   `"enabled"`: Required. Specifies whether to enable the masking rule. Valid values: **true** (enable) and **false** (disable).
      * *   `"applies_to"`: The names of database accounts to which the masking rule is applied. Separate the names with commas (,).
      * *   `"exempted"`: The names of database accounts to which the masking rule is not applied. Separate the names with commas (,).
      *
-     * >- If you specify `RuleName`, `RuleConfig` parameter is required.
-     * >- You need to select either `"applies_to"` or `"exempted"`.
+     * >
+     *
+     * *   If you specify `RuleName`, `RuleConfig` parameter is required.
+     *
+     * *   You need to select either `"applies_to"` or `"exempted"`.
      *
      * @example
      * {"auto": {"databases": ["db1"], "tables": ["tb1"], "columns": ["c1,c2"] }, "description": "This rule will be applied to the columns c1 and c2 in table t1", "enabled": true, "applies_to": ["user"]}
@@ -24173,8 +24466,11 @@ export declare class ModifyMaskingRulesRequest extends $dara.Model {
      * @remarks
      * The name of the data masking rule. You can specify only one rule name at a time.
      *
-     * >- You can call the [DescribeMaskingRules](https://help.aliyun.com/document_detail/212573.html) operation to query the details of all masking rules for a specified cluster, such as the names of the masking rules.
-     * >- If the rule name does not exist in the cluster, the system automatically creates a masking rule based on the name and the value of `RuleConfig`.
+     * >
+     *
+     * *   You can call the [DescribeMaskingRules](https://help.aliyun.com/document_detail/212573.html) operation to query the details of all masking rules for a specified cluster, such as the names of the masking rules.
+     *
+     * *   If the rule name does not exist in the cluster, the system automatically creates a masking rule based on the name and the value of `RuleConfig`.
      *
      * @example
      * testrule
@@ -27217,6 +27513,21 @@ export default class Client extends OpenApi {
      * @returns DescribeGlobalSecurityIPGroupRelationResponse
      */
     describeGlobalSecurityIPGroupRelation(request: DescribeGlobalSecurityIPGroupRelationRequest): Promise<DescribeGlobalSecurityIPGroupRelationResponse>;
+    /**
+     * 任务中心任务列表
+     *
+     * @param request - DescribeHistoryTasksRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DescribeHistoryTasksResponse
+     */
+    describeHistoryTasksWithOptions(request: DescribeHistoryTasksRequest, runtime: $dara.RuntimeOptions): Promise<DescribeHistoryTasksResponse>;
+    /**
+     * 任务中心任务列表
+     *
+     * @param request - DescribeHistoryTasksRequest
+     * @returns DescribeHistoryTasksResponse
+     */
+    describeHistoryTasks(request: DescribeHistoryTasksRequest): Promise<DescribeHistoryTasksResponse>;
     /**
      * Queries the information of a license order.
      *
@@ -27786,7 +28097,7 @@ export default class Client extends OpenApi {
      */
     modifyDBClusterAndNodesParameters(request: ModifyDBClusterAndNodesParametersRequest): Promise<ModifyDBClusterAndNodesParametersResponse>;
     /**
-     * 变更standby模式
+     * Changes the high availability mode of the cluster.
      *
      * @param request - ModifyDBClusterArchRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -27794,7 +28105,7 @@ export default class Client extends OpenApi {
      */
     modifyDBClusterArchWithOptions(request: ModifyDBClusterArchRequest, runtime: $dara.RuntimeOptions): Promise<ModifyDBClusterArchResponse>;
     /**
-     * 变更standby模式
+     * Changes the high availability mode of the cluster.
      *
      * @param request - ModifyDBClusterArchRequest
      * @returns ModifyDBClusterArchResponse