@alicloud/polardb20170801 5.1.0 → 5.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/client.d.ts CHANGED
@@ -2697,6 +2697,9 @@ export declare class DescribeDBClusterServerlessConfResponseBody extends $tea.Mo
2697
2697
  scaleRoNumMax?: string;
2698
2698
  scaleRoNumMin?: string;
2699
2699
  secondsUntilAutoPause?: string;
2700
+ serverlessRuleCpuEnlargeThreshold?: string;
2701
+ serverlessRuleCpuShrinkThreshold?: string;
2702
+ serverlessRuleMode?: string;
2700
2703
  switchs?: string;
2701
2704
  static names(): {
2702
2705
  [key: string]: string;
@@ -2802,6 +2805,7 @@ export declare class DescribeDBClusterVersionResponseBody extends $tea.Model {
2802
2805
  isProxyLatestVersion?: string;
2803
2806
  proxyLatestVersion?: string;
2804
2807
  proxyRevisionVersion?: string;
2808
+ proxyRevisionVersionList?: DescribeDBClusterVersionResponseBodyProxyRevisionVersionList[];
2805
2809
  proxyVersionStatus?: string;
2806
2810
  requestId?: string;
2807
2811
  static names(): {
@@ -5653,6 +5657,9 @@ export declare class ModifyDBClusterServerlessConfRequest extends $tea.Model {
5653
5657
  scaleRoNumMax?: string;
5654
5658
  scaleRoNumMin?: string;
5655
5659
  secondsUntilAutoPause?: string;
5660
+ serverlessRuleCpuEnlargeThreshold?: string;
5661
+ serverlessRuleCpuShrinkThreshold?: string;
5662
+ serverlessRuleMode?: string;
5656
5663
  static names(): {
5657
5664
  [key: string]: string;
5658
5665
  };
@@ -7107,6 +7114,7 @@ export declare class UpgradeDBClusterVersionRequest extends $tea.Model {
7107
7114
  resourceOwnerAccount?: string;
7108
7115
  resourceOwnerId?: number;
7109
7116
  targetDBRevisionVersionCode?: string;
7117
+ targetProxyRevisionVersionCode?: string;
7110
7118
  upgradeLabel?: string;
7111
7119
  upgradePolicy?: string;
7112
7120
  upgradeType?: string;
@@ -7819,6 +7827,21 @@ export declare class DescribeDBClusterVersionResponseBodyDBRevisionVersionList e
7819
7827
  [key: string]: any;
7820
7828
  });
7821
7829
  }
7830
+ export declare class DescribeDBClusterVersionResponseBodyProxyRevisionVersionList extends $tea.Model {
7831
+ releaseNote?: string;
7832
+ releaseType?: string;
7833
+ revisionVersionCode?: string;
7834
+ revisionVersionName?: string;
7835
+ static names(): {
7836
+ [key: string]: string;
7837
+ };
7838
+ static types(): {
7839
+ [key: string]: any;
7840
+ };
7841
+ constructor(map?: {
7842
+ [key: string]: any;
7843
+ });
7844
+ }
7822
7845
  export declare class DescribeDBClustersRequestTag extends $tea.Model {
7823
7846
  key?: string;
7824
7847
  value?: string;
@@ -8877,881 +8900,2413 @@ export default class Client extends OpenApi {
8877
8900
  getEndpoint(productId: string, regionId: string, endpointRule: string, network: string, suffix: string, endpointMap: {
8878
8901
  [key: string]: string;
8879
8902
  }, endpoint: string): string;
8903
+ /**
8904
+ * @summary Cancels scheduled tasks that are not yet started.
8905
+ *
8906
+ * @param request CancelScheduleTasksRequest
8907
+ * @param runtime runtime options for this request RuntimeOptions
8908
+ * @return CancelScheduleTasksResponse
8909
+ */
8880
8910
  cancelScheduleTasksWithOptions(request: CancelScheduleTasksRequest, runtime: $Util.RuntimeOptions): Promise<CancelScheduleTasksResponse>;
8911
+ /**
8912
+ * @summary Cancels scheduled tasks that are not yet started.
8913
+ *
8914
+ * @param request CancelScheduleTasksRequest
8915
+ * @return CancelScheduleTasksResponse
8916
+ */
8881
8917
  cancelScheduleTasks(request: CancelScheduleTasksRequest): Promise<CancelScheduleTasksResponse>;
8918
+ /**
8919
+ * @summary Checks whether an account name is valid or unique in a cluster.
8920
+ *
8921
+ * @param request CheckAccountNameRequest
8922
+ * @param runtime runtime options for this request RuntimeOptions
8923
+ * @return CheckAccountNameResponse
8924
+ */
8882
8925
  checkAccountNameWithOptions(request: CheckAccountNameRequest, runtime: $Util.RuntimeOptions): Promise<CheckAccountNameResponse>;
8926
+ /**
8927
+ * @summary Checks whether an account name is valid or unique in a cluster.
8928
+ *
8929
+ * @param request CheckAccountNameRequest
8930
+ * @return CheckAccountNameResponse
8931
+ */
8883
8932
  checkAccountName(request: CheckAccountNameRequest): Promise<CheckAccountNameResponse>;
8933
+ /**
8934
+ * @summary Checks whether a database name is valid or whether the name is already used by another database in the current cluster.
8935
+ *
8936
+ * @param request CheckDBNameRequest
8937
+ * @param runtime runtime options for this request RuntimeOptions
8938
+ * @return CheckDBNameResponse
8939
+ */
8884
8940
  checkDBNameWithOptions(request: CheckDBNameRequest, runtime: $Util.RuntimeOptions): Promise<CheckDBNameResponse>;
8941
+ /**
8942
+ * @summary Checks whether a database name is valid or whether the name is already used by another database in the current cluster.
8943
+ *
8944
+ * @param request CheckDBNameRequest
8945
+ * @return CheckDBNameResponse
8946
+ */
8885
8947
  checkDBName(request: CheckDBNameRequest): Promise<CheckDBNameResponse>;
8948
+ /**
8949
+ * @summary Queries whether the cluster is authorized to use Key Management Service (KMS).
8950
+ *
8951
+ * @param request CheckKMSAuthorizedRequest
8952
+ * @param runtime runtime options for this request RuntimeOptions
8953
+ * @return CheckKMSAuthorizedResponse
8954
+ */
8886
8955
  checkKMSAuthorizedWithOptions(request: CheckKMSAuthorizedRequest, runtime: $Util.RuntimeOptions): Promise<CheckKMSAuthorizedResponse>;
8956
+ /**
8957
+ * @summary Queries whether the cluster is authorized to use Key Management Service (KMS).
8958
+ *
8959
+ * @param request CheckKMSAuthorizedRequest
8960
+ * @return CheckKMSAuthorizedResponse
8961
+ */
8887
8962
  checkKMSAuthorized(request: CheckKMSAuthorizedRequest): Promise<CheckKMSAuthorizedResponse>;
8963
+ /**
8964
+ * @summary Checks whether a service-linked role (SLR) is created.
8965
+ *
8966
+ * @param request CheckServiceLinkedRoleRequest
8967
+ * @param runtime runtime options for this request RuntimeOptions
8968
+ * @return CheckServiceLinkedRoleResponse
8969
+ */
8888
8970
  checkServiceLinkedRoleWithOptions(request: CheckServiceLinkedRoleRequest, runtime: $Util.RuntimeOptions): Promise<CheckServiceLinkedRoleResponse>;
8971
+ /**
8972
+ * @summary Checks whether a service-linked role (SLR) is created.
8973
+ *
8974
+ * @param request CheckServiceLinkedRoleRequest
8975
+ * @return CheckServiceLinkedRoleResponse
8976
+ */
8889
8977
  checkServiceLinkedRole(request: CheckServiceLinkedRoleRequest): Promise<CheckServiceLinkedRoleResponse>;
8978
+ /**
8979
+ * @summary 关闭DB4AI
8980
+ *
8981
+ * @param request CloseAITaskRequest
8982
+ * @param runtime runtime options for this request RuntimeOptions
8983
+ * @return CloseAITaskResponse
8984
+ */
8890
8985
  closeAITaskWithOptions(request: CloseAITaskRequest, runtime: $Util.RuntimeOptions): Promise<CloseAITaskResponse>;
8986
+ /**
8987
+ * @summary 关闭DB4AI
8988
+ *
8989
+ * @param request CloseAITaskRequest
8990
+ * @return CloseAITaskResponse
8991
+ */
8891
8992
  closeAITask(request: CloseAITaskRequest): Promise<CloseAITaskResponse>;
8892
8993
  /**
8893
- * * You can call this operation to cancel the migration task before data migration.
8894
- * * You can call this operation to perform the migration task after data migration.
8895
- * > Before you call this operation, ensure that a one-click upgrade task has been created for the cluster. You can call the [CreateDBCluster](~~98169~~) operation to create an upgrade task. Set the **CreationOption** parameter to **MigrationFromRDS**. For more information, see [Create a PolarDB for MySQL cluster by using the Migration from RDS method](~~121582~~).
8896
- *
8897
- * @param request CloseDBClusterMigrationRequest
8898
- * @param runtime runtime options for this request RuntimeOptions
8899
- * @return CloseDBClusterMigrationResponse
8994
+ * @summary Cancels or completes the migration task that upgrades an RDS cluster to a PolarDB cluster.
8995
+ *
8996
+ * @description * You can call this operation to cancel the migration task before data migration.
8997
+ * * You can call this operation to perform the migration task after data migration.
8998
+ * > Before you call this operation, ensure that a one-click upgrade task has been created for the cluster. You can call the [CreateDBCluster](https://help.aliyun.com/document_detail/98169.html) operation to create an upgrade task. Set the **CreationOption** parameter to **MigrationFromRDS**. For more information, see [Create a PolarDB for MySQL cluster by using the Migration from RDS method](https://help.aliyun.com/document_detail/121582.html).
8999
+ *
9000
+ * @param request CloseDBClusterMigrationRequest
9001
+ * @param runtime runtime options for this request RuntimeOptions
9002
+ * @return CloseDBClusterMigrationResponse
8900
9003
  */
8901
9004
  closeDBClusterMigrationWithOptions(request: CloseDBClusterMigrationRequest, runtime: $Util.RuntimeOptions): Promise<CloseDBClusterMigrationResponse>;
8902
9005
  /**
8903
- * * You can call this operation to cancel the migration task before data migration.
8904
- * * You can call this operation to perform the migration task after data migration.
8905
- * > Before you call this operation, ensure that a one-click upgrade task has been created for the cluster. You can call the [CreateDBCluster](~~98169~~) operation to create an upgrade task. Set the **CreationOption** parameter to **MigrationFromRDS**. For more information, see [Create a PolarDB for MySQL cluster by using the Migration from RDS method](~~121582~~).
8906
- *
8907
- * @param request CloseDBClusterMigrationRequest
8908
- * @return CloseDBClusterMigrationResponse
9006
+ * @summary Cancels or completes the migration task that upgrades an RDS cluster to a PolarDB cluster.
9007
+ *
9008
+ * @description * You can call this operation to cancel the migration task before data migration.
9009
+ * * You can call this operation to perform the migration task after data migration.
9010
+ * > Before you call this operation, ensure that a one-click upgrade task has been created for the cluster. You can call the [CreateDBCluster](https://help.aliyun.com/document_detail/98169.html) operation to create an upgrade task. Set the **CreationOption** parameter to **MigrationFromRDS**. For more information, see [Create a PolarDB for MySQL cluster by using the Migration from RDS method](https://help.aliyun.com/document_detail/121582.html).
9011
+ *
9012
+ * @param request CloseDBClusterMigrationRequest
9013
+ * @return CloseDBClusterMigrationResponse
8909
9014
  */
8910
9015
  closeDBClusterMigration(request: CloseDBClusterMigrationRequest): Promise<CloseDBClusterMigrationResponse>;
9016
+ /**
9017
+ * @summary Creates a database account for a PolarDB cluster.
9018
+ *
9019
+ * @param request CreateAccountRequest
9020
+ * @param runtime runtime options for this request RuntimeOptions
9021
+ * @return CreateAccountResponse
9022
+ */
8911
9023
  createAccountWithOptions(request: CreateAccountRequest, runtime: $Util.RuntimeOptions): Promise<CreateAccountResponse>;
9024
+ /**
9025
+ * @summary Creates a database account for a PolarDB cluster.
9026
+ *
9027
+ * @param request CreateAccountRequest
9028
+ * @return CreateAccountResponse
9029
+ */
8912
9030
  createAccount(request: CreateAccountRequest): Promise<CreateAccountResponse>;
8913
9031
  /**
8914
- * >
8915
- * * You can manually create up to three backups for each cluster.
8916
- * * The `Exceeding the daily backup times of this DB cluster` error message indicates that three manual backups already exist in your cluster. You must delete existing backups before you call this operation to manually create backups. For more information about how to delete backups, see [Delete backups](~~98101~~).
8917
- * * After you call this operation, a backup task is created in the backend. The task may be time-consuming if you want to back up large amounts of data.
8918
- *
8919
- * @param request CreateBackupRequest
8920
- * @param runtime runtime options for this request RuntimeOptions
8921
- * @return CreateBackupResponse
9032
+ * @summary Creates a full snapshot backup for a PolarDB cluster.
9033
+ *
9034
+ * @description >
9035
+ * * You can manually create up to three backups for each cluster.
9036
+ * * The `Exceeding the daily backup times of this DB cluster` error message indicates that three manual backups already exist in your cluster. You must delete existing backups before you call this operation to manually create backups. For more information about how to delete backups, see [Delete backups](https://help.aliyun.com/document_detail/98101.html).
9037
+ * * After you call this operation, a backup task is created in the backend. The task may be time-consuming if you want to back up large amounts of data.
9038
+ *
9039
+ * @param request CreateBackupRequest
9040
+ * @param runtime runtime options for this request RuntimeOptions
9041
+ * @return CreateBackupResponse
8922
9042
  */
8923
9043
  createBackupWithOptions(request: CreateBackupRequest, runtime: $Util.RuntimeOptions): Promise<CreateBackupResponse>;
8924
9044
  /**
8925
- * >
8926
- * * You can manually create up to three backups for each cluster.
8927
- * * The `Exceeding the daily backup times of this DB cluster` error message indicates that three manual backups already exist in your cluster. You must delete existing backups before you call this operation to manually create backups. For more information about how to delete backups, see [Delete backups](~~98101~~).
8928
- * * After you call this operation, a backup task is created in the backend. The task may be time-consuming if you want to back up large amounts of data.
8929
- *
8930
- * @param request CreateBackupRequest
8931
- * @return CreateBackupResponse
9045
+ * @summary Creates a full snapshot backup for a PolarDB cluster.
9046
+ *
9047
+ * @description >
9048
+ * * You can manually create up to three backups for each cluster.
9049
+ * * The `Exceeding the daily backup times of this DB cluster` error message indicates that three manual backups already exist in your cluster. You must delete existing backups before you call this operation to manually create backups. For more information about how to delete backups, see [Delete backups](https://help.aliyun.com/document_detail/98101.html).
9050
+ * * After you call this operation, a backup task is created in the backend. The task may be time-consuming if you want to back up large amounts of data.
9051
+ *
9052
+ * @param request CreateBackupRequest
9053
+ * @return CreateBackupResponse
8932
9054
  */
8933
9055
  createBackup(request: CreateBackupRequest): Promise<CreateBackupResponse>;
9056
+ /**
9057
+ * @summary 创建冷存储实例
9058
+ *
9059
+ * @param request CreateColdStorageInstanceRequest
9060
+ * @param runtime runtime options for this request RuntimeOptions
9061
+ * @return CreateColdStorageInstanceResponse
9062
+ */
8934
9063
  createColdStorageInstanceWithOptions(request: CreateColdStorageInstanceRequest, runtime: $Util.RuntimeOptions): Promise<CreateColdStorageInstanceResponse>;
9064
+ /**
9065
+ * @summary 创建冷存储实例
9066
+ *
9067
+ * @param request CreateColdStorageInstanceRequest
9068
+ * @return CreateColdStorageInstanceResponse
9069
+ */
8935
9070
  createColdStorageInstance(request: CreateColdStorageInstanceRequest): Promise<CreateColdStorageInstanceResponse>;
9071
+ /**
9072
+ * @summary Creates a PolarDB cluster.
9073
+ *
9074
+ * @param request CreateDBClusterRequest
9075
+ * @param runtime runtime options for this request RuntimeOptions
9076
+ * @return CreateDBClusterResponse
9077
+ */
8936
9078
  createDBClusterWithOptions(request: CreateDBClusterRequest, runtime: $Util.RuntimeOptions): Promise<CreateDBClusterResponse>;
9079
+ /**
9080
+ * @summary Creates a PolarDB cluster.
9081
+ *
9082
+ * @param request CreateDBClusterRequest
9083
+ * @return CreateDBClusterResponse
9084
+ */
8937
9085
  createDBCluster(request: CreateDBClusterRequest): Promise<CreateDBClusterResponse>;
9086
+ /**
9087
+ * @summary Creates a custom cluster endpoint for a PolarDB cluster.
9088
+ *
9089
+ * @param request CreateDBClusterEndpointRequest
9090
+ * @param runtime runtime options for this request RuntimeOptions
9091
+ * @return CreateDBClusterEndpointResponse
9092
+ */
8938
9093
  createDBClusterEndpointWithOptions(request: CreateDBClusterEndpointRequest, runtime: $Util.RuntimeOptions): Promise<CreateDBClusterEndpointResponse>;
9094
+ /**
9095
+ * @summary Creates a custom cluster endpoint for a PolarDB cluster.
9096
+ *
9097
+ * @param request CreateDBClusterEndpointRequest
9098
+ * @return CreateDBClusterEndpointResponse
9099
+ */
8939
9100
  createDBClusterEndpoint(request: CreateDBClusterEndpointRequest): Promise<CreateDBClusterEndpointResponse>;
8940
9101
  /**
8941
- * > You can create a public endpoint for the primary endpoint, the default cluster endpoint, or a custom cluster endpoint.
8942
- *
8943
- * @param request CreateDBEndpointAddressRequest
8944
- * @param runtime runtime options for this request RuntimeOptions
8945
- * @return CreateDBEndpointAddressResponse
9102
+ * @summary Creates a public endpoint for the primary endpoint, the default cluster endpoint, or a custom cluster endpoint.
9103
+ *
9104
+ * @description > You can create a public endpoint for the primary endpoint, the default cluster endpoint, or a custom cluster endpoint.
9105
+ *
9106
+ * @param request CreateDBEndpointAddressRequest
9107
+ * @param runtime runtime options for this request RuntimeOptions
9108
+ * @return CreateDBEndpointAddressResponse
8946
9109
  */
8947
9110
  createDBEndpointAddressWithOptions(request: CreateDBEndpointAddressRequest, runtime: $Util.RuntimeOptions): Promise<CreateDBEndpointAddressResponse>;
8948
9111
  /**
8949
- * > You can create a public endpoint for the primary endpoint, the default cluster endpoint, or a custom cluster endpoint.
8950
- *
8951
- * @param request CreateDBEndpointAddressRequest
8952
- * @return CreateDBEndpointAddressResponse
9112
+ * @summary Creates a public endpoint for the primary endpoint, the default cluster endpoint, or a custom cluster endpoint.
9113
+ *
9114
+ * @description > You can create a public endpoint for the primary endpoint, the default cluster endpoint, or a custom cluster endpoint.
9115
+ *
9116
+ * @param request CreateDBEndpointAddressRequest
9117
+ * @return CreateDBEndpointAddressResponse
8953
9118
  */
8954
9119
  createDBEndpointAddress(request: CreateDBEndpointAddressRequest): Promise<CreateDBEndpointAddressResponse>;
8955
9120
  /**
8956
- * A database link can be used to connect two PolarDB for PostgreSQL(Compatible with Oracle) clusters, or connect a PolarDB for PostgreSQL(Compatible with Oracle) cluster to a user-created PostgreSQL database that is hosted on an Elastic Compute Service (ECS) instance. You can use database links to query data across clusters.
8957
- * > * You can create up to 10 database links for a cluster.
8958
- * > * Each database link connects a source cluster and a destination cluster.
8959
- * > * The source cluster and the destination cluster or the destination ECS instance must be located in the same region.
8960
- *
8961
- * @param request CreateDBLinkRequest
8962
- * @param runtime runtime options for this request RuntimeOptions
8963
- * @return CreateDBLinkResponse
9121
+ * @summary Creates a database link.
9122
+ *
9123
+ * @description A database link can be used to connect two PolarDB for PostgreSQL(Compatible with Oracle) clusters, or connect a PolarDB for PostgreSQL(Compatible with Oracle) cluster to a user-created PostgreSQL database that is hosted on an Elastic Compute Service (ECS) instance. You can use database links to query data across clusters.
9124
+ * > * You can create up to 10 database links for a cluster.
9125
+ * > * Each database link connects a source cluster and a destination cluster.
9126
+ * > * The source cluster and the destination cluster or the destination ECS instance must be located in the same region.
9127
+ *
9128
+ * @param request CreateDBLinkRequest
9129
+ * @param runtime runtime options for this request RuntimeOptions
9130
+ * @return CreateDBLinkResponse
8964
9131
  */
8965
9132
  createDBLinkWithOptions(request: CreateDBLinkRequest, runtime: $Util.RuntimeOptions): Promise<CreateDBLinkResponse>;
8966
9133
  /**
8967
- * A database link can be used to connect two PolarDB for PostgreSQL(Compatible with Oracle) clusters, or connect a PolarDB for PostgreSQL(Compatible with Oracle) cluster to a user-created PostgreSQL database that is hosted on an Elastic Compute Service (ECS) instance. You can use database links to query data across clusters.
8968
- * > * You can create up to 10 database links for a cluster.
8969
- * > * Each database link connects a source cluster and a destination cluster.
8970
- * > * The source cluster and the destination cluster or the destination ECS instance must be located in the same region.
8971
- *
8972
- * @param request CreateDBLinkRequest
8973
- * @return CreateDBLinkResponse
9134
+ * @summary Creates a database link.
9135
+ *
9136
+ * @description A database link can be used to connect two PolarDB for PostgreSQL(Compatible with Oracle) clusters, or connect a PolarDB for PostgreSQL(Compatible with Oracle) cluster to a user-created PostgreSQL database that is hosted on an Elastic Compute Service (ECS) instance. You can use database links to query data across clusters.
9137
+ * > * You can create up to 10 database links for a cluster.
9138
+ * > * Each database link connects a source cluster and a destination cluster.
9139
+ * > * The source cluster and the destination cluster or the destination ECS instance must be located in the same region.
9140
+ *
9141
+ * @param request CreateDBLinkRequest
9142
+ * @return CreateDBLinkResponse
8974
9143
  */
8975
9144
  createDBLink(request: CreateDBLinkRequest): Promise<CreateDBLinkResponse>;
9145
+ /**
9146
+ * @summary Adds a read-only node to a PolarDB cluster.
9147
+ *
9148
+ * @param request CreateDBNodesRequest
9149
+ * @param runtime runtime options for this request RuntimeOptions
9150
+ * @return CreateDBNodesResponse
9151
+ */
8976
9152
  createDBNodesWithOptions(request: CreateDBNodesRequest, runtime: $Util.RuntimeOptions): Promise<CreateDBNodesResponse>;
9153
+ /**
9154
+ * @summary Adds a read-only node to a PolarDB cluster.
9155
+ *
9156
+ * @param request CreateDBNodesRequest
9157
+ * @return CreateDBNodesResponse
9158
+ */
8977
9159
  createDBNodes(request: CreateDBNodesRequest): Promise<CreateDBNodesResponse>;
8978
9160
  /**
8979
- * Before you call this operation, make sure that the following requirements are met:
8980
- * * The cluster is in the Running state.
8981
- * * The cluster is unlocked.
8982
- *
8983
- * @param request CreateDatabaseRequest
8984
- * @param runtime runtime options for this request RuntimeOptions
8985
- * @return CreateDatabaseResponse
9161
+ * @summary Creates a database for a PolarDB cluster.
9162
+ *
9163
+ * @description Before you call this operation, make sure that the following requirements are met:
9164
+ * * The cluster is in the Running state.
9165
+ * * The cluster is unlocked.
9166
+ *
9167
+ * @param request CreateDatabaseRequest
9168
+ * @param runtime runtime options for this request RuntimeOptions
9169
+ * @return CreateDatabaseResponse
8986
9170
  */
8987
9171
  createDatabaseWithOptions(request: CreateDatabaseRequest, runtime: $Util.RuntimeOptions): Promise<CreateDatabaseResponse>;
8988
9172
  /**
8989
- * Before you call this operation, make sure that the following requirements are met:
8990
- * * The cluster is in the Running state.
8991
- * * The cluster is unlocked.
8992
- *
8993
- * @param request CreateDatabaseRequest
8994
- * @return CreateDatabaseResponse
9173
+ * @summary Creates a database for a PolarDB cluster.
9174
+ *
9175
+ * @description Before you call this operation, make sure that the following requirements are met:
9176
+ * * The cluster is in the Running state.
9177
+ * * The cluster is unlocked.
9178
+ *
9179
+ * @param request CreateDatabaseRequest
9180
+ * @return CreateDatabaseResponse
8995
9181
  */
8996
9182
  createDatabase(request: CreateDatabaseRequest): Promise<CreateDatabaseResponse>;
8997
9183
  /**
8998
- * > A cluster belongs to only one GDN.
8999
- *
9000
- * @param request CreateGlobalDatabaseNetworkRequest
9001
- * @param runtime runtime options for this request RuntimeOptions
9002
- * @return CreateGlobalDatabaseNetworkResponse
9184
+ * @summary Creates a global database network (GDN).
9185
+ *
9186
+ * @description > A cluster belongs to only one GDN.
9187
+ *
9188
+ * @param request CreateGlobalDatabaseNetworkRequest
9189
+ * @param runtime runtime options for this request RuntimeOptions
9190
+ * @return CreateGlobalDatabaseNetworkResponse
9003
9191
  */
9004
9192
  createGlobalDatabaseNetworkWithOptions(request: CreateGlobalDatabaseNetworkRequest, runtime: $Util.RuntimeOptions): Promise<CreateGlobalDatabaseNetworkResponse>;
9005
9193
  /**
9006
- * > A cluster belongs to only one GDN.
9007
- *
9008
- * @param request CreateGlobalDatabaseNetworkRequest
9009
- * @return CreateGlobalDatabaseNetworkResponse
9194
+ * @summary Creates a global database network (GDN).
9195
+ *
9196
+ * @description > A cluster belongs to only one GDN.
9197
+ *
9198
+ * @param request CreateGlobalDatabaseNetworkRequest
9199
+ * @return CreateGlobalDatabaseNetworkResponse
9010
9200
  */
9011
9201
  createGlobalDatabaseNetwork(request: CreateGlobalDatabaseNetworkRequest): Promise<CreateGlobalDatabaseNetworkResponse>;
9202
+ /**
9203
+ * @summary Creates a global IP whitelist template.
9204
+ *
9205
+ * @param request CreateGlobalSecurityIPGroupRequest
9206
+ * @param runtime runtime options for this request RuntimeOptions
9207
+ * @return CreateGlobalSecurityIPGroupResponse
9208
+ */
9012
9209
  createGlobalSecurityIPGroupWithOptions(request: CreateGlobalSecurityIPGroupRequest, runtime: $Util.RuntimeOptions): Promise<CreateGlobalSecurityIPGroupResponse>;
9210
+ /**
9211
+ * @summary Creates a global IP whitelist template.
9212
+ *
9213
+ * @param request CreateGlobalSecurityIPGroupRequest
9214
+ * @return CreateGlobalSecurityIPGroupResponse
9215
+ */
9013
9216
  createGlobalSecurityIPGroup(request: CreateGlobalSecurityIPGroupRequest): Promise<CreateGlobalSecurityIPGroupResponse>;
9014
9217
  /**
9015
- * You can use parameter templates to manage multiple parameters at a time and apply existing parameters to a PolarDB cluster. For more information, see [Use a parameter template](~~207009~~).
9016
- * > You can call this operation only on a PolarDB for MySQL cluster.
9017
- *
9018
- * @param request CreateParameterGroupRequest
9019
- * @param runtime runtime options for this request RuntimeOptions
9020
- * @return CreateParameterGroupResponse
9218
+ * @summary Creates a parameter template.
9219
+ *
9220
+ * @description You can use parameter templates to manage multiple parameters at a time and apply existing parameters to a PolarDB cluster. For more information, see [Use a parameter template](https://help.aliyun.com/document_detail/207009.html).
9221
+ * > You can call this operation only on a PolarDB for MySQL cluster.
9222
+ *
9223
+ * @param request CreateParameterGroupRequest
9224
+ * @param runtime runtime options for this request RuntimeOptions
9225
+ * @return CreateParameterGroupResponse
9021
9226
  */
9022
9227
  createParameterGroupWithOptions(request: CreateParameterGroupRequest, runtime: $Util.RuntimeOptions): Promise<CreateParameterGroupResponse>;
9023
9228
  /**
9024
- * You can use parameter templates to manage multiple parameters at a time and apply existing parameters to a PolarDB cluster. For more information, see [Use a parameter template](~~207009~~).
9025
- * > You can call this operation only on a PolarDB for MySQL cluster.
9026
- *
9027
- * @param request CreateParameterGroupRequest
9028
- * @return CreateParameterGroupResponse
9229
+ * @summary Creates a parameter template.
9230
+ *
9231
+ * @description You can use parameter templates to manage multiple parameters at a time and apply existing parameters to a PolarDB cluster. For more information, see [Use a parameter template](https://help.aliyun.com/document_detail/207009.html).
9232
+ * > You can call this operation only on a PolarDB for MySQL cluster.
9233
+ *
9234
+ * @param request CreateParameterGroupRequest
9235
+ * @return CreateParameterGroupResponse
9029
9236
  */
9030
9237
  createParameterGroup(request: CreateParameterGroupRequest): Promise<CreateParameterGroupResponse>;
9238
+ /**
9239
+ * @summary Creates a service-linked role (SLR).
9240
+ *
9241
+ * @param request CreateServiceLinkedRoleRequest
9242
+ * @param runtime runtime options for this request RuntimeOptions
9243
+ * @return CreateServiceLinkedRoleResponse
9244
+ */
9031
9245
  createServiceLinkedRoleWithOptions(request: CreateServiceLinkedRoleRequest, runtime: $Util.RuntimeOptions): Promise<CreateServiceLinkedRoleResponse>;
9246
+ /**
9247
+ * @summary Creates a service-linked role (SLR).
9248
+ *
9249
+ * @param request CreateServiceLinkedRoleRequest
9250
+ * @return CreateServiceLinkedRoleResponse
9251
+ */
9032
9252
  createServiceLinkedRole(request: CreateServiceLinkedRoleRequest): Promise<CreateServiceLinkedRoleResponse>;
9253
+ /**
9254
+ * @summary Purchases a storage plan.
9255
+ *
9256
+ * @param request CreateStoragePlanRequest
9257
+ * @param runtime runtime options for this request RuntimeOptions
9258
+ * @return CreateStoragePlanResponse
9259
+ */
9033
9260
  createStoragePlanWithOptions(request: CreateStoragePlanRequest, runtime: $Util.RuntimeOptions): Promise<CreateStoragePlanResponse>;
9261
+ /**
9262
+ * @summary Purchases a storage plan.
9263
+ *
9264
+ * @param request CreateStoragePlanRequest
9265
+ * @return CreateStoragePlanResponse
9266
+ */
9034
9267
  createStoragePlan(request: CreateStoragePlanRequest): Promise<CreateStoragePlanResponse>;
9035
9268
  /**
9036
- * > Before you call this operation, make sure that the cluster is in the Running state. Otherwise, the operation fails.
9037
- *
9038
- * @param request DeleteAccountRequest
9039
- * @param runtime runtime options for this request RuntimeOptions
9040
- * @return DeleteAccountResponse
9269
+ * @summary Deletes a database account for a PolarDB cluster.
9270
+ *
9271
+ * @description > Before you call this operation, make sure that the cluster is in the Running state. Otherwise, the operation fails.
9272
+ *
9273
+ * @param request DeleteAccountRequest
9274
+ * @param runtime runtime options for this request RuntimeOptions
9275
+ * @return DeleteAccountResponse
9041
9276
  */
9042
9277
  deleteAccountWithOptions(request: DeleteAccountRequest, runtime: $Util.RuntimeOptions): Promise<DeleteAccountResponse>;
9043
9278
  /**
9044
- * > Before you call this operation, make sure that the cluster is in the Running state. Otherwise, the operation fails.
9045
- *
9046
- * @param request DeleteAccountRequest
9047
- * @return DeleteAccountResponse
9279
+ * @summary Deletes a database account for a PolarDB cluster.
9280
+ *
9281
+ * @description > Before you call this operation, make sure that the cluster is in the Running state. Otherwise, the operation fails.
9282
+ *
9283
+ * @param request DeleteAccountRequest
9284
+ * @return DeleteAccountResponse
9048
9285
  */
9049
9286
  deleteAccount(request: DeleteAccountRequest): Promise<DeleteAccountResponse>;
9050
9287
  /**
9051
- * Before you call this operation, make sure that the cluster meets the following requirements:
9052
- * * The cluster is in the Running state.
9053
- * * The backup sets are in the Success state.
9054
- * > * You can call the [DescribeBackups](~~98102~~) operation to query the status of backup sets.
9055
- * >* After you delete the backup set file, the storage space that is occupied by the file is released. The released storage space is smaller than the size of the file because your snapshots share some data blocks
9056
- *
9057
- * @param request DeleteBackupRequest
9058
- * @param runtime runtime options for this request RuntimeOptions
9059
- * @return DeleteBackupResponse
9288
+ * @summary Deletes the backup sets of a PolarDB cluster.
9289
+ *
9290
+ * @description Before you call this operation, make sure that the cluster meets the following requirements:
9291
+ * * The cluster is in the Running state.
9292
+ * * The backup sets are in the Success state.
9293
+ * > * You can call the [DescribeBackups](https://help.aliyun.com/document_detail/98102.html) operation to query the status of backup sets.
9294
+ * >* After you delete the backup set file, the storage space that is occupied by the file is released. The released storage space is smaller than the size of the file because your snapshots share some data blocks
9295
+ *
9296
+ * @param request DeleteBackupRequest
9297
+ * @param runtime runtime options for this request RuntimeOptions
9298
+ * @return DeleteBackupResponse
9060
9299
  */
9061
9300
  deleteBackupWithOptions(request: DeleteBackupRequest, runtime: $Util.RuntimeOptions): Promise<DeleteBackupResponse>;
9062
9301
  /**
9063
- * Before you call this operation, make sure that the cluster meets the following requirements:
9064
- * * The cluster is in the Running state.
9065
- * * The backup sets are in the Success state.
9066
- * > * You can call the [DescribeBackups](~~98102~~) operation to query the status of backup sets.
9067
- * >* After you delete the backup set file, the storage space that is occupied by the file is released. The released storage space is smaller than the size of the file because your snapshots share some data blocks
9068
- *
9069
- * @param request DeleteBackupRequest
9070
- * @return DeleteBackupResponse
9302
+ * @summary Deletes the backup sets of a PolarDB cluster.
9303
+ *
9304
+ * @description Before you call this operation, make sure that the cluster meets the following requirements:
9305
+ * * The cluster is in the Running state.
9306
+ * * The backup sets are in the Success state.
9307
+ * > * You can call the [DescribeBackups](https://help.aliyun.com/document_detail/98102.html) operation to query the status of backup sets.
9308
+ * >* After you delete the backup set file, the storage space that is occupied by the file is released. The released storage space is smaller than the size of the file because your snapshots share some data blocks
9309
+ *
9310
+ * @param request DeleteBackupRequest
9311
+ * @return DeleteBackupResponse
9071
9312
  */
9072
9313
  deleteBackup(request: DeleteBackupRequest): Promise<DeleteBackupResponse>;
9314
+ /**
9315
+ * @summary Releases a pay-as-you-go PolarDB cluster.
9316
+ *
9317
+ * @param request DeleteDBClusterRequest
9318
+ * @param runtime runtime options for this request RuntimeOptions
9319
+ * @return DeleteDBClusterResponse
9320
+ */
9073
9321
  deleteDBClusterWithOptions(request: DeleteDBClusterRequest, runtime: $Util.RuntimeOptions): Promise<DeleteDBClusterResponse>;
9322
+ /**
9323
+ * @summary Releases a pay-as-you-go PolarDB cluster.
9324
+ *
9325
+ * @param request DeleteDBClusterRequest
9326
+ * @return DeleteDBClusterResponse
9327
+ */
9074
9328
  deleteDBCluster(request: DeleteDBClusterRequest): Promise<DeleteDBClusterResponse>;
9329
+ /**
9330
+ * @summary Releases a custom cluster endpoint of a PolarDB cluster.
9331
+ *
9332
+ * @param request DeleteDBClusterEndpointRequest
9333
+ * @param runtime runtime options for this request RuntimeOptions
9334
+ * @return DeleteDBClusterEndpointResponse
9335
+ */
9075
9336
  deleteDBClusterEndpointWithOptions(request: DeleteDBClusterEndpointRequest, runtime: $Util.RuntimeOptions): Promise<DeleteDBClusterEndpointResponse>;
9337
+ /**
9338
+ * @summary Releases a custom cluster endpoint of a PolarDB cluster.
9339
+ *
9340
+ * @param request DeleteDBClusterEndpointRequest
9341
+ * @return DeleteDBClusterEndpointResponse
9342
+ */
9076
9343
  deleteDBClusterEndpoint(request: DeleteDBClusterEndpointRequest): Promise<DeleteDBClusterEndpointResponse>;
9077
9344
  /**
9078
- * > * You can delete a public-facing or classic network endpoint of the primary endpoint, the default cluster endpoint, or a custom cluster endpoint.
9079
- * > * Classic network endpoints are supported only on the China site (aliyun.com). Therefore, you do not need to delete classic network endpoints on the International site (alibabacloud.com).
9080
- *
9081
- * @param request DeleteDBEndpointAddressRequest
9082
- * @param runtime runtime options for this request RuntimeOptions
9083
- * @return DeleteDBEndpointAddressResponse
9345
+ * @summary Releases the public endpoints of a PolarDB cluster, including the primary endpoint, default cluster endpoint, and custom cluster endpoint.
9346
+ *
9347
+ * @description > * You can delete a public-facing or classic network endpoint of the primary endpoint, the default cluster endpoint, or a custom cluster endpoint.
9348
+ * > * Classic network endpoints are supported only on the China site (aliyun.com). Therefore, you do not need to delete classic network endpoints on the International site (alibabacloud.com).
9349
+ *
9350
+ * @param request DeleteDBEndpointAddressRequest
9351
+ * @param runtime runtime options for this request RuntimeOptions
9352
+ * @return DeleteDBEndpointAddressResponse
9084
9353
  */
9085
9354
  deleteDBEndpointAddressWithOptions(request: DeleteDBEndpointAddressRequest, runtime: $Util.RuntimeOptions): Promise<DeleteDBEndpointAddressResponse>;
9086
9355
  /**
9087
- * > * You can delete a public-facing or classic network endpoint of the primary endpoint, the default cluster endpoint, or a custom cluster endpoint.
9088
- * > * Classic network endpoints are supported only on the China site (aliyun.com). Therefore, you do not need to delete classic network endpoints on the International site (alibabacloud.com).
9089
- *
9090
- * @param request DeleteDBEndpointAddressRequest
9091
- * @return DeleteDBEndpointAddressResponse
9356
+ * @summary Releases the public endpoints of a PolarDB cluster, including the primary endpoint, default cluster endpoint, and custom cluster endpoint.
9357
+ *
9358
+ * @description > * You can delete a public-facing or classic network endpoint of the primary endpoint, the default cluster endpoint, or a custom cluster endpoint.
9359
+ * > * Classic network endpoints are supported only on the China site (aliyun.com). Therefore, you do not need to delete classic network endpoints on the International site (alibabacloud.com).
9360
+ *
9361
+ * @param request DeleteDBEndpointAddressRequest
9362
+ * @return DeleteDBEndpointAddressResponse
9092
9363
  */
9093
9364
  deleteDBEndpointAddress(request: DeleteDBEndpointAddressRequest): Promise<DeleteDBEndpointAddressResponse>;
9365
+ /**
9366
+ * @summary Deletes a database link from a PolarDB for PostgreSQL (Compatible with Oracle) cluster.
9367
+ *
9368
+ * @param request DeleteDBLinkRequest
9369
+ * @param runtime runtime options for this request RuntimeOptions
9370
+ * @return DeleteDBLinkResponse
9371
+ */
9094
9372
  deleteDBLinkWithOptions(request: DeleteDBLinkRequest, runtime: $Util.RuntimeOptions): Promise<DeleteDBLinkResponse>;
9373
+ /**
9374
+ * @summary Deletes a database link from a PolarDB for PostgreSQL (Compatible with Oracle) cluster.
9375
+ *
9376
+ * @param request DeleteDBLinkRequest
9377
+ * @return DeleteDBLinkResponse
9378
+ */
9095
9379
  deleteDBLink(request: DeleteDBLinkRequest): Promise<DeleteDBLinkResponse>;
9380
+ /**
9381
+ * @summary Deletes a read-only node from a PolarDB cluster.
9382
+ *
9383
+ * @param request DeleteDBNodesRequest
9384
+ * @param runtime runtime options for this request RuntimeOptions
9385
+ * @return DeleteDBNodesResponse
9386
+ */
9096
9387
  deleteDBNodesWithOptions(request: DeleteDBNodesRequest, runtime: $Util.RuntimeOptions): Promise<DeleteDBNodesResponse>;
9388
+ /**
9389
+ * @summary Deletes a read-only node from a PolarDB cluster.
9390
+ *
9391
+ * @param request DeleteDBNodesRequest
9392
+ * @return DeleteDBNodesResponse
9393
+ */
9097
9394
  deleteDBNodes(request: DeleteDBNodesRequest): Promise<DeleteDBNodesResponse>;
9098
9395
  /**
9099
- * >- The cluster must be in the Running state and unlocked. Otherwise, the specified database cannot be deleted.
9100
- * >- The delete operation is performed in an asynchronous manner. A long period of time may be required to delete a large database. A success response for this operation only indicates that the request to delete the database is sent. You must query the database to check whether the database is deleted.
9101
- *
9102
- * @param request DeleteDatabaseRequest
9103
- * @param runtime runtime options for this request RuntimeOptions
9104
- * @return DeleteDatabaseResponse
9396
+ * @summary Deletes a database from a PolarDB cluster.
9397
+ *
9398
+ * @description >- The cluster must be in the Running state and unlocked. Otherwise, the specified database cannot be deleted.
9399
+ * >- The delete operation is performed in an asynchronous manner. A long period of time may be required to delete a large database. A success response for this operation only indicates that the request to delete the database is sent. You must query the database to check whether the database is deleted.
9400
+ *
9401
+ * @param request DeleteDatabaseRequest
9402
+ * @param runtime runtime options for this request RuntimeOptions
9403
+ * @return DeleteDatabaseResponse
9105
9404
  */
9106
9405
  deleteDatabaseWithOptions(request: DeleteDatabaseRequest, runtime: $Util.RuntimeOptions): Promise<DeleteDatabaseResponse>;
9107
9406
  /**
9108
- * >- The cluster must be in the Running state and unlocked. Otherwise, the specified database cannot be deleted.
9109
- * >- The delete operation is performed in an asynchronous manner. A long period of time may be required to delete a large database. A success response for this operation only indicates that the request to delete the database is sent. You must query the database to check whether the database is deleted.
9110
- *
9111
- * @param request DeleteDatabaseRequest
9112
- * @return DeleteDatabaseResponse
9407
+ * @summary Deletes a database from a PolarDB cluster.
9408
+ *
9409
+ * @description >- The cluster must be in the Running state and unlocked. Otherwise, the specified database cannot be deleted.
9410
+ * >- The delete operation is performed in an asynchronous manner. A long period of time may be required to delete a large database. A success response for this operation only indicates that the request to delete the database is sent. You must query the database to check whether the database is deleted.
9411
+ *
9412
+ * @param request DeleteDatabaseRequest
9413
+ * @return DeleteDatabaseResponse
9113
9414
  */
9114
9415
  deleteDatabase(request: DeleteDatabaseRequest): Promise<DeleteDatabaseResponse>;
9115
9416
  /**
9116
- * > You can delete a GDN only when the GDN includes only a primary cluster.
9117
- *
9118
- * @param request DeleteGlobalDatabaseNetworkRequest
9119
- * @param runtime runtime options for this request RuntimeOptions
9120
- * @return DeleteGlobalDatabaseNetworkResponse
9417
+ * @summary Deletes a global database network (GDN).
9418
+ *
9419
+ * @description > You can delete a GDN only when the GDN includes only a primary cluster.
9420
+ *
9421
+ * @param request DeleteGlobalDatabaseNetworkRequest
9422
+ * @param runtime runtime options for this request RuntimeOptions
9423
+ * @return DeleteGlobalDatabaseNetworkResponse
9121
9424
  */
9122
9425
  deleteGlobalDatabaseNetworkWithOptions(request: DeleteGlobalDatabaseNetworkRequest, runtime: $Util.RuntimeOptions): Promise<DeleteGlobalDatabaseNetworkResponse>;
9123
9426
  /**
9124
- * > You can delete a GDN only when the GDN includes only a primary cluster.
9125
- *
9126
- * @param request DeleteGlobalDatabaseNetworkRequest
9127
- * @return DeleteGlobalDatabaseNetworkResponse
9427
+ * @summary Deletes a global database network (GDN).
9428
+ *
9429
+ * @description > You can delete a GDN only when the GDN includes only a primary cluster.
9430
+ *
9431
+ * @param request DeleteGlobalDatabaseNetworkRequest
9432
+ * @return DeleteGlobalDatabaseNetworkResponse
9128
9433
  */
9129
9434
  deleteGlobalDatabaseNetwork(request: DeleteGlobalDatabaseNetworkRequest): Promise<DeleteGlobalDatabaseNetworkResponse>;
9435
+ /**
9436
+ * @summary Deletes a global IP whitelist template.
9437
+ *
9438
+ * @param request DeleteGlobalSecurityIPGroupRequest
9439
+ * @param runtime runtime options for this request RuntimeOptions
9440
+ * @return DeleteGlobalSecurityIPGroupResponse
9441
+ */
9130
9442
  deleteGlobalSecurityIPGroupWithOptions(request: DeleteGlobalSecurityIPGroupRequest, runtime: $Util.RuntimeOptions): Promise<DeleteGlobalSecurityIPGroupResponse>;
9443
+ /**
9444
+ * @summary Deletes a global IP whitelist template.
9445
+ *
9446
+ * @param request DeleteGlobalSecurityIPGroupRequest
9447
+ * @return DeleteGlobalSecurityIPGroupResponse
9448
+ */
9131
9449
  deleteGlobalSecurityIPGroup(request: DeleteGlobalSecurityIPGroupRequest): Promise<DeleteGlobalSecurityIPGroupResponse>;
9450
+ /**
9451
+ * @summary Deletes a data masking rule.
9452
+ *
9453
+ * @param request DeleteMaskingRulesRequest
9454
+ * @param runtime runtime options for this request RuntimeOptions
9455
+ * @return DeleteMaskingRulesResponse
9456
+ */
9132
9457
  deleteMaskingRulesWithOptions(request: DeleteMaskingRulesRequest, runtime: $Util.RuntimeOptions): Promise<DeleteMaskingRulesResponse>;
9458
+ /**
9459
+ * @summary Deletes a data masking rule.
9460
+ *
9461
+ * @param request DeleteMaskingRulesRequest
9462
+ * @return DeleteMaskingRulesResponse
9463
+ */
9133
9464
  deleteMaskingRules(request: DeleteMaskingRulesRequest): Promise<DeleteMaskingRulesResponse>;
9134
9465
  /**
9135
- * You can use parameter templates to manage multiple parameters at a time and quickly apply existing parameters to a PolarDB cluster. For more information, see [Use a parameter template](~~207009~~).
9136
- * > When you delete a parameter template, the parameter settings that are applied to PolarDB clusters are not affected.
9137
- *
9138
- * @param request DeleteParameterGroupRequest
9139
- * @param runtime runtime options for this request RuntimeOptions
9140
- * @return DeleteParameterGroupResponse
9466
+ * @summary Deletes a parameter template of a PolarDB cluster.
9467
+ *
9468
+ * @description You can use parameter templates to manage multiple parameters at a time and quickly apply existing parameters to a PolarDB cluster. For more information, see [Use a parameter template](https://help.aliyun.com/document_detail/207009.html).
9469
+ * > When you delete a parameter template, the parameter settings that are applied to PolarDB clusters are not affected.
9470
+ *
9471
+ * @param request DeleteParameterGroupRequest
9472
+ * @param runtime runtime options for this request RuntimeOptions
9473
+ * @return DeleteParameterGroupResponse
9141
9474
  */
9142
9475
  deleteParameterGroupWithOptions(request: DeleteParameterGroupRequest, runtime: $Util.RuntimeOptions): Promise<DeleteParameterGroupResponse>;
9143
9476
  /**
9144
- * You can use parameter templates to manage multiple parameters at a time and quickly apply existing parameters to a PolarDB cluster. For more information, see [Use a parameter template](~~207009~~).
9145
- * > When you delete a parameter template, the parameter settings that are applied to PolarDB clusters are not affected.
9146
- *
9147
- * @param request DeleteParameterGroupRequest
9148
- * @return DeleteParameterGroupResponse
9477
+ * @summary Deletes a parameter template of a PolarDB cluster.
9478
+ *
9479
+ * @description You can use parameter templates to manage multiple parameters at a time and quickly apply existing parameters to a PolarDB cluster. For more information, see [Use a parameter template](https://help.aliyun.com/document_detail/207009.html).
9480
+ * > When you delete a parameter template, the parameter settings that are applied to PolarDB clusters are not affected.
9481
+ *
9482
+ * @param request DeleteParameterGroupRequest
9483
+ * @return DeleteParameterGroupResponse
9149
9484
  */
9150
9485
  deleteParameterGroup(request: DeleteParameterGroupRequest): Promise<DeleteParameterGroupResponse>;
9486
+ /**
9487
+ * @summary Queries the state of the PolarDB for AI feature for a cluster.
9488
+ *
9489
+ * @param request DescribeAITaskStatusRequest
9490
+ * @param runtime runtime options for this request RuntimeOptions
9491
+ * @return DescribeAITaskStatusResponse
9492
+ */
9151
9493
  describeAITaskStatusWithOptions(request: DescribeAITaskStatusRequest, runtime: $Util.RuntimeOptions): Promise<DescribeAITaskStatusResponse>;
9494
+ /**
9495
+ * @summary Queries the state of the PolarDB for AI feature for a cluster.
9496
+ *
9497
+ * @param request DescribeAITaskStatusRequest
9498
+ * @return DescribeAITaskStatusResponse
9499
+ */
9152
9500
  describeAITaskStatus(request: DescribeAITaskStatusRequest): Promise<DescribeAITaskStatusResponse>;
9501
+ /**
9502
+ * @summary Queries information about a database account of a PolarDB cluster.
9503
+ *
9504
+ * @param request DescribeAccountsRequest
9505
+ * @param runtime runtime options for this request RuntimeOptions
9506
+ * @return DescribeAccountsResponse
9507
+ */
9153
9508
  describeAccountsWithOptions(request: DescribeAccountsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeAccountsResponse>;
9509
+ /**
9510
+ * @summary Queries information about a database account of a PolarDB cluster.
9511
+ *
9512
+ * @param request DescribeAccountsRequest
9513
+ * @return DescribeAccountsResponse
9514
+ */
9154
9515
  describeAccounts(request: DescribeAccountsRequest): Promise<DescribeAccountsResponse>;
9516
+ /**
9517
+ * @summary Queries the auto-renewal attributes of a subscription PolarDB cluster.
9518
+ *
9519
+ * @param request DescribeAutoRenewAttributeRequest
9520
+ * @param runtime runtime options for this request RuntimeOptions
9521
+ * @return DescribeAutoRenewAttributeResponse
9522
+ */
9155
9523
  describeAutoRenewAttributeWithOptions(request: DescribeAutoRenewAttributeRequest, runtime: $Util.RuntimeOptions): Promise<DescribeAutoRenewAttributeResponse>;
9524
+ /**
9525
+ * @summary Queries the auto-renewal attributes of a subscription PolarDB cluster.
9526
+ *
9527
+ * @param request DescribeAutoRenewAttributeRequest
9528
+ * @return DescribeAutoRenewAttributeResponse
9529
+ */
9156
9530
  describeAutoRenewAttribute(request: DescribeAutoRenewAttributeRequest): Promise<DescribeAutoRenewAttributeResponse>;
9531
+ /**
9532
+ * @summary Queries backup logs and the URLs to download the backup logs.
9533
+ *
9534
+ * @param request DescribeBackupLogsRequest
9535
+ * @param runtime runtime options for this request RuntimeOptions
9536
+ * @return DescribeBackupLogsResponse
9537
+ */
9157
9538
  describeBackupLogsWithOptions(request: DescribeBackupLogsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeBackupLogsResponse>;
9539
+ /**
9540
+ * @summary Queries backup logs and the URLs to download the backup logs.
9541
+ *
9542
+ * @param request DescribeBackupLogsRequest
9543
+ * @return DescribeBackupLogsResponse
9544
+ */
9158
9545
  describeBackupLogs(request: DescribeBackupLogsRequest): Promise<DescribeBackupLogsResponse>;
9546
+ /**
9547
+ * @summary Queries the automatic backup policy of a PolarDB cluster.
9548
+ *
9549
+ * @param request DescribeBackupPolicyRequest
9550
+ * @param runtime runtime options for this request RuntimeOptions
9551
+ * @return DescribeBackupPolicyResponse
9552
+ */
9159
9553
  describeBackupPolicyWithOptions(request: DescribeBackupPolicyRequest, runtime: $Util.RuntimeOptions): Promise<DescribeBackupPolicyResponse>;
9554
+ /**
9555
+ * @summary Queries the automatic backup policy of a PolarDB cluster.
9556
+ *
9557
+ * @param request DescribeBackupPolicyRequest
9558
+ * @return DescribeBackupPolicyResponse
9559
+ */
9160
9560
  describeBackupPolicy(request: DescribeBackupPolicyRequest): Promise<DescribeBackupPolicyResponse>;
9561
+ /**
9562
+ * @summary Queries the backup tasks of a PolarDB cluster.
9563
+ *
9564
+ * @param request DescribeBackupTasksRequest
9565
+ * @param runtime runtime options for this request RuntimeOptions
9566
+ * @return DescribeBackupTasksResponse
9567
+ */
9161
9568
  describeBackupTasksWithOptions(request: DescribeBackupTasksRequest, runtime: $Util.RuntimeOptions): Promise<DescribeBackupTasksResponse>;
9569
+ /**
9570
+ * @summary Queries the backup tasks of a PolarDB cluster.
9571
+ *
9572
+ * @param request DescribeBackupTasksRequest
9573
+ * @return DescribeBackupTasksResponse
9574
+ */
9162
9575
  describeBackupTasks(request: DescribeBackupTasksRequest): Promise<DescribeBackupTasksResponse>;
9576
+ /**
9577
+ * @summary Queries the backup details of a PolarDB cluster.
9578
+ *
9579
+ * @param request DescribeBackupsRequest
9580
+ * @param runtime runtime options for this request RuntimeOptions
9581
+ * @return DescribeBackupsResponse
9582
+ */
9163
9583
  describeBackupsWithOptions(request: DescribeBackupsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeBackupsResponse>;
9584
+ /**
9585
+ * @summary Queries the backup details of a PolarDB cluster.
9586
+ *
9587
+ * @param request DescribeBackupsRequest
9588
+ * @return DescribeBackupsResponse
9589
+ */
9164
9590
  describeBackups(request: DescribeBackupsRequest): Promise<DescribeBackupsResponse>;
9591
+ /**
9592
+ * @summary Queries character sets that are supported by a PolarDB for MySQL cluster.
9593
+ *
9594
+ * @param request DescribeCharacterSetNameRequest
9595
+ * @param runtime runtime options for this request RuntimeOptions
9596
+ * @return DescribeCharacterSetNameResponse
9597
+ */
9165
9598
  describeCharacterSetNameWithOptions(request: DescribeCharacterSetNameRequest, runtime: $Util.RuntimeOptions): Promise<DescribeCharacterSetNameResponse>;
9599
+ /**
9600
+ * @summary Queries character sets that are supported by a PolarDB for MySQL cluster.
9601
+ *
9602
+ * @param request DescribeCharacterSetNameRequest
9603
+ * @return DescribeCharacterSetNameResponse
9604
+ */
9166
9605
  describeCharacterSetName(request: DescribeCharacterSetNameRequest): Promise<DescribeCharacterSetNameResponse>;
9606
+ /**
9607
+ * @summary Queries the specifications of a cluster.
9608
+ *
9609
+ * @param request DescribeClassListRequest
9610
+ * @param runtime runtime options for this request RuntimeOptions
9611
+ * @return DescribeClassListResponse
9612
+ */
9167
9613
  describeClassListWithOptions(request: DescribeClassListRequest, runtime: $Util.RuntimeOptions): Promise<DescribeClassListResponse>;
9614
+ /**
9615
+ * @summary Queries the specifications of a cluster.
9616
+ *
9617
+ * @param request DescribeClassListRequest
9618
+ * @return DescribeClassListResponse
9619
+ */
9168
9620
  describeClassList(request: DescribeClassListRequest): Promise<DescribeClassListResponse>;
9621
+ /**
9622
+ * @summary Queries the IP address whitelists and security groups of a PolarDB cluster.
9623
+ *
9624
+ * @param request DescribeDBClusterAccessWhitelistRequest
9625
+ * @param runtime runtime options for this request RuntimeOptions
9626
+ * @return DescribeDBClusterAccessWhitelistResponse
9627
+ */
9169
9628
  describeDBClusterAccessWhitelistWithOptions(request: DescribeDBClusterAccessWhitelistRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBClusterAccessWhitelistResponse>;
9629
+ /**
9630
+ * @summary Queries the IP address whitelists and security groups of a PolarDB cluster.
9631
+ *
9632
+ * @param request DescribeDBClusterAccessWhitelistRequest
9633
+ * @return DescribeDBClusterAccessWhitelistResponse
9634
+ */
9170
9635
  describeDBClusterAccessWhitelist(request: DescribeDBClusterAccessWhitelistRequest): Promise<DescribeDBClusterAccessWhitelistResponse>;
9636
+ /**
9637
+ * @summary Queries information about a PolarDB cluster.
9638
+ *
9639
+ * @param request DescribeDBClusterAttributeRequest
9640
+ * @param runtime runtime options for this request RuntimeOptions
9641
+ * @return DescribeDBClusterAttributeResponse
9642
+ */
9171
9643
  describeDBClusterAttributeWithOptions(request: DescribeDBClusterAttributeRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBClusterAttributeResponse>;
9644
+ /**
9645
+ * @summary Queries information about a PolarDB cluster.
9646
+ *
9647
+ * @param request DescribeDBClusterAttributeRequest
9648
+ * @return DescribeDBClusterAttributeResponse
9649
+ */
9172
9650
  describeDBClusterAttribute(request: DescribeDBClusterAttributeRequest): Promise<DescribeDBClusterAttributeResponse>;
9651
+ /**
9652
+ * @summary Describe SQL collector for a PolarDB cluster. Features related to SQL collector include audit log and SQL Explorer.
9653
+ *
9654
+ * @param request DescribeDBClusterAuditLogCollectorRequest
9655
+ * @param runtime runtime options for this request RuntimeOptions
9656
+ * @return DescribeDBClusterAuditLogCollectorResponse
9657
+ */
9173
9658
  describeDBClusterAuditLogCollectorWithOptions(request: DescribeDBClusterAuditLogCollectorRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBClusterAuditLogCollectorResponse>;
9659
+ /**
9660
+ * @summary Describe SQL collector for a PolarDB cluster. Features related to SQL collector include audit log and SQL Explorer.
9661
+ *
9662
+ * @param request DescribeDBClusterAuditLogCollectorRequest
9663
+ * @return DescribeDBClusterAuditLogCollectorResponse
9664
+ */
9174
9665
  describeDBClusterAuditLogCollector(request: DescribeDBClusterAuditLogCollectorRequest): Promise<DescribeDBClusterAuditLogCollectorResponse>;
9666
+ /**
9667
+ * @summary Queries available resources in a PolarDB cluster.
9668
+ *
9669
+ * @param request DescribeDBClusterAvailableResourcesRequest
9670
+ * @param runtime runtime options for this request RuntimeOptions
9671
+ * @return DescribeDBClusterAvailableResourcesResponse
9672
+ */
9175
9673
  describeDBClusterAvailableResourcesWithOptions(request: DescribeDBClusterAvailableResourcesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBClusterAvailableResourcesResponse>;
9674
+ /**
9675
+ * @summary Queries available resources in a PolarDB cluster.
9676
+ *
9677
+ * @param request DescribeDBClusterAvailableResourcesRequest
9678
+ * @return DescribeDBClusterAvailableResourcesResponse
9679
+ */
9176
9680
  describeDBClusterAvailableResources(request: DescribeDBClusterAvailableResourcesRequest): Promise<DescribeDBClusterAvailableResourcesResponse>;
9681
+ /**
9682
+ * @summary Queries whether the source IP address can access a cluster.
9683
+ *
9684
+ * @param request DescribeDBClusterConnectivityRequest
9685
+ * @param runtime runtime options for this request RuntimeOptions
9686
+ * @return DescribeDBClusterConnectivityResponse
9687
+ */
9177
9688
  describeDBClusterConnectivityWithOptions(request: DescribeDBClusterConnectivityRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBClusterConnectivityResponse>;
9689
+ /**
9690
+ * @summary Queries whether the source IP address can access a cluster.
9691
+ *
9692
+ * @param request DescribeDBClusterConnectivityRequest
9693
+ * @return DescribeDBClusterConnectivityResponse
9694
+ */
9178
9695
  describeDBClusterConnectivity(request: DescribeDBClusterConnectivityRequest): Promise<DescribeDBClusterConnectivityResponse>;
9696
+ /**
9697
+ * @summary Queries the endpoints of a PolarDB cluster.
9698
+ *
9699
+ * @param request DescribeDBClusterEndpointsRequest
9700
+ * @param runtime runtime options for this request RuntimeOptions
9701
+ * @return DescribeDBClusterEndpointsResponse
9702
+ */
9179
9703
  describeDBClusterEndpointsWithOptions(request: DescribeDBClusterEndpointsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBClusterEndpointsResponse>;
9704
+ /**
9705
+ * @summary Queries the endpoints of a PolarDB cluster.
9706
+ *
9707
+ * @param request DescribeDBClusterEndpointsRequest
9708
+ * @return DescribeDBClusterEndpointsResponse
9709
+ */
9180
9710
  describeDBClusterEndpoints(request: DescribeDBClusterEndpointsRequest): Promise<DescribeDBClusterEndpointsResponse>;
9181
9711
  /**
9182
- * * You can call this operation to query the status of data migration from an ApsaraDB RDS instance to a PolarDB cluster. For more information, see [Upgrade ApsaraDB RDS for MySQL to PolarDB for MySQL with one click](~~121582~~).
9183
- * * Before you call this operation, make sure that a one-click upgrade task has been created for the cluster. You can call the [CreateDBCluster](~~98169~~) operation to create an upgrade task. Set the **CreationOption** parameter to **MigrationFromRDS**.
9184
- *
9185
- * @param request DescribeDBClusterMigrationRequest
9186
- * @param runtime runtime options for this request RuntimeOptions
9187
- * @return DescribeDBClusterMigrationResponse
9712
+ * @summary Queries the migration status of PolarDB clusters.
9713
+ *
9714
+ * @description * You can call this operation to query the status of data migration from an ApsaraDB RDS instance to a PolarDB cluster. For more information, see [Upgrade ApsaraDB RDS for MySQL to PolarDB for MySQL with one click](https://help.aliyun.com/document_detail/121582.html).
9715
+ * * Before you call this operation, make sure that a one-click upgrade task has been created for the cluster. You can call the [CreateDBCluster](https://help.aliyun.com/document_detail/98169.html) operation to create an upgrade task. Set the **CreationOption** parameter to **MigrationFromRDS**.
9716
+ *
9717
+ * @param request DescribeDBClusterMigrationRequest
9718
+ * @param runtime runtime options for this request RuntimeOptions
9719
+ * @return DescribeDBClusterMigrationResponse
9188
9720
  */
9189
9721
  describeDBClusterMigrationWithOptions(request: DescribeDBClusterMigrationRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBClusterMigrationResponse>;
9190
9722
  /**
9191
- * * You can call this operation to query the status of data migration from an ApsaraDB RDS instance to a PolarDB cluster. For more information, see [Upgrade ApsaraDB RDS for MySQL to PolarDB for MySQL with one click](~~121582~~).
9192
- * * Before you call this operation, make sure that a one-click upgrade task has been created for the cluster. You can call the [CreateDBCluster](~~98169~~) operation to create an upgrade task. Set the **CreationOption** parameter to **MigrationFromRDS**.
9193
- *
9194
- * @param request DescribeDBClusterMigrationRequest
9195
- * @return DescribeDBClusterMigrationResponse
9723
+ * @summary Queries the migration status of PolarDB clusters.
9724
+ *
9725
+ * @description * You can call this operation to query the status of data migration from an ApsaraDB RDS instance to a PolarDB cluster. For more information, see [Upgrade ApsaraDB RDS for MySQL to PolarDB for MySQL with one click](https://help.aliyun.com/document_detail/121582.html).
9726
+ * * Before you call this operation, make sure that a one-click upgrade task has been created for the cluster. You can call the [CreateDBCluster](https://help.aliyun.com/document_detail/98169.html) operation to create an upgrade task. Set the **CreationOption** parameter to **MigrationFromRDS**.
9727
+ *
9728
+ * @param request DescribeDBClusterMigrationRequest
9729
+ * @return DescribeDBClusterMigrationResponse
9196
9730
  */
9197
9731
  describeDBClusterMigration(request: DescribeDBClusterMigrationRequest): Promise<DescribeDBClusterMigrationResponse>;
9732
+ /**
9733
+ * @summary Queries the interval at which the monitoring data of a PolarDB cluster is collected.
9734
+ *
9735
+ * @param request DescribeDBClusterMonitorRequest
9736
+ * @param runtime runtime options for this request RuntimeOptions
9737
+ * @return DescribeDBClusterMonitorResponse
9738
+ */
9198
9739
  describeDBClusterMonitorWithOptions(request: DescribeDBClusterMonitorRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBClusterMonitorResponse>;
9740
+ /**
9741
+ * @summary Queries the interval at which the monitoring data of a PolarDB cluster is collected.
9742
+ *
9743
+ * @param request DescribeDBClusterMonitorRequest
9744
+ * @return DescribeDBClusterMonitorResponse
9745
+ */
9199
9746
  describeDBClusterMonitor(request: DescribeDBClusterMonitorRequest): Promise<DescribeDBClusterMonitorResponse>;
9747
+ /**
9748
+ * @summary Queries the parameters of a PolarDB cluster.
9749
+ *
9750
+ * @param request DescribeDBClusterParametersRequest
9751
+ * @param runtime runtime options for this request RuntimeOptions
9752
+ * @return DescribeDBClusterParametersResponse
9753
+ */
9200
9754
  describeDBClusterParametersWithOptions(request: DescribeDBClusterParametersRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBClusterParametersResponse>;
9755
+ /**
9756
+ * @summary Queries the parameters of a PolarDB cluster.
9757
+ *
9758
+ * @param request DescribeDBClusterParametersRequest
9759
+ * @return DescribeDBClusterParametersResponse
9760
+ */
9201
9761
  describeDBClusterParameters(request: DescribeDBClusterParametersRequest): Promise<DescribeDBClusterParametersResponse>;
9202
9762
  /**
9203
- * * When the monitoring data is collected every 5 seconds:
9204
- * * If the query time range is less than or equal to 1 hour, the data is displayed at intervals of 5 seconds.
9205
- * * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.
9206
- * * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.
9207
- * * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.
9208
- * * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.
9209
- * * When the monitoring data is collected every 60 seconds:
9210
- * * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.
9211
- * * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.
9212
- * * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.
9213
- * * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.
9214
- * > By default, the monitoring data is collected once every 60 seconds. You can call the [ModifyDBClusterMonitor](~~159557~~) operation to set the data collection interval to every 5 seconds.
9215
- *
9216
- * @param request DescribeDBClusterPerformanceRequest
9217
- * @param runtime runtime options for this request RuntimeOptions
9218
- * @return DescribeDBClusterPerformanceResponse
9763
+ * @summary Queries the performance data of a PolarDB cluster.
9764
+ *
9765
+ * @description * When the monitoring data is collected every 5 seconds:
9766
+ * * If the query time range is less than or equal to 1 hour, the data is displayed at intervals of 5 seconds.
9767
+ * * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.
9768
+ * * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.
9769
+ * * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.
9770
+ * * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.
9771
+ * * When the monitoring data is collected every 60 seconds:
9772
+ * * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.
9773
+ * * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.
9774
+ * * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.
9775
+ * * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.
9776
+ * > By default, the monitoring data is collected once every 60 seconds. You can call the [ModifyDBClusterMonitor](https://help.aliyun.com/document_detail/159557.html) operation to set the data collection interval to every 5 seconds.
9777
+ *
9778
+ * @param request DescribeDBClusterPerformanceRequest
9779
+ * @param runtime runtime options for this request RuntimeOptions
9780
+ * @return DescribeDBClusterPerformanceResponse
9219
9781
  */
9220
9782
  describeDBClusterPerformanceWithOptions(request: DescribeDBClusterPerformanceRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBClusterPerformanceResponse>;
9221
9783
  /**
9222
- * * When the monitoring data is collected every 5 seconds:
9223
- * * If the query time range is less than or equal to 1 hour, the data is displayed at intervals of 5 seconds.
9224
- * * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.
9225
- * * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.
9226
- * * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.
9227
- * * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.
9228
- * * When the monitoring data is collected every 60 seconds:
9229
- * * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.
9230
- * * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.
9231
- * * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.
9232
- * * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.
9233
- * > By default, the monitoring data is collected once every 60 seconds. You can call the [ModifyDBClusterMonitor](~~159557~~) operation to set the data collection interval to every 5 seconds.
9234
- *
9235
- * @param request DescribeDBClusterPerformanceRequest
9236
- * @return DescribeDBClusterPerformanceResponse
9784
+ * @summary Queries the performance data of a PolarDB cluster.
9785
+ *
9786
+ * @description * When the monitoring data is collected every 5 seconds:
9787
+ * * If the query time range is less than or equal to 1 hour, the data is displayed at intervals of 5 seconds.
9788
+ * * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.
9789
+ * * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.
9790
+ * * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.
9791
+ * * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.
9792
+ * * When the monitoring data is collected every 60 seconds:
9793
+ * * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.
9794
+ * * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.
9795
+ * * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.
9796
+ * * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.
9797
+ * > By default, the monitoring data is collected once every 60 seconds. You can call the [ModifyDBClusterMonitor](https://help.aliyun.com/document_detail/159557.html) operation to set the data collection interval to every 5 seconds.
9798
+ *
9799
+ * @param request DescribeDBClusterPerformanceRequest
9800
+ * @return DescribeDBClusterPerformanceResponse
9237
9801
  */
9238
9802
  describeDBClusterPerformance(request: DescribeDBClusterPerformanceRequest): Promise<DescribeDBClusterPerformanceResponse>;
9803
+ /**
9804
+ * @summary Queries the Secure Sockets Layer (SSL) settings of a PolarDB cluster.
9805
+ *
9806
+ * @param request DescribeDBClusterSSLRequest
9807
+ * @param runtime runtime options for this request RuntimeOptions
9808
+ * @return DescribeDBClusterSSLResponse
9809
+ */
9239
9810
  describeDBClusterSSLWithOptions(request: DescribeDBClusterSSLRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBClusterSSLResponse>;
9811
+ /**
9812
+ * @summary Queries the Secure Sockets Layer (SSL) settings of a PolarDB cluster.
9813
+ *
9814
+ * @param request DescribeDBClusterSSLRequest
9815
+ * @return DescribeDBClusterSSLResponse
9816
+ */
9240
9817
  describeDBClusterSSL(request: DescribeDBClusterSSLRequest): Promise<DescribeDBClusterSSLResponse>;
9818
+ /**
9819
+ * @summary Queries the configurations of a serverless cluster.
9820
+ *
9821
+ * @param request DescribeDBClusterServerlessConfRequest
9822
+ * @param runtime runtime options for this request RuntimeOptions
9823
+ * @return DescribeDBClusterServerlessConfResponse
9824
+ */
9241
9825
  describeDBClusterServerlessConfWithOptions(request: DescribeDBClusterServerlessConfRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBClusterServerlessConfResponse>;
9826
+ /**
9827
+ * @summary Queries the configurations of a serverless cluster.
9828
+ *
9829
+ * @param request DescribeDBClusterServerlessConfRequest
9830
+ * @return DescribeDBClusterServerlessConfResponse
9831
+ */
9242
9832
  describeDBClusterServerlessConf(request: DescribeDBClusterServerlessConfRequest): Promise<DescribeDBClusterServerlessConfResponse>;
9833
+ /**
9834
+ * @summary Queries the Transparent Data Encryption (TDE) settings of a PolarDB for MySQL cluster.
9835
+ *
9836
+ * @param request DescribeDBClusterTDERequest
9837
+ * @param runtime runtime options for this request RuntimeOptions
9838
+ * @return DescribeDBClusterTDEResponse
9839
+ */
9243
9840
  describeDBClusterTDEWithOptions(request: DescribeDBClusterTDERequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBClusterTDEResponse>;
9841
+ /**
9842
+ * @summary Queries the Transparent Data Encryption (TDE) settings of a PolarDB for MySQL cluster.
9843
+ *
9844
+ * @param request DescribeDBClusterTDERequest
9845
+ * @return DescribeDBClusterTDEResponse
9846
+ */
9244
9847
  describeDBClusterTDE(request: DescribeDBClusterTDERequest): Promise<DescribeDBClusterTDEResponse>;
9848
+ /**
9849
+ * @summary Queries the information about the database engine version of a PolarDB for MySQL cluster.
9850
+ *
9851
+ * @param request DescribeDBClusterVersionRequest
9852
+ * @param runtime runtime options for this request RuntimeOptions
9853
+ * @return DescribeDBClusterVersionResponse
9854
+ */
9245
9855
  describeDBClusterVersionWithOptions(request: DescribeDBClusterVersionRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBClusterVersionResponse>;
9856
+ /**
9857
+ * @summary Queries the information about the database engine version of a PolarDB for MySQL cluster.
9858
+ *
9859
+ * @param request DescribeDBClusterVersionRequest
9860
+ * @return DescribeDBClusterVersionResponse
9861
+ */
9246
9862
  describeDBClusterVersion(request: DescribeDBClusterVersionRequest): Promise<DescribeDBClusterVersionResponse>;
9863
+ /**
9864
+ * @summary Queries PolarDB clusters or the clusters that can be accessed by an authorized RAM user.
9865
+ *
9866
+ * @param request DescribeDBClustersRequest
9867
+ * @param runtime runtime options for this request RuntimeOptions
9868
+ * @return DescribeDBClustersResponse
9869
+ */
9247
9870
  describeDBClustersWithOptions(request: DescribeDBClustersRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBClustersResponse>;
9871
+ /**
9872
+ * @summary Queries PolarDB clusters or the clusters that can be accessed by an authorized RAM user.
9873
+ *
9874
+ * @param request DescribeDBClustersRequest
9875
+ * @return DescribeDBClustersResponse
9876
+ */
9248
9877
  describeDBClusters(request: DescribeDBClustersRequest): Promise<DescribeDBClustersResponse>;
9878
+ /**
9879
+ * @summary Queries the information about PolarDB clusters that contain backup sets in a region.
9880
+ *
9881
+ * @param request DescribeDBClustersWithBackupsRequest
9882
+ * @param runtime runtime options for this request RuntimeOptions
9883
+ * @return DescribeDBClustersWithBackupsResponse
9884
+ */
9249
9885
  describeDBClustersWithBackupsWithOptions(request: DescribeDBClustersWithBackupsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBClustersWithBackupsResponse>;
9886
+ /**
9887
+ * @summary Queries the information about PolarDB clusters that contain backup sets in a region.
9888
+ *
9889
+ * @param request DescribeDBClustersWithBackupsRequest
9890
+ * @return DescribeDBClustersWithBackupsResponse
9891
+ */
9250
9892
  describeDBClustersWithBackups(request: DescribeDBClustersWithBackupsRequest): Promise<DescribeDBClustersWithBackupsResponse>;
9893
+ /**
9894
+ * @summary Queries the attributes that are supported by a PolarDB for PostgreSQL (Compatible with Oracle) cluster or a PolarDB for PostgreSQL cluster, such as the character sets and collations.
9895
+ *
9896
+ * @param request DescribeDBInitializeVariableRequest
9897
+ * @param runtime runtime options for this request RuntimeOptions
9898
+ * @return DescribeDBInitializeVariableResponse
9899
+ */
9251
9900
  describeDBInitializeVariableWithOptions(request: DescribeDBInitializeVariableRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBInitializeVariableResponse>;
9901
+ /**
9902
+ * @summary Queries the attributes that are supported by a PolarDB for PostgreSQL (Compatible with Oracle) cluster or a PolarDB for PostgreSQL cluster, such as the character sets and collations.
9903
+ *
9904
+ * @param request DescribeDBInitializeVariableRequest
9905
+ * @return DescribeDBInitializeVariableResponse
9906
+ */
9252
9907
  describeDBInitializeVariable(request: DescribeDBInitializeVariableRequest): Promise<DescribeDBInitializeVariableResponse>;
9253
9908
  /**
9254
- * > You can query only the database links that use a PolarDB for Oracle cluster as the source.
9255
- *
9256
- * @param request DescribeDBLinksRequest
9257
- * @param runtime runtime options for this request RuntimeOptions
9258
- * @return DescribeDBLinksResponse
9909
+ * @summary Queries the database links of a PolarDB for PostgreSQL (Compatible with Oracle) cluster.
9910
+ *
9911
+ * @description > You can query only the database links that use a PolarDB for Oracle cluster as the source.
9912
+ *
9913
+ * @param request DescribeDBLinksRequest
9914
+ * @param runtime runtime options for this request RuntimeOptions
9915
+ * @return DescribeDBLinksResponse
9259
9916
  */
9260
9917
  describeDBLinksWithOptions(request: DescribeDBLinksRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBLinksResponse>;
9261
9918
  /**
9262
- * > You can query only the database links that use a PolarDB for Oracle cluster as the source.
9263
- *
9264
- * @param request DescribeDBLinksRequest
9265
- * @return DescribeDBLinksResponse
9919
+ * @summary Queries the database links of a PolarDB for PostgreSQL (Compatible with Oracle) cluster.
9920
+ *
9921
+ * @description > You can query only the database links that use a PolarDB for Oracle cluster as the source.
9922
+ *
9923
+ * @param request DescribeDBLinksRequest
9924
+ * @return DescribeDBLinksResponse
9266
9925
  */
9267
9926
  describeDBLinks(request: DescribeDBLinksRequest): Promise<DescribeDBLinksResponse>;
9268
9927
  /**
9269
- * * When the monitoring data is collected every 5 seconds:
9270
- * * If the query time range is less than or equal to 1 hour, the data is displayed at intervals of 5 seconds.
9271
- * * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.
9272
- * * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.
9273
- * * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.
9274
- * * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.
9275
- * * When the monitoring data is collected every 60 seconds:
9276
- * * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.
9277
- * * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.
9278
- * * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.
9279
- * * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.
9280
- * > By default, the monitoring data is collected once every 60 seconds. You can call the [ModifyDBClusterMonitor](~~159557~~) operation to set the data collection interval to every 5 seconds.
9281
- *
9282
- * @param request DescribeDBNodePerformanceRequest
9283
- * @param runtime runtime options for this request RuntimeOptions
9284
- * @return DescribeDBNodePerformanceResponse
9928
+ * @summary Queries the performance data of a node in a PolarDB cluster.
9929
+ *
9930
+ * @description * When the monitoring data is collected every 5 seconds:
9931
+ * * If the query time range is less than or equal to 1 hour, the data is displayed at intervals of 5 seconds.
9932
+ * * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.
9933
+ * * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.
9934
+ * * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.
9935
+ * * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.
9936
+ * * When the monitoring data is collected every 60 seconds:
9937
+ * * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.
9938
+ * * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.
9939
+ * * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.
9940
+ * * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.
9941
+ * > By default, the monitoring data is collected once every 60 seconds. You can call the [ModifyDBClusterMonitor](https://help.aliyun.com/document_detail/159557.html) operation to set the data collection interval to every 5 seconds.
9942
+ *
9943
+ * @param request DescribeDBNodePerformanceRequest
9944
+ * @param runtime runtime options for this request RuntimeOptions
9945
+ * @return DescribeDBNodePerformanceResponse
9285
9946
  */
9286
9947
  describeDBNodePerformanceWithOptions(request: DescribeDBNodePerformanceRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBNodePerformanceResponse>;
9287
9948
  /**
9288
- * * When the monitoring data is collected every 5 seconds:
9289
- * * If the query time range is less than or equal to 1 hour, the data is displayed at intervals of 5 seconds.
9290
- * * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.
9291
- * * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.
9292
- * * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.
9293
- * * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.
9294
- * * When the monitoring data is collected every 60 seconds:
9295
- * * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.
9296
- * * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.
9297
- * * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.
9298
- * * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.
9299
- * > By default, the monitoring data is collected once every 60 seconds. You can call the [ModifyDBClusterMonitor](~~159557~~) operation to set the data collection interval to every 5 seconds.
9300
- *
9301
- * @param request DescribeDBNodePerformanceRequest
9302
- * @return DescribeDBNodePerformanceResponse
9949
+ * @summary Queries the performance data of a node in a PolarDB cluster.
9950
+ *
9951
+ * @description * When the monitoring data is collected every 5 seconds:
9952
+ * * If the query time range is less than or equal to 1 hour, the data is displayed at intervals of 5 seconds.
9953
+ * * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.
9954
+ * * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.
9955
+ * * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.
9956
+ * * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.
9957
+ * * When the monitoring data is collected every 60 seconds:
9958
+ * * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.
9959
+ * * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.
9960
+ * * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.
9961
+ * * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.
9962
+ * > By default, the monitoring data is collected once every 60 seconds. You can call the [ModifyDBClusterMonitor](https://help.aliyun.com/document_detail/159557.html) operation to set the data collection interval to every 5 seconds.
9963
+ *
9964
+ * @param request DescribeDBNodePerformanceRequest
9965
+ * @return DescribeDBNodePerformanceResponse
9303
9966
  */
9304
9967
  describeDBNodePerformance(request: DescribeDBNodePerformanceRequest): Promise<DescribeDBNodePerformanceResponse>;
9968
+ /**
9969
+ * @summary Queries the parameters of a specified node in a cluster.
9970
+ *
9971
+ * @param request DescribeDBNodesParametersRequest
9972
+ * @param runtime runtime options for this request RuntimeOptions
9973
+ * @return DescribeDBNodesParametersResponse
9974
+ */
9305
9975
  describeDBNodesParametersWithOptions(request: DescribeDBNodesParametersRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBNodesParametersResponse>;
9976
+ /**
9977
+ * @summary Queries the parameters of a specified node in a cluster.
9978
+ *
9979
+ * @param request DescribeDBNodesParametersRequest
9980
+ * @return DescribeDBNodesParametersResponse
9981
+ */
9306
9982
  describeDBNodesParameters(request: DescribeDBNodesParametersRequest): Promise<DescribeDBNodesParametersResponse>;
9307
9983
  /**
9308
- * > This operation is applicable only to PolarDB for MySQL clusters.
9309
- *
9310
- * @param request DescribeDBProxyPerformanceRequest
9311
- * @param runtime runtime options for this request RuntimeOptions
9312
- * @return DescribeDBProxyPerformanceResponse
9984
+ * @summary Queries the performance data of PolarProxy.
9985
+ *
9986
+ * @description > This operation is applicable only to PolarDB for MySQL clusters.
9987
+ *
9988
+ * @param request DescribeDBProxyPerformanceRequest
9989
+ * @param runtime runtime options for this request RuntimeOptions
9990
+ * @return DescribeDBProxyPerformanceResponse
9313
9991
  */
9314
9992
  describeDBProxyPerformanceWithOptions(request: DescribeDBProxyPerformanceRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBProxyPerformanceResponse>;
9315
9993
  /**
9316
- * > This operation is applicable only to PolarDB for MySQL clusters.
9317
- *
9318
- * @param request DescribeDBProxyPerformanceRequest
9319
- * @return DescribeDBProxyPerformanceResponse
9994
+ * @summary Queries the performance data of PolarProxy.
9995
+ *
9996
+ * @description > This operation is applicable only to PolarDB for MySQL clusters.
9997
+ *
9998
+ * @param request DescribeDBProxyPerformanceRequest
9999
+ * @return DescribeDBProxyPerformanceResponse
9320
10000
  */
9321
10001
  describeDBProxyPerformance(request: DescribeDBProxyPerformanceRequest): Promise<DescribeDBProxyPerformanceResponse>;
10002
+ /**
10003
+ * @summary 查看实例的 DAS 配置
10004
+ *
10005
+ * @param request DescribeDasConfigRequest
10006
+ * @param runtime runtime options for this request RuntimeOptions
10007
+ * @return DescribeDasConfigResponse
10008
+ */
9322
10009
  describeDasConfigWithOptions(request: DescribeDasConfigRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDasConfigResponse>;
10010
+ /**
10011
+ * @summary 查看实例的 DAS 配置
10012
+ *
10013
+ * @param request DescribeDasConfigRequest
10014
+ * @return DescribeDasConfigResponse
10015
+ */
9323
10016
  describeDasConfig(request: DescribeDasConfigRequest): Promise<DescribeDasConfigResponse>;
10017
+ /**
10018
+ * @summary Queries the information about databases in a PolarDB cluster.
10019
+ *
10020
+ * @param request DescribeDatabasesRequest
10021
+ * @param runtime runtime options for this request RuntimeOptions
10022
+ * @return DescribeDatabasesResponse
10023
+ */
9324
10024
  describeDatabasesWithOptions(request: DescribeDatabasesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDatabasesResponse>;
10025
+ /**
10026
+ * @summary Queries the information about databases in a PolarDB cluster.
10027
+ *
10028
+ * @param request DescribeDatabasesRequest
10029
+ * @return DescribeDatabasesResponse
10030
+ */
9325
10031
  describeDatabases(request: DescribeDatabasesRequest): Promise<DescribeDatabasesResponse>;
9326
10032
  /**
9327
- * Before you call this operation, make sure that the PolarDB cluster is in the **Released** state. You must also confirm that the **Retain All Backups Permanently** or **Retain Last Automatic Backup Permanently** backup retention policy takes effect after you release the cluster. If you delete all backup sets after the cluster is released, you cannot use this API operation to query the cluster.
9328
- * > You can call the [DescribeDBClusterAttribute](~~98181~~) operation to query the cluster status.
9329
- *
9330
- * @param request DescribeDetachedBackupsRequest
9331
- * @param runtime runtime options for this request RuntimeOptions
9332
- * @return DescribeDetachedBackupsResponse
10033
+ * @summary Queries the information about the backup sets in a released PolarDB cluster.
10034
+ *
10035
+ * @description Before you call this operation, make sure that the PolarDB cluster is in the **Released** state. You must also confirm that the **Retain All Backups Permanently** or **Retain Last Automatic Backup Permanently** backup retention policy takes effect after you release the cluster. If you delete all backup sets after the cluster is released, you cannot use this API operation to query the cluster.
10036
+ * > You can call the [DescribeDBClusterAttribute](https://help.aliyun.com/document_detail/98181.html) operation to query the cluster status.
10037
+ *
10038
+ * @param request DescribeDetachedBackupsRequest
10039
+ * @param runtime runtime options for this request RuntimeOptions
10040
+ * @return DescribeDetachedBackupsResponse
9333
10041
  */
9334
10042
  describeDetachedBackupsWithOptions(request: DescribeDetachedBackupsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDetachedBackupsResponse>;
9335
10043
  /**
9336
- * Before you call this operation, make sure that the PolarDB cluster is in the **Released** state. You must also confirm that the **Retain All Backups Permanently** or **Retain Last Automatic Backup Permanently** backup retention policy takes effect after you release the cluster. If you delete all backup sets after the cluster is released, you cannot use this API operation to query the cluster.
9337
- * > You can call the [DescribeDBClusterAttribute](~~98181~~) operation to query the cluster status.
9338
- *
9339
- * @param request DescribeDetachedBackupsRequest
9340
- * @return DescribeDetachedBackupsResponse
10044
+ * @summary Queries the information about the backup sets in a released PolarDB cluster.
10045
+ *
10046
+ * @description Before you call this operation, make sure that the PolarDB cluster is in the **Released** state. You must also confirm that the **Retain All Backups Permanently** or **Retain Last Automatic Backup Permanently** backup retention policy takes effect after you release the cluster. If you delete all backup sets after the cluster is released, you cannot use this API operation to query the cluster.
10047
+ * > You can call the [DescribeDBClusterAttribute](https://help.aliyun.com/document_detail/98181.html) operation to query the cluster status.
10048
+ *
10049
+ * @param request DescribeDetachedBackupsRequest
10050
+ * @return DescribeDetachedBackupsResponse
9341
10051
  */
9342
10052
  describeDetachedBackups(request: DescribeDetachedBackupsRequest): Promise<DescribeDetachedBackupsResponse>;
10053
+ /**
10054
+ * @summary Queries the information about a Global Database Network (GDN).
10055
+ *
10056
+ * @param request DescribeGlobalDatabaseNetworkRequest
10057
+ * @param runtime runtime options for this request RuntimeOptions
10058
+ * @return DescribeGlobalDatabaseNetworkResponse
10059
+ */
9343
10060
  describeGlobalDatabaseNetworkWithOptions(request: DescribeGlobalDatabaseNetworkRequest, runtime: $Util.RuntimeOptions): Promise<DescribeGlobalDatabaseNetworkResponse>;
10061
+ /**
10062
+ * @summary Queries the information about a Global Database Network (GDN).
10063
+ *
10064
+ * @param request DescribeGlobalDatabaseNetworkRequest
10065
+ * @return DescribeGlobalDatabaseNetworkResponse
10066
+ */
9344
10067
  describeGlobalDatabaseNetwork(request: DescribeGlobalDatabaseNetworkRequest): Promise<DescribeGlobalDatabaseNetworkResponse>;
10068
+ /**
10069
+ * @summary Queries the information about all Global Database Networks (GDNs) that belong to an account.
10070
+ *
10071
+ * @param request DescribeGlobalDatabaseNetworksRequest
10072
+ * @param runtime runtime options for this request RuntimeOptions
10073
+ * @return DescribeGlobalDatabaseNetworksResponse
10074
+ */
9345
10075
  describeGlobalDatabaseNetworksWithOptions(request: DescribeGlobalDatabaseNetworksRequest, runtime: $Util.RuntimeOptions): Promise<DescribeGlobalDatabaseNetworksResponse>;
10076
+ /**
10077
+ * @summary Queries the information about all Global Database Networks (GDNs) that belong to an account.
10078
+ *
10079
+ * @param request DescribeGlobalDatabaseNetworksRequest
10080
+ * @return DescribeGlobalDatabaseNetworksResponse
10081
+ */
9346
10082
  describeGlobalDatabaseNetworks(request: DescribeGlobalDatabaseNetworksRequest): Promise<DescribeGlobalDatabaseNetworksResponse>;
10083
+ /**
10084
+ * @summary Queries global IP whitelist templates.
10085
+ *
10086
+ * @param request DescribeGlobalSecurityIPGroupRequest
10087
+ * @param runtime runtime options for this request RuntimeOptions
10088
+ * @return DescribeGlobalSecurityIPGroupResponse
10089
+ */
9347
10090
  describeGlobalSecurityIPGroupWithOptions(request: DescribeGlobalSecurityIPGroupRequest, runtime: $Util.RuntimeOptions): Promise<DescribeGlobalSecurityIPGroupResponse>;
10091
+ /**
10092
+ * @summary Queries global IP whitelist templates.
10093
+ *
10094
+ * @param request DescribeGlobalSecurityIPGroupRequest
10095
+ * @return DescribeGlobalSecurityIPGroupResponse
10096
+ */
9348
10097
  describeGlobalSecurityIPGroup(request: DescribeGlobalSecurityIPGroupRequest): Promise<DescribeGlobalSecurityIPGroupResponse>;
10098
+ /**
10099
+ * @summary Queries the relationship between a cluster and a global IP whitelist template.
10100
+ *
10101
+ * @param request DescribeGlobalSecurityIPGroupRelationRequest
10102
+ * @param runtime runtime options for this request RuntimeOptions
10103
+ * @return DescribeGlobalSecurityIPGroupRelationResponse
10104
+ */
9349
10105
  describeGlobalSecurityIPGroupRelationWithOptions(request: DescribeGlobalSecurityIPGroupRelationRequest, runtime: $Util.RuntimeOptions): Promise<DescribeGlobalSecurityIPGroupRelationResponse>;
10106
+ /**
10107
+ * @summary Queries the relationship between a cluster and a global IP whitelist template.
10108
+ *
10109
+ * @param request DescribeGlobalSecurityIPGroupRelationRequest
10110
+ * @return DescribeGlobalSecurityIPGroupRelationResponse
10111
+ */
9350
10112
  describeGlobalSecurityIPGroupRelation(request: DescribeGlobalSecurityIPGroupRelationRequest): Promise<DescribeGlobalSecurityIPGroupRelationResponse>;
10113
+ /**
10114
+ * @summary Queries the retention policy of log backups in a PolarDB cluster.
10115
+ *
10116
+ * @param request DescribeLogBackupPolicyRequest
10117
+ * @param runtime runtime options for this request RuntimeOptions
10118
+ * @return DescribeLogBackupPolicyResponse
10119
+ */
9351
10120
  describeLogBackupPolicyWithOptions(request: DescribeLogBackupPolicyRequest, runtime: $Util.RuntimeOptions): Promise<DescribeLogBackupPolicyResponse>;
10121
+ /**
10122
+ * @summary Queries the retention policy of log backups in a PolarDB cluster.
10123
+ *
10124
+ * @param request DescribeLogBackupPolicyRequest
10125
+ * @return DescribeLogBackupPolicyResponse
10126
+ */
9352
10127
  describeLogBackupPolicy(request: DescribeLogBackupPolicyRequest): Promise<DescribeLogBackupPolicyResponse>;
10128
+ /**
10129
+ * @summary Queries the data masking rules of a PolarDB cluster or the information about a specified masking rule.
10130
+ *
10131
+ * @param request DescribeMaskingRulesRequest
10132
+ * @param runtime runtime options for this request RuntimeOptions
10133
+ * @return DescribeMaskingRulesResponse
10134
+ */
9353
10135
  describeMaskingRulesWithOptions(request: DescribeMaskingRulesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeMaskingRulesResponse>;
10136
+ /**
10137
+ * @summary Queries the data masking rules of a PolarDB cluster or the information about a specified masking rule.
10138
+ *
10139
+ * @param request DescribeMaskingRulesRequest
10140
+ * @return DescribeMaskingRulesResponse
10141
+ */
9354
10142
  describeMaskingRules(request: DescribeMaskingRulesRequest): Promise<DescribeMaskingRulesResponse>;
10143
+ /**
10144
+ * @summary Queries the details of the databases or tables that can be restored.
10145
+ *
10146
+ * @param request DescribeMetaListRequest
10147
+ * @param runtime runtime options for this request RuntimeOptions
10148
+ * @return DescribeMetaListResponse
10149
+ */
9355
10150
  describeMetaListWithOptions(request: DescribeMetaListRequest, runtime: $Util.RuntimeOptions): Promise<DescribeMetaListResponse>;
10151
+ /**
10152
+ * @summary Queries the details of the databases or tables that can be restored.
10153
+ *
10154
+ * @param request DescribeMetaListRequest
10155
+ * @return DescribeMetaListResponse
10156
+ */
9356
10157
  describeMetaList(request: DescribeMetaListRequest): Promise<DescribeMetaListResponse>;
9357
10158
  /**
9358
- * You can use parameter templates to manage multiple parameters at a time and apply existing parameters to a PolarDB cluster. For more information, see [Use a parameter template](~~207009~~).
9359
- * > This parameter is valid only for a PolarDB for MySQL cluster.
9360
- *
9361
- * @param request DescribeParameterGroupRequest
9362
- * @param runtime runtime options for this request RuntimeOptions
9363
- * @return DescribeParameterGroupResponse
10159
+ * @summary Queries the information about a parameter template.
10160
+ *
10161
+ * @description You can use parameter templates to manage multiple parameters at a time and apply existing parameters to a PolarDB cluster. For more information, see [Use a parameter template](https://help.aliyun.com/document_detail/207009.html).
10162
+ * > This parameter is valid only for a PolarDB for MySQL cluster.
10163
+ *
10164
+ * @param request DescribeParameterGroupRequest
10165
+ * @param runtime runtime options for this request RuntimeOptions
10166
+ * @return DescribeParameterGroupResponse
9364
10167
  */
9365
10168
  describeParameterGroupWithOptions(request: DescribeParameterGroupRequest, runtime: $Util.RuntimeOptions): Promise<DescribeParameterGroupResponse>;
9366
10169
  /**
9367
- * You can use parameter templates to manage multiple parameters at a time and apply existing parameters to a PolarDB cluster. For more information, see [Use a parameter template](~~207009~~).
9368
- * > This parameter is valid only for a PolarDB for MySQL cluster.
9369
- *
9370
- * @param request DescribeParameterGroupRequest
9371
- * @return DescribeParameterGroupResponse
10170
+ * @summary Queries the information about a parameter template.
10171
+ *
10172
+ * @description You can use parameter templates to manage multiple parameters at a time and apply existing parameters to a PolarDB cluster. For more information, see [Use a parameter template](https://help.aliyun.com/document_detail/207009.html).
10173
+ * > This parameter is valid only for a PolarDB for MySQL cluster.
10174
+ *
10175
+ * @param request DescribeParameterGroupRequest
10176
+ * @return DescribeParameterGroupResponse
9372
10177
  */
9373
10178
  describeParameterGroup(request: DescribeParameterGroupRequest): Promise<DescribeParameterGroupResponse>;
9374
10179
  /**
9375
- * You can use parameter templates to manage multiple parameters at a time and apply existing parameters to a PolarDB cluster. For more information, see [Use a parameter template](~~207009~~).
9376
- * > This operation is applicable only to PolarDB for MySQL clusters.
9377
- *
9378
- * @param request DescribeParameterGroupsRequest
9379
- * @param runtime runtime options for this request RuntimeOptions
9380
- * @return DescribeParameterGroupsResponse
10180
+ * @summary Queries parameter templates that are available in a specified region.
10181
+ *
10182
+ * @description You can use parameter templates to manage multiple parameters at a time and apply existing parameters to a PolarDB cluster. For more information, see [Use a parameter template](https://help.aliyun.com/document_detail/207009.html).
10183
+ * > This operation is applicable only to PolarDB for MySQL clusters.
10184
+ *
10185
+ * @param request DescribeParameterGroupsRequest
10186
+ * @param runtime runtime options for this request RuntimeOptions
10187
+ * @return DescribeParameterGroupsResponse
9381
10188
  */
9382
10189
  describeParameterGroupsWithOptions(request: DescribeParameterGroupsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeParameterGroupsResponse>;
9383
10190
  /**
9384
- * You can use parameter templates to manage multiple parameters at a time and apply existing parameters to a PolarDB cluster. For more information, see [Use a parameter template](~~207009~~).
9385
- * > This operation is applicable only to PolarDB for MySQL clusters.
9386
- *
9387
- * @param request DescribeParameterGroupsRequest
9388
- * @return DescribeParameterGroupsResponse
10191
+ * @summary Queries parameter templates that are available in a specified region.
10192
+ *
10193
+ * @description You can use parameter templates to manage multiple parameters at a time and apply existing parameters to a PolarDB cluster. For more information, see [Use a parameter template](https://help.aliyun.com/document_detail/207009.html).
10194
+ * > This operation is applicable only to PolarDB for MySQL clusters.
10195
+ *
10196
+ * @param request DescribeParameterGroupsRequest
10197
+ * @return DescribeParameterGroupsResponse
9389
10198
  */
9390
10199
  describeParameterGroups(request: DescribeParameterGroupsRequest): Promise<DescribeParameterGroupsResponse>;
10200
+ /**
10201
+ * @summary Queries the default parameters in a cluster.
10202
+ *
10203
+ * @param request DescribeParameterTemplatesRequest
10204
+ * @param runtime runtime options for this request RuntimeOptions
10205
+ * @return DescribeParameterTemplatesResponse
10206
+ */
9391
10207
  describeParameterTemplatesWithOptions(request: DescribeParameterTemplatesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeParameterTemplatesResponse>;
10208
+ /**
10209
+ * @summary Queries the default parameters in a cluster.
10210
+ *
10211
+ * @param request DescribeParameterTemplatesRequest
10212
+ * @return DescribeParameterTemplatesResponse
10213
+ */
9392
10214
  describeParameterTemplates(request: DescribeParameterTemplatesRequest): Promise<DescribeParameterTemplatesResponse>;
10215
+ /**
10216
+ * @summary Queries the information about a pending event.
10217
+ *
10218
+ * @param request DescribePendingMaintenanceActionRequest
10219
+ * @param runtime runtime options for this request RuntimeOptions
10220
+ * @return DescribePendingMaintenanceActionResponse
10221
+ */
9393
10222
  describePendingMaintenanceActionWithOptions(request: DescribePendingMaintenanceActionRequest, runtime: $Util.RuntimeOptions): Promise<DescribePendingMaintenanceActionResponse>;
10223
+ /**
10224
+ * @summary Queries the information about a pending event.
10225
+ *
10226
+ * @param request DescribePendingMaintenanceActionRequest
10227
+ * @return DescribePendingMaintenanceActionResponse
10228
+ */
9394
10229
  describePendingMaintenanceAction(request: DescribePendingMaintenanceActionRequest): Promise<DescribePendingMaintenanceActionResponse>;
10230
+ /**
10231
+ * @summary Queries the numbers of pending events of different task types.
10232
+ *
10233
+ * @param request DescribePendingMaintenanceActionsRequest
10234
+ * @param runtime runtime options for this request RuntimeOptions
10235
+ * @return DescribePendingMaintenanceActionsResponse
10236
+ */
9395
10237
  describePendingMaintenanceActionsWithOptions(request: DescribePendingMaintenanceActionsRequest, runtime: $Util.RuntimeOptions): Promise<DescribePendingMaintenanceActionsResponse>;
10238
+ /**
10239
+ * @summary Queries the numbers of pending events of different task types.
10240
+ *
10241
+ * @param request DescribePendingMaintenanceActionsRequest
10242
+ * @return DescribePendingMaintenanceActionsResponse
10243
+ */
9396
10244
  describePendingMaintenanceActions(request: DescribePendingMaintenanceActionsRequest): Promise<DescribePendingMaintenanceActionsResponse>;
10245
+ /**
10246
+ * @summary Queries whether the SQL Explorer feature is enabled for the cluster.
10247
+ *
10248
+ * @param request DescribePolarSQLCollectorPolicyRequest
10249
+ * @param runtime runtime options for this request RuntimeOptions
10250
+ * @return DescribePolarSQLCollectorPolicyResponse
10251
+ */
9397
10252
  describePolarSQLCollectorPolicyWithOptions(request: DescribePolarSQLCollectorPolicyRequest, runtime: $Util.RuntimeOptions): Promise<DescribePolarSQLCollectorPolicyResponse>;
10253
+ /**
10254
+ * @summary Queries whether the SQL Explorer feature is enabled for the cluster.
10255
+ *
10256
+ * @param request DescribePolarSQLCollectorPolicyRequest
10257
+ * @return DescribePolarSQLCollectorPolicyResponse
10258
+ */
9398
10259
  describePolarSQLCollectorPolicy(request: DescribePolarSQLCollectorPolicyRequest): Promise<DescribePolarSQLCollectorPolicyResponse>;
10260
+ /**
10261
+ * @summary Queries the regions and zones available for PolarDB.
10262
+ *
10263
+ * @param request DescribeRegionsRequest
10264
+ * @param runtime runtime options for this request RuntimeOptions
10265
+ * @return DescribeRegionsResponse
10266
+ */
9399
10267
  describeRegionsWithOptions(request: DescribeRegionsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeRegionsResponse>;
10268
+ /**
10269
+ * @summary Queries the regions and zones available for PolarDB.
10270
+ *
10271
+ * @param request DescribeRegionsRequest
10272
+ * @return DescribeRegionsResponse
10273
+ */
9400
10274
  describeRegions(request: DescribeRegionsRequest): Promise<DescribeRegionsResponse>;
10275
+ /**
10276
+ * @summary Queries the details of all scheduled tasks.
10277
+ *
10278
+ * @param request DescribeScheduleTasksRequest
10279
+ * @param runtime runtime options for this request RuntimeOptions
10280
+ * @return DescribeScheduleTasksResponse
10281
+ */
9401
10282
  describeScheduleTasksWithOptions(request: DescribeScheduleTasksRequest, runtime: $Util.RuntimeOptions): Promise<DescribeScheduleTasksResponse>;
10283
+ /**
10284
+ * @summary Queries the details of all scheduled tasks.
10285
+ *
10286
+ * @param request DescribeScheduleTasksRequest
10287
+ * @return DescribeScheduleTasksResponse
10288
+ */
9402
10289
  describeScheduleTasks(request: DescribeScheduleTasksRequest): Promise<DescribeScheduleTasksResponse>;
9403
10290
  /**
9404
- * > This operation is applicable only to PolarDB for MySQL clusters.
9405
- *
9406
- * @param request DescribeSlowLogRecordsRequest
9407
- * @param runtime runtime options for this request RuntimeOptions
9408
- * @return DescribeSlowLogRecordsResponse
10291
+ * @summary Queries the details of the slow query logs of a PolarDB cluster.
10292
+ *
10293
+ * @description > This operation is applicable only to PolarDB for MySQL clusters.
10294
+ *
10295
+ * @param request DescribeSlowLogRecordsRequest
10296
+ * @param runtime runtime options for this request RuntimeOptions
10297
+ * @return DescribeSlowLogRecordsResponse
9409
10298
  */
9410
10299
  describeSlowLogRecordsWithOptions(request: DescribeSlowLogRecordsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeSlowLogRecordsResponse>;
9411
10300
  /**
9412
- * > This operation is applicable only to PolarDB for MySQL clusters.
9413
- *
9414
- * @param request DescribeSlowLogRecordsRequest
9415
- * @return DescribeSlowLogRecordsResponse
10301
+ * @summary Queries the details of the slow query logs of a PolarDB cluster.
10302
+ *
10303
+ * @description > This operation is applicable only to PolarDB for MySQL clusters.
10304
+ *
10305
+ * @param request DescribeSlowLogRecordsRequest
10306
+ * @return DescribeSlowLogRecordsResponse
9416
10307
  */
9417
10308
  describeSlowLogRecords(request: DescribeSlowLogRecordsRequest): Promise<DescribeSlowLogRecordsResponse>;
9418
10309
  /**
9419
- * > This operation is applicable only to PolarDB for MySQL clusters.
9420
- *
9421
- * @param request DescribeSlowLogsRequest
9422
- * @param runtime runtime options for this request RuntimeOptions
9423
- * @return DescribeSlowLogsResponse
10310
+ * @summary Queries the statistics about the slow query logs of a PolarDB cluster.
10311
+ *
10312
+ * @description > This operation is applicable only to PolarDB for MySQL clusters.
10313
+ *
10314
+ * @param request DescribeSlowLogsRequest
10315
+ * @param runtime runtime options for this request RuntimeOptions
10316
+ * @return DescribeSlowLogsResponse
9424
10317
  */
9425
10318
  describeSlowLogsWithOptions(request: DescribeSlowLogsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeSlowLogsResponse>;
9426
10319
  /**
9427
- * > This operation is applicable only to PolarDB for MySQL clusters.
9428
- *
9429
- * @param request DescribeSlowLogsRequest
9430
- * @return DescribeSlowLogsResponse
10320
+ * @summary Queries the statistics about the slow query logs of a PolarDB cluster.
10321
+ *
10322
+ * @description > This operation is applicable only to PolarDB for MySQL clusters.
10323
+ *
10324
+ * @param request DescribeSlowLogsRequest
10325
+ * @return DescribeSlowLogsResponse
9431
10326
  */
9432
10327
  describeSlowLogs(request: DescribeSlowLogsRequest): Promise<DescribeSlowLogsResponse>;
9433
10328
  /**
9434
- * * You can call this operation to view the details of a task that is generated by a specific API operation or in the console. The system calls the specific API operation when you perform an operation in the console. For example, you can view the details of the task when you call the [CreateDBCluster](~~98169~~) operation or [create a cluster](~~58769~~) in the console.
9435
- * * You can view the details of tasks that are generated only when you call the [CreateDBCluster](~~98169~~) operation to create a cluster and `CreationOption` is not set to `CreateGdnStandby`.
9436
- *
9437
- * @param request DescribeTasksRequest
9438
- * @param runtime runtime options for this request RuntimeOptions
9439
- * @return DescribeTasksResponse
10329
+ * @summary Queries the details of the tasks that are generated by calling API operations. For example, you can call this operation to view the details of the task when you create a cluster.
10330
+ *
10331
+ * @description * You can call this operation to view the details of a task that is generated by a specific API operation or in the console. The system calls the specific API operation when you perform an operation in the console. For example, you can view the details of the task when you call the [CreateDBCluster](https://help.aliyun.com/document_detail/98169.html) operation or [create a cluster](https://help.aliyun.com/document_detail/58769.html) in the console.
10332
+ * * You can view the details of tasks that are generated only when you call the [CreateDBCluster](https://help.aliyun.com/document_detail/98169.html) operation to create a cluster and `CreationOption` is not set to `CreateGdnStandby`.
10333
+ *
10334
+ * @param request DescribeTasksRequest
10335
+ * @param runtime runtime options for this request RuntimeOptions
10336
+ * @return DescribeTasksResponse
9440
10337
  */
9441
10338
  describeTasksWithOptions(request: DescribeTasksRequest, runtime: $Util.RuntimeOptions): Promise<DescribeTasksResponse>;
9442
10339
  /**
9443
- * * You can call this operation to view the details of a task that is generated by a specific API operation or in the console. The system calls the specific API operation when you perform an operation in the console. For example, you can view the details of the task when you call the [CreateDBCluster](~~98169~~) operation or [create a cluster](~~58769~~) in the console.
9444
- * * You can view the details of tasks that are generated only when you call the [CreateDBCluster](~~98169~~) operation to create a cluster and `CreationOption` is not set to `CreateGdnStandby`.
9445
- *
9446
- * @param request DescribeTasksRequest
9447
- * @return DescribeTasksResponse
10340
+ * @summary Queries the details of the tasks that are generated by calling API operations. For example, you can call this operation to view the details of the task when you create a cluster.
10341
+ *
10342
+ * @description * You can call this operation to view the details of a task that is generated by a specific API operation or in the console. The system calls the specific API operation when you perform an operation in the console. For example, you can view the details of the task when you call the [CreateDBCluster](https://help.aliyun.com/document_detail/98169.html) operation or [create a cluster](https://help.aliyun.com/document_detail/58769.html) in the console.
10343
+ * * You can view the details of tasks that are generated only when you call the [CreateDBCluster](https://help.aliyun.com/document_detail/98169.html) operation to create a cluster and `CreationOption` is not set to `CreateGdnStandby`.
10344
+ *
10345
+ * @param request DescribeTasksRequest
10346
+ * @return DescribeTasksResponse
9448
10347
  */
9449
10348
  describeTasks(request: DescribeTasksRequest): Promise<DescribeTasksResponse>;
10349
+ /**
10350
+ * @summary Queries the Key Management Service (KMS)-managed customer master keys (CMKs) that are used to encrypt data in a PolarDB cluster.
10351
+ *
10352
+ * @param request DescribeUserEncryptionKeyListRequest
10353
+ * @param runtime runtime options for this request RuntimeOptions
10354
+ * @return DescribeUserEncryptionKeyListResponse
10355
+ */
9450
10356
  describeUserEncryptionKeyListWithOptions(request: DescribeUserEncryptionKeyListRequest, runtime: $Util.RuntimeOptions): Promise<DescribeUserEncryptionKeyListResponse>;
10357
+ /**
10358
+ * @summary Queries the Key Management Service (KMS)-managed customer master keys (CMKs) that are used to encrypt data in a PolarDB cluster.
10359
+ *
10360
+ * @param request DescribeUserEncryptionKeyListRequest
10361
+ * @return DescribeUserEncryptionKeyListResponse
10362
+ */
9451
10363
  describeUserEncryptionKeyList(request: DescribeUserEncryptionKeyListRequest): Promise<DescribeUserEncryptionKeyListResponse>;
10364
+ /**
10365
+ * @summary Queries a vSwitch.
10366
+ *
10367
+ * @param request DescribeVSwitchesRequest
10368
+ * @param runtime runtime options for this request RuntimeOptions
10369
+ * @return DescribeVSwitchesResponse
10370
+ */
9452
10371
  describeVSwitchesWithOptions(request: DescribeVSwitchesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeVSwitchesResponse>;
10372
+ /**
10373
+ * @summary Queries a vSwitch.
10374
+ *
10375
+ * @param request DescribeVSwitchesRequest
10376
+ * @return DescribeVSwitchesResponse
10377
+ */
9453
10378
  describeVSwitches(request: DescribeVSwitchesRequest): Promise<DescribeVSwitchesResponse>;
10379
+ /**
10380
+ * @summary Disables a stable serverless cluster.
10381
+ *
10382
+ * @param request DisableDBClusterServerlessRequest
10383
+ * @param runtime runtime options for this request RuntimeOptions
10384
+ * @return DisableDBClusterServerlessResponse
10385
+ */
9454
10386
  disableDBClusterServerlessWithOptions(request: DisableDBClusterServerlessRequest, runtime: $Util.RuntimeOptions): Promise<DisableDBClusterServerlessResponse>;
10387
+ /**
10388
+ * @summary Disables a stable serverless cluster.
10389
+ *
10390
+ * @param request DisableDBClusterServerlessRequest
10391
+ * @return DisableDBClusterServerlessResponse
10392
+ */
9455
10393
  disableDBClusterServerless(request: DisableDBClusterServerlessRequest): Promise<DisableDBClusterServerlessResponse>;
10394
+ /**
10395
+ * @summary Enables a stable serverless cluster.
10396
+ *
10397
+ * @param request EnableDBClusterServerlessRequest
10398
+ * @param runtime runtime options for this request RuntimeOptions
10399
+ * @return EnableDBClusterServerlessResponse
10400
+ */
9456
10401
  enableDBClusterServerlessWithOptions(request: EnableDBClusterServerlessRequest, runtime: $Util.RuntimeOptions): Promise<EnableDBClusterServerlessResponse>;
10402
+ /**
10403
+ * @summary Enables a stable serverless cluster.
10404
+ *
10405
+ * @param request EnableDBClusterServerlessRequest
10406
+ * @return EnableDBClusterServerlessResponse
10407
+ */
9457
10408
  enableDBClusterServerless(request: EnableDBClusterServerlessRequest): Promise<EnableDBClusterServerlessResponse>;
10409
+ /**
10410
+ * @summary 修改sql防火墙状态
10411
+ *
10412
+ * @param request EnableFirewallRulesRequest
10413
+ * @param runtime runtime options for this request RuntimeOptions
10414
+ * @return EnableFirewallRulesResponse
10415
+ */
9458
10416
  enableFirewallRulesWithOptions(request: EnableFirewallRulesRequest, runtime: $Util.RuntimeOptions): Promise<EnableFirewallRulesResponse>;
10417
+ /**
10418
+ * @summary 修改sql防火墙状态
10419
+ *
10420
+ * @param request EnableFirewallRulesRequest
10421
+ * @return EnableFirewallRulesResponse
10422
+ */
9459
10423
  enableFirewallRules(request: EnableFirewallRulesRequest): Promise<EnableFirewallRulesResponse>;
10424
+ /**
10425
+ * @summary Evaluates available resources.
10426
+ *
10427
+ * @param request EvaluateRegionResourceRequest
10428
+ * @param runtime runtime options for this request RuntimeOptions
10429
+ * @return EvaluateRegionResourceResponse
10430
+ */
9460
10431
  evaluateRegionResourceWithOptions(request: EvaluateRegionResourceRequest, runtime: $Util.RuntimeOptions): Promise<EvaluateRegionResourceResponse>;
10432
+ /**
10433
+ * @summary Evaluates available resources.
10434
+ *
10435
+ * @param request EvaluateRegionResourceRequest
10436
+ * @return EvaluateRegionResourceResponse
10437
+ */
9461
10438
  evaluateRegionResource(request: EvaluateRegionResourceRequest): Promise<EvaluateRegionResourceResponse>;
10439
+ /**
10440
+ * @summary Performs a manual failover to promote a read-only node to the primary node in a PolarDB cluster.
10441
+ *
10442
+ * @param request FailoverDBClusterRequest
10443
+ * @param runtime runtime options for this request RuntimeOptions
10444
+ * @return FailoverDBClusterResponse
10445
+ */
9462
10446
  failoverDBClusterWithOptions(request: FailoverDBClusterRequest, runtime: $Util.RuntimeOptions): Promise<FailoverDBClusterResponse>;
10447
+ /**
10448
+ * @summary Performs a manual failover to promote a read-only node to the primary node in a PolarDB cluster.
10449
+ *
10450
+ * @param request FailoverDBClusterRequest
10451
+ * @return FailoverDBClusterResponse
10452
+ */
9463
10453
  failoverDBCluster(request: FailoverDBClusterRequest): Promise<FailoverDBClusterResponse>;
9464
10454
  /**
9465
- * > * An account can be authorized to access one or more databases.
9466
- * > * If the specified account already has the access permissions on the specified databases, the operation returns a successful response.
9467
- * > * Before you call this operation, make sure that the cluster is in the Running state. Otherwise, the operation fails.
9468
- * > * You can call this operation only on a PolarDB for MySQL cluster.
9469
- * > * By default, a privileged account for a cluster has all the permissions on the databases in the cluster.
9470
- *
9471
- * @param request GrantAccountPrivilegeRequest
9472
- * @param runtime runtime options for this request RuntimeOptions
9473
- * @return GrantAccountPrivilegeResponse
10455
+ * @summary Grants a standard account the permissions to access one or more databases in a specified PolarDB cluster.
10456
+ *
10457
+ * @description > * An account can be authorized to access one or more databases.
10458
+ * > * If the specified account already has the access permissions on the specified databases, the operation returns a successful response.
10459
+ * > * Before you call this operation, make sure that the cluster is in the Running state. Otherwise, the operation fails.
10460
+ * > * You can call this operation only on a PolarDB for MySQL cluster.
10461
+ * > * By default, a privileged account for a cluster has all the permissions on the databases in the cluster.
10462
+ *
10463
+ * @param request GrantAccountPrivilegeRequest
10464
+ * @param runtime runtime options for this request RuntimeOptions
10465
+ * @return GrantAccountPrivilegeResponse
9474
10466
  */
9475
10467
  grantAccountPrivilegeWithOptions(request: GrantAccountPrivilegeRequest, runtime: $Util.RuntimeOptions): Promise<GrantAccountPrivilegeResponse>;
9476
10468
  /**
9477
- * > * An account can be authorized to access one or more databases.
9478
- * > * If the specified account already has the access permissions on the specified databases, the operation returns a successful response.
9479
- * > * Before you call this operation, make sure that the cluster is in the Running state. Otherwise, the operation fails.
9480
- * > * You can call this operation only on a PolarDB for MySQL cluster.
9481
- * > * By default, a privileged account for a cluster has all the permissions on the databases in the cluster.
9482
- *
9483
- * @param request GrantAccountPrivilegeRequest
9484
- * @return GrantAccountPrivilegeResponse
10469
+ * @summary Grants a standard account the permissions to access one or more databases in a specified PolarDB cluster.
10470
+ *
10471
+ * @description > * An account can be authorized to access one or more databases.
10472
+ * > * If the specified account already has the access permissions on the specified databases, the operation returns a successful response.
10473
+ * > * Before you call this operation, make sure that the cluster is in the Running state. Otherwise, the operation fails.
10474
+ * > * You can call this operation only on a PolarDB for MySQL cluster.
10475
+ * > * By default, a privileged account for a cluster has all the permissions on the databases in the cluster.
10476
+ *
10477
+ * @param request GrantAccountPrivilegeRequest
10478
+ * @return GrantAccountPrivilegeResponse
9485
10479
  */
9486
10480
  grantAccountPrivilege(request: GrantAccountPrivilegeRequest): Promise<GrantAccountPrivilegeResponse>;
10481
+ /**
10482
+ * @summary Queries the tags that are bound to one or more PolarDB clusters, or queries the PolarDB clusters to which one or more tags are bound.
10483
+ *
10484
+ * @param request ListTagResourcesRequest
10485
+ * @param runtime runtime options for this request RuntimeOptions
10486
+ * @return ListTagResourcesResponse
10487
+ */
9487
10488
  listTagResourcesWithOptions(request: ListTagResourcesRequest, runtime: $Util.RuntimeOptions): Promise<ListTagResourcesResponse>;
10489
+ /**
10490
+ * @summary Queries the tags that are bound to one or more PolarDB clusters, or queries the PolarDB clusters to which one or more tags are bound.
10491
+ *
10492
+ * @param request ListTagResourcesRequest
10493
+ * @return ListTagResourcesResponse
10494
+ */
9488
10495
  listTagResources(request: ListTagResourcesRequest): Promise<ListTagResourcesResponse>;
10496
+ /**
10497
+ * @summary Manually starts a cluster.
10498
+ *
10499
+ * @param request ManuallyStartDBClusterRequest
10500
+ * @param runtime runtime options for this request RuntimeOptions
10501
+ * @return ManuallyStartDBClusterResponse
10502
+ */
9489
10503
  manuallyStartDBClusterWithOptions(request: ManuallyStartDBClusterRequest, runtime: $Util.RuntimeOptions): Promise<ManuallyStartDBClusterResponse>;
10504
+ /**
10505
+ * @summary Manually starts a cluster.
10506
+ *
10507
+ * @param request ManuallyStartDBClusterRequest
10508
+ * @return ManuallyStartDBClusterResponse
10509
+ */
9490
10510
  manuallyStartDBCluster(request: ManuallyStartDBClusterRequest): Promise<ManuallyStartDBClusterResponse>;
10511
+ /**
10512
+ * @summary Modifies the description of a database account of a PolarDB cluster.
10513
+ *
10514
+ * @param request ModifyAccountDescriptionRequest
10515
+ * @param runtime runtime options for this request RuntimeOptions
10516
+ * @return ModifyAccountDescriptionResponse
10517
+ */
9491
10518
  modifyAccountDescriptionWithOptions(request: ModifyAccountDescriptionRequest, runtime: $Util.RuntimeOptions): Promise<ModifyAccountDescriptionResponse>;
10519
+ /**
10520
+ * @summary Modifies the description of a database account of a PolarDB cluster.
10521
+ *
10522
+ * @param request ModifyAccountDescriptionRequest
10523
+ * @return ModifyAccountDescriptionResponse
10524
+ */
9492
10525
  modifyAccountDescription(request: ModifyAccountDescriptionRequest): Promise<ModifyAccountDescriptionResponse>;
10526
+ /**
10527
+ * @summary Changes the password of a database account for a specified PolarDB cluster.
10528
+ *
10529
+ * @param request ModifyAccountPasswordRequest
10530
+ * @param runtime runtime options for this request RuntimeOptions
10531
+ * @return ModifyAccountPasswordResponse
10532
+ */
9493
10533
  modifyAccountPasswordWithOptions(request: ModifyAccountPasswordRequest, runtime: $Util.RuntimeOptions): Promise<ModifyAccountPasswordResponse>;
10534
+ /**
10535
+ * @summary Changes the password of a database account for a specified PolarDB cluster.
10536
+ *
10537
+ * @param request ModifyAccountPasswordRequest
10538
+ * @return ModifyAccountPasswordResponse
10539
+ */
9494
10540
  modifyAccountPassword(request: ModifyAccountPasswordRequest): Promise<ModifyAccountPasswordResponse>;
10541
+ /**
10542
+ * @summary Modifies the auto-renewal attributes of a subscription PolarDB cluster.
10543
+ *
10544
+ * @param request ModifyAutoRenewAttributeRequest
10545
+ * @param runtime runtime options for this request RuntimeOptions
10546
+ * @return ModifyAutoRenewAttributeResponse
10547
+ */
9495
10548
  modifyAutoRenewAttributeWithOptions(request: ModifyAutoRenewAttributeRequest, runtime: $Util.RuntimeOptions): Promise<ModifyAutoRenewAttributeResponse>;
10549
+ /**
10550
+ * @summary Modifies the auto-renewal attributes of a subscription PolarDB cluster.
10551
+ *
10552
+ * @param request ModifyAutoRenewAttributeRequest
10553
+ * @return ModifyAutoRenewAttributeResponse
10554
+ */
9496
10555
  modifyAutoRenewAttribute(request: ModifyAutoRenewAttributeRequest): Promise<ModifyAutoRenewAttributeResponse>;
9497
10556
  /**
9498
- * > You can also modify the automatic backup policy of a PolarDB cluster in the console. For more information, see [Backup settings](~~280422~~).
9499
- *
9500
- * @param request ModifyBackupPolicyRequest
9501
- * @param runtime runtime options for this request RuntimeOptions
9502
- * @return ModifyBackupPolicyResponse
10557
+ * @summary Modifies the automatic backup policy of a PolarDB cluster.
10558
+ *
10559
+ * @description > You can also modify the automatic backup policy of a PolarDB cluster in the console. For more information, see [Backup settings](https://help.aliyun.com/document_detail/280422.html).
10560
+ *
10561
+ * @param request ModifyBackupPolicyRequest
10562
+ * @param runtime runtime options for this request RuntimeOptions
10563
+ * @return ModifyBackupPolicyResponse
9503
10564
  */
9504
10565
  modifyBackupPolicyWithOptions(request: ModifyBackupPolicyRequest, runtime: $Util.RuntimeOptions): Promise<ModifyBackupPolicyResponse>;
9505
10566
  /**
9506
- * > You can also modify the automatic backup policy of a PolarDB cluster in the console. For more information, see [Backup settings](~~280422~~).
9507
- *
9508
- * @param request ModifyBackupPolicyRequest
9509
- * @return ModifyBackupPolicyResponse
10567
+ * @summary Modifies the automatic backup policy of a PolarDB cluster.
10568
+ *
10569
+ * @description > You can also modify the automatic backup policy of a PolarDB cluster in the console. For more information, see [Backup settings](https://help.aliyun.com/document_detail/280422.html).
10570
+ *
10571
+ * @param request ModifyBackupPolicyRequest
10572
+ * @return ModifyBackupPolicyResponse
9510
10573
  */
9511
10574
  modifyBackupPolicy(request: ModifyBackupPolicyRequest): Promise<ModifyBackupPolicyResponse>;
10575
+ /**
10576
+ * @summary Modifies the configurations of a PolarDB for MySQL cluster.
10577
+ *
10578
+ * @param request ModifyDBClusterRequest
10579
+ * @param runtime runtime options for this request RuntimeOptions
10580
+ * @return ModifyDBClusterResponse
10581
+ */
9512
10582
  modifyDBClusterWithOptions(request: ModifyDBClusterRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBClusterResponse>;
10583
+ /**
10584
+ * @summary Modifies the configurations of a PolarDB for MySQL cluster.
10585
+ *
10586
+ * @param request ModifyDBClusterRequest
10587
+ * @return ModifyDBClusterResponse
10588
+ */
9513
10589
  modifyDBCluster(request: ModifyDBClusterRequest): Promise<ModifyDBClusterResponse>;
10590
+ /**
10591
+ * @summary Creates or modifies the whitelists (IP whitelists and security groups) of a specified cluster.
10592
+ *
10593
+ * @param request ModifyDBClusterAccessWhitelistRequest
10594
+ * @param runtime runtime options for this request RuntimeOptions
10595
+ * @return ModifyDBClusterAccessWhitelistResponse
10596
+ */
9514
10597
  modifyDBClusterAccessWhitelistWithOptions(request: ModifyDBClusterAccessWhitelistRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBClusterAccessWhitelistResponse>;
10598
+ /**
10599
+ * @summary Creates or modifies the whitelists (IP whitelists and security groups) of a specified cluster.
10600
+ *
10601
+ * @param request ModifyDBClusterAccessWhitelistRequest
10602
+ * @return ModifyDBClusterAccessWhitelistResponse
10603
+ */
9515
10604
  modifyDBClusterAccessWhitelist(request: ModifyDBClusterAccessWhitelistRequest): Promise<ModifyDBClusterAccessWhitelistResponse>;
10605
+ /**
10606
+ * @summary Modifies cluster parameters and applies them to specified nodes.
10607
+ *
10608
+ * @param request ModifyDBClusterAndNodesParametersRequest
10609
+ * @param runtime runtime options for this request RuntimeOptions
10610
+ * @return ModifyDBClusterAndNodesParametersResponse
10611
+ */
9516
10612
  modifyDBClusterAndNodesParametersWithOptions(request: ModifyDBClusterAndNodesParametersRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBClusterAndNodesParametersResponse>;
10613
+ /**
10614
+ * @summary Modifies cluster parameters and applies them to specified nodes.
10615
+ *
10616
+ * @param request ModifyDBClusterAndNodesParametersRequest
10617
+ * @return ModifyDBClusterAndNodesParametersResponse
10618
+ */
9517
10619
  modifyDBClusterAndNodesParameters(request: ModifyDBClusterAndNodesParametersRequest): Promise<ModifyDBClusterAndNodesParametersResponse>;
10620
+ /**
10621
+ * @summary Enables or disables SQL collector for a PolarDB cluster. The features related to SQL collector include Audit Logs and SQL Explorer.
10622
+ *
10623
+ * @param request ModifyDBClusterAuditLogCollectorRequest
10624
+ * @param runtime runtime options for this request RuntimeOptions
10625
+ * @return ModifyDBClusterAuditLogCollectorResponse
10626
+ */
9518
10627
  modifyDBClusterAuditLogCollectorWithOptions(request: ModifyDBClusterAuditLogCollectorRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBClusterAuditLogCollectorResponse>;
10628
+ /**
10629
+ * @summary Enables or disables SQL collector for a PolarDB cluster. The features related to SQL collector include Audit Logs and SQL Explorer.
10630
+ *
10631
+ * @param request ModifyDBClusterAuditLogCollectorRequest
10632
+ * @return ModifyDBClusterAuditLogCollectorResponse
10633
+ */
9519
10634
  modifyDBClusterAuditLogCollector(request: ModifyDBClusterAuditLogCollectorRequest): Promise<ModifyDBClusterAuditLogCollectorResponse>;
10635
+ /**
10636
+ * @summary Enables or disables the cluster lock feature for a PolarDB cluster.
10637
+ *
10638
+ * @param request ModifyDBClusterDeletionRequest
10639
+ * @param runtime runtime options for this request RuntimeOptions
10640
+ * @return ModifyDBClusterDeletionResponse
10641
+ */
9520
10642
  modifyDBClusterDeletionWithOptions(request: ModifyDBClusterDeletionRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBClusterDeletionResponse>;
10643
+ /**
10644
+ * @summary Enables or disables the cluster lock feature for a PolarDB cluster.
10645
+ *
10646
+ * @param request ModifyDBClusterDeletionRequest
10647
+ * @return ModifyDBClusterDeletionResponse
10648
+ */
9521
10649
  modifyDBClusterDeletion(request: ModifyDBClusterDeletionRequest): Promise<ModifyDBClusterDeletionResponse>;
10650
+ /**
10651
+ * @summary Modifies the name of a PolarDB cluster.
10652
+ *
10653
+ * @param request ModifyDBClusterDescriptionRequest
10654
+ * @param runtime runtime options for this request RuntimeOptions
10655
+ * @return ModifyDBClusterDescriptionResponse
10656
+ */
9522
10657
  modifyDBClusterDescriptionWithOptions(request: ModifyDBClusterDescriptionRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBClusterDescriptionResponse>;
10658
+ /**
10659
+ * @summary Modifies the name of a PolarDB cluster.
10660
+ *
10661
+ * @param request ModifyDBClusterDescriptionRequest
10662
+ * @return ModifyDBClusterDescriptionResponse
10663
+ */
9523
10664
  modifyDBClusterDescription(request: ModifyDBClusterDescriptionRequest): Promise<ModifyDBClusterDescriptionResponse>;
10665
+ /**
10666
+ * @summary Modifies the attributes of a specified PolarDB cluster endpoint. For example, you can modify the following attributes for the specified cluster endpoint: read/write mode, consistency level, transaction splitting, primary node accepts read requests, and connection pool. You can also call the operation to specify whether newly added nodes are automatically associated with the specified cluster endpoint.
10667
+ *
10668
+ * @param request ModifyDBClusterEndpointRequest
10669
+ * @param runtime runtime options for this request RuntimeOptions
10670
+ * @return ModifyDBClusterEndpointResponse
10671
+ */
9524
10672
  modifyDBClusterEndpointWithOptions(request: ModifyDBClusterEndpointRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBClusterEndpointResponse>;
10673
+ /**
10674
+ * @summary Modifies the attributes of a specified PolarDB cluster endpoint. For example, you can modify the following attributes for the specified cluster endpoint: read/write mode, consistency level, transaction splitting, primary node accepts read requests, and connection pool. You can also call the operation to specify whether newly added nodes are automatically associated with the specified cluster endpoint.
10675
+ *
10676
+ * @param request ModifyDBClusterEndpointRequest
10677
+ * @return ModifyDBClusterEndpointResponse
10678
+ */
9525
10679
  modifyDBClusterEndpoint(request: ModifyDBClusterEndpointRequest): Promise<ModifyDBClusterEndpointResponse>;
9526
10680
  /**
9527
- * > We recommend that you set the routine maintenance window to off-peak hours. Alibaba Cloud maintains your cluster within the specified maintenance window to minimize the negative impacts on your business.
9528
- *
9529
- * @param request ModifyDBClusterMaintainTimeRequest
9530
- * @param runtime runtime options for this request RuntimeOptions
9531
- * @return ModifyDBClusterMaintainTimeResponse
10681
+ * @summary Modifies the maintenance window of a PolarDB cluster.
10682
+ *
10683
+ * @description > We recommend that you set the routine maintenance window to off-peak hours. Alibaba Cloud maintains your cluster within the specified maintenance window to minimize the negative impacts on your business.
10684
+ *
10685
+ * @param request ModifyDBClusterMaintainTimeRequest
10686
+ * @param runtime runtime options for this request RuntimeOptions
10687
+ * @return ModifyDBClusterMaintainTimeResponse
9532
10688
  */
9533
10689
  modifyDBClusterMaintainTimeWithOptions(request: ModifyDBClusterMaintainTimeRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBClusterMaintainTimeResponse>;
9534
10690
  /**
9535
- * > We recommend that you set the routine maintenance window to off-peak hours. Alibaba Cloud maintains your cluster within the specified maintenance window to minimize the negative impacts on your business.
9536
- *
9537
- * @param request ModifyDBClusterMaintainTimeRequest
9538
- * @return ModifyDBClusterMaintainTimeResponse
10691
+ * @summary Modifies the maintenance window of a PolarDB cluster.
10692
+ *
10693
+ * @description > We recommend that you set the routine maintenance window to off-peak hours. Alibaba Cloud maintains your cluster within the specified maintenance window to minimize the negative impacts on your business.
10694
+ *
10695
+ * @param request ModifyDBClusterMaintainTimeRequest
10696
+ * @return ModifyDBClusterMaintainTimeResponse
9539
10697
  */
9540
10698
  modifyDBClusterMaintainTime(request: ModifyDBClusterMaintainTimeRequest): Promise<ModifyDBClusterMaintainTimeResponse>;
9541
10699
  /**
9542
- * * You can call this operation to switch the task that migrates data from ApsaraDB for RDS to PolarDB.
9543
- * * You can call this operation to roll back the task that migrates data from ApsaraDB for RDS to PolarDB.
9544
- * > Before you call this operation, ensure that a one-click upgrade task has been created for the cluster. You can call the [CreateDBCluster](~~98169~~) operation to create an upgrade task. Set the **CreationOption** parameter to **MigrationFromRDS**. For more information, see [Create a PolarDB for MySQL cluster by using the Migration from RDS method](~~121582~~).
9545
- *
9546
- * @param request ModifyDBClusterMigrationRequest
9547
- * @param runtime runtime options for this request RuntimeOptions
9548
- * @return ModifyDBClusterMigrationResponse
10700
+ * @summary Switches or rolls back the task that migrates data from ApsaraDB for RDS to PolarDB.
10701
+ *
10702
+ * @description * You can call this operation to switch the task that migrates data from ApsaraDB for RDS to PolarDB.
10703
+ * * You can call this operation to roll back the task that migrates data from ApsaraDB for RDS to PolarDB.
10704
+ * > Before you call this operation, ensure that a one-click upgrade task has been created for the cluster. You can call the [CreateDBCluster](https://help.aliyun.com/document_detail/98169.html) operation to create an upgrade task. Set the **CreationOption** parameter to **MigrationFromRDS**. For more information, see [Create a PolarDB for MySQL cluster by using the Migration from RDS method](https://help.aliyun.com/document_detail/121582.html).
10705
+ *
10706
+ * @param request ModifyDBClusterMigrationRequest
10707
+ * @param runtime runtime options for this request RuntimeOptions
10708
+ * @return ModifyDBClusterMigrationResponse
9549
10709
  */
9550
10710
  modifyDBClusterMigrationWithOptions(request: ModifyDBClusterMigrationRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBClusterMigrationResponse>;
9551
10711
  /**
9552
- * * You can call this operation to switch the task that migrates data from ApsaraDB for RDS to PolarDB.
9553
- * * You can call this operation to roll back the task that migrates data from ApsaraDB for RDS to PolarDB.
9554
- * > Before you call this operation, ensure that a one-click upgrade task has been created for the cluster. You can call the [CreateDBCluster](~~98169~~) operation to create an upgrade task. Set the **CreationOption** parameter to **MigrationFromRDS**. For more information, see [Create a PolarDB for MySQL cluster by using the Migration from RDS method](~~121582~~).
9555
- *
9556
- * @param request ModifyDBClusterMigrationRequest
9557
- * @return ModifyDBClusterMigrationResponse
10712
+ * @summary Switches or rolls back the task that migrates data from ApsaraDB for RDS to PolarDB.
10713
+ *
10714
+ * @description * You can call this operation to switch the task that migrates data from ApsaraDB for RDS to PolarDB.
10715
+ * * You can call this operation to roll back the task that migrates data from ApsaraDB for RDS to PolarDB.
10716
+ * > Before you call this operation, ensure that a one-click upgrade task has been created for the cluster. You can call the [CreateDBCluster](https://help.aliyun.com/document_detail/98169.html) operation to create an upgrade task. Set the **CreationOption** parameter to **MigrationFromRDS**. For more information, see [Create a PolarDB for MySQL cluster by using the Migration from RDS method](https://help.aliyun.com/document_detail/121582.html).
10717
+ *
10718
+ * @param request ModifyDBClusterMigrationRequest
10719
+ * @return ModifyDBClusterMigrationResponse
9558
10720
  */
9559
10721
  modifyDBClusterMigration(request: ModifyDBClusterMigrationRequest): Promise<ModifyDBClusterMigrationResponse>;
9560
10722
  /**
9561
- * * When the monitoring data is collected every 5 seconds:
9562
- * * If the query time range is less than or equal to 1 hour, the data is displayed at intervals of 5 seconds.
9563
- * * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.
9564
- * * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.
9565
- * * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.
9566
- * * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.
9567
- * * When the monitoring data is collected every 60 seconds:
9568
- * * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.
9569
- * * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.
9570
- * * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.
9571
- * * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.
9572
- *
9573
- * @param request ModifyDBClusterMonitorRequest
9574
- * @param runtime runtime options for this request RuntimeOptions
9575
- * @return ModifyDBClusterMonitorResponse
10723
+ * @summary Modifies the interval at which the monitoring data of a PolarDB cluster is collected.
10724
+ *
10725
+ * @description * When the monitoring data is collected every 5 seconds:
10726
+ * * If the query time range is less than or equal to 1 hour, the data is displayed at intervals of 5 seconds.
10727
+ * * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.
10728
+ * * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.
10729
+ * * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.
10730
+ * * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.
10731
+ * * When the monitoring data is collected every 60 seconds:
10732
+ * * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.
10733
+ * * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.
10734
+ * * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.
10735
+ * * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.
10736
+ *
10737
+ * @param request ModifyDBClusterMonitorRequest
10738
+ * @param runtime runtime options for this request RuntimeOptions
10739
+ * @return ModifyDBClusterMonitorResponse
9576
10740
  */
9577
10741
  modifyDBClusterMonitorWithOptions(request: ModifyDBClusterMonitorRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBClusterMonitorResponse>;
9578
10742
  /**
9579
- * * When the monitoring data is collected every 5 seconds:
9580
- * * If the query time range is less than or equal to 1 hour, the data is displayed at intervals of 5 seconds.
9581
- * * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.
9582
- * * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.
9583
- * * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.
9584
- * * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.
9585
- * * When the monitoring data is collected every 60 seconds:
9586
- * * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.
9587
- * * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.
9588
- * * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.
9589
- * * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.
9590
- *
9591
- * @param request ModifyDBClusterMonitorRequest
9592
- * @return ModifyDBClusterMonitorResponse
10743
+ * @summary Modifies the interval at which the monitoring data of a PolarDB cluster is collected.
10744
+ *
10745
+ * @description * When the monitoring data is collected every 5 seconds:
10746
+ * * If the query time range is less than or equal to 1 hour, the data is displayed at intervals of 5 seconds.
10747
+ * * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.
10748
+ * * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.
10749
+ * * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.
10750
+ * * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.
10751
+ * * When the monitoring data is collected every 60 seconds:
10752
+ * * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.
10753
+ * * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.
10754
+ * * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.
10755
+ * * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.
10756
+ *
10757
+ * @param request ModifyDBClusterMonitorRequest
10758
+ * @return ModifyDBClusterMonitorResponse
9593
10759
  */
9594
10760
  modifyDBClusterMonitor(request: ModifyDBClusterMonitorRequest): Promise<ModifyDBClusterMonitorResponse>;
9595
10761
  /**
9596
- * PolarDB supports the parameter template feature to centrally manage clusters. You can configure a number of parameters at a time by using a parameter template and apply the template to a PolarDB cluster. For more information, see [Use a parameter template](~~207009~~).
9597
- * **
9598
- * **Only PolarDB for MySQL clusters support parameter templates.
9599
- *
9600
- * @param request ModifyDBClusterParametersRequest
9601
- * @param runtime runtime options for this request RuntimeOptions
9602
- * @return ModifyDBClusterParametersResponse
10762
+ * @summary Modifies the parameters of a specified PolarDB cluster or applies existing parameter templates to a specified cluster.
10763
+ *
10764
+ * @description PolarDB supports the parameter template feature to centrally manage clusters. You can configure a number of parameters at a time by using a parameter template and apply the template to a PolarDB cluster. For more information, see [Use a parameter template](https://help.aliyun.com/document_detail/207009.html).
10765
+ * **
10766
+ * **Only PolarDB for MySQL clusters support parameter templates.
10767
+ *
10768
+ * @param request ModifyDBClusterParametersRequest
10769
+ * @param runtime runtime options for this request RuntimeOptions
10770
+ * @return ModifyDBClusterParametersResponse
9603
10771
  */
9604
10772
  modifyDBClusterParametersWithOptions(request: ModifyDBClusterParametersRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBClusterParametersResponse>;
9605
10773
  /**
9606
- * PolarDB supports the parameter template feature to centrally manage clusters. You can configure a number of parameters at a time by using a parameter template and apply the template to a PolarDB cluster. For more information, see [Use a parameter template](~~207009~~).
9607
- * **
9608
- * **Only PolarDB for MySQL clusters support parameter templates.
9609
- *
9610
- * @param request ModifyDBClusterParametersRequest
9611
- * @return ModifyDBClusterParametersResponse
10774
+ * @summary Modifies the parameters of a specified PolarDB cluster or applies existing parameter templates to a specified cluster.
10775
+ *
10776
+ * @description PolarDB supports the parameter template feature to centrally manage clusters. You can configure a number of parameters at a time by using a parameter template and apply the template to a PolarDB cluster. For more information, see [Use a parameter template](https://help.aliyun.com/document_detail/207009.html).
10777
+ * **
10778
+ * **Only PolarDB for MySQL clusters support parameter templates.
10779
+ *
10780
+ * @param request ModifyDBClusterParametersRequest
10781
+ * @return ModifyDBClusterParametersResponse
9612
10782
  */
9613
10783
  modifyDBClusterParameters(request: ModifyDBClusterParametersRequest): Promise<ModifyDBClusterParametersResponse>;
10784
+ /**
10785
+ * @summary Modifies the primary zone of a PolarDB cluster.
10786
+ *
10787
+ * @param request ModifyDBClusterPrimaryZoneRequest
10788
+ * @param runtime runtime options for this request RuntimeOptions
10789
+ * @return ModifyDBClusterPrimaryZoneResponse
10790
+ */
9614
10791
  modifyDBClusterPrimaryZoneWithOptions(request: ModifyDBClusterPrimaryZoneRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBClusterPrimaryZoneResponse>;
10792
+ /**
10793
+ * @summary Modifies the primary zone of a PolarDB cluster.
10794
+ *
10795
+ * @param request ModifyDBClusterPrimaryZoneRequest
10796
+ * @return ModifyDBClusterPrimaryZoneResponse
10797
+ */
9615
10798
  modifyDBClusterPrimaryZone(request: ModifyDBClusterPrimaryZoneRequest): Promise<ModifyDBClusterPrimaryZoneResponse>;
10799
+ /**
10800
+ * @param request ModifyDBClusterResourceGroupRequest
10801
+ * @param runtime runtime options for this request RuntimeOptions
10802
+ * @return ModifyDBClusterResourceGroupResponse
10803
+ */
9616
10804
  modifyDBClusterResourceGroupWithOptions(request: ModifyDBClusterResourceGroupRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBClusterResourceGroupResponse>;
10805
+ /**
10806
+ * @param request ModifyDBClusterResourceGroupRequest
10807
+ * @return ModifyDBClusterResourceGroupResponse
10808
+ */
9617
10809
  modifyDBClusterResourceGroup(request: ModifyDBClusterResourceGroupRequest): Promise<ModifyDBClusterResourceGroupResponse>;
10810
+ /**
10811
+ * @summary Enables or disables Secure Sockets Layer (SSL) encryption or updates the Certificate Authorities (CA) certificate for a specified PolarDB cluster.
10812
+ *
10813
+ * @param request ModifyDBClusterSSLRequest
10814
+ * @param runtime runtime options for this request RuntimeOptions
10815
+ * @return ModifyDBClusterSSLResponse
10816
+ */
9618
10817
  modifyDBClusterSSLWithOptions(request: ModifyDBClusterSSLRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBClusterSSLResponse>;
10818
+ /**
10819
+ * @summary Enables or disables Secure Sockets Layer (SSL) encryption or updates the Certificate Authorities (CA) certificate for a specified PolarDB cluster.
10820
+ *
10821
+ * @param request ModifyDBClusterSSLRequest
10822
+ * @return ModifyDBClusterSSLResponse
10823
+ */
9619
10824
  modifyDBClusterSSL(request: ModifyDBClusterSSLRequest): Promise<ModifyDBClusterSSLResponse>;
10825
+ /**
10826
+ * @summary Modifies the configurations of a serverless cluster.
10827
+ *
10828
+ * @param request ModifyDBClusterServerlessConfRequest
10829
+ * @param runtime runtime options for this request RuntimeOptions
10830
+ * @return ModifyDBClusterServerlessConfResponse
10831
+ */
9620
10832
  modifyDBClusterServerlessConfWithOptions(request: ModifyDBClusterServerlessConfRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBClusterServerlessConfResponse>;
10833
+ /**
10834
+ * @summary Modifies the configurations of a serverless cluster.
10835
+ *
10836
+ * @param request ModifyDBClusterServerlessConfRequest
10837
+ * @return ModifyDBClusterServerlessConfResponse
10838
+ */
9621
10839
  modifyDBClusterServerlessConf(request: ModifyDBClusterServerlessConfRequest): Promise<ModifyDBClusterServerlessConfResponse>;
10840
+ /**
10841
+ * @summary Changes the storage capacity of a pay-as-you-go cluster of Enterprise Edition or a cluster of Standard Edition.
10842
+ *
10843
+ * @param request ModifyDBClusterStorageSpaceRequest
10844
+ * @param runtime runtime options for this request RuntimeOptions
10845
+ * @return ModifyDBClusterStorageSpaceResponse
10846
+ */
9622
10847
  modifyDBClusterStorageSpaceWithOptions(request: ModifyDBClusterStorageSpaceRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBClusterStorageSpaceResponse>;
10848
+ /**
10849
+ * @summary Changes the storage capacity of a pay-as-you-go cluster of Enterprise Edition or a cluster of Standard Edition.
10850
+ *
10851
+ * @param request ModifyDBClusterStorageSpaceRequest
10852
+ * @return ModifyDBClusterStorageSpaceResponse
10853
+ */
9623
10854
  modifyDBClusterStorageSpace(request: ModifyDBClusterStorageSpaceRequest): Promise<ModifyDBClusterStorageSpaceResponse>;
9624
10855
  /**
9625
- * > * To perform this operation, you must activate KMS first. For more information, see [Purchase a dedicated KMS instance](~~153781~~).
9626
- * > * After TDE is enabled, you cannot disable TDE.
9627
- *
9628
- * @param request ModifyDBClusterTDERequest
9629
- * @param runtime runtime options for this request RuntimeOptions
9630
- * @return ModifyDBClusterTDEResponse
10856
+ * @summary Enables the TDE feature or changes the encryption method for a specified PolarDB for MySQL cluster.
10857
+ *
10858
+ * @description > * To perform this operation, you must activate KMS first. For more information, see [Purchase a dedicated KMS instance](https://help.aliyun.com/document_detail/153781.html).
10859
+ * > * After TDE is enabled, you cannot disable TDE.
10860
+ *
10861
+ * @param request ModifyDBClusterTDERequest
10862
+ * @param runtime runtime options for this request RuntimeOptions
10863
+ * @return ModifyDBClusterTDEResponse
9631
10864
  */
9632
10865
  modifyDBClusterTDEWithOptions(request: ModifyDBClusterTDERequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBClusterTDEResponse>;
9633
10866
  /**
9634
- * > * To perform this operation, you must activate KMS first. For more information, see [Purchase a dedicated KMS instance](~~153781~~).
9635
- * > * After TDE is enabled, you cannot disable TDE.
9636
- *
9637
- * @param request ModifyDBClusterTDERequest
9638
- * @return ModifyDBClusterTDEResponse
10867
+ * @summary Enables the TDE feature or changes the encryption method for a specified PolarDB for MySQL cluster.
10868
+ *
10869
+ * @description > * To perform this operation, you must activate KMS first. For more information, see [Purchase a dedicated KMS instance](https://help.aliyun.com/document_detail/153781.html).
10870
+ * > * After TDE is enabled, you cannot disable TDE.
10871
+ *
10872
+ * @param request ModifyDBClusterTDERequest
10873
+ * @return ModifyDBClusterTDEResponse
9639
10874
  */
9640
10875
  modifyDBClusterTDE(request: ModifyDBClusterTDERequest): Promise<ModifyDBClusterTDEResponse>;
10876
+ /**
10877
+ * @summary Modifies the description of a database in a PolarDB for MySQL cluster.
10878
+ *
10879
+ * @param request ModifyDBDescriptionRequest
10880
+ * @param runtime runtime options for this request RuntimeOptions
10881
+ * @return ModifyDBDescriptionResponse
10882
+ */
9641
10883
  modifyDBDescriptionWithOptions(request: ModifyDBDescriptionRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBDescriptionResponse>;
10884
+ /**
10885
+ * @summary Modifies the description of a database in a PolarDB for MySQL cluster.
10886
+ *
10887
+ * @param request ModifyDBDescriptionRequest
10888
+ * @return ModifyDBDescriptionResponse
10889
+ */
9642
10890
  modifyDBDescription(request: ModifyDBDescriptionRequest): Promise<ModifyDBDescriptionResponse>;
10891
+ /**
10892
+ * @summary Modifies the endpoints of a PolarDB cluster, including the primary endpoint, default cluster endpoint, custom cluster endpoint, and private domain name.
10893
+ *
10894
+ * @param request ModifyDBEndpointAddressRequest
10895
+ * @param runtime runtime options for this request RuntimeOptions
10896
+ * @return ModifyDBEndpointAddressResponse
10897
+ */
9643
10898
  modifyDBEndpointAddressWithOptions(request: ModifyDBEndpointAddressRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBEndpointAddressResponse>;
10899
+ /**
10900
+ * @summary Modifies the endpoints of a PolarDB cluster, including the primary endpoint, default cluster endpoint, custom cluster endpoint, and private domain name.
10901
+ *
10902
+ * @param request ModifyDBEndpointAddressRequest
10903
+ * @return ModifyDBEndpointAddressResponse
10904
+ */
9644
10905
  modifyDBEndpointAddress(request: ModifyDBEndpointAddressRequest): Promise<ModifyDBEndpointAddressResponse>;
10906
+ /**
10907
+ * @summary Changes the node specifications of a PolarDB cluster.
10908
+ *
10909
+ * @param request ModifyDBNodeClassRequest
10910
+ * @param runtime runtime options for this request RuntimeOptions
10911
+ * @return ModifyDBNodeClassResponse
10912
+ */
9645
10913
  modifyDBNodeClassWithOptions(request: ModifyDBNodeClassRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBNodeClassResponse>;
10914
+ /**
10915
+ * @summary Changes the node specifications of a PolarDB cluster.
10916
+ *
10917
+ * @param request ModifyDBNodeClassRequest
10918
+ * @return ModifyDBNodeClassResponse
10919
+ */
9646
10920
  modifyDBNodeClass(request: ModifyDBNodeClassRequest): Promise<ModifyDBNodeClassResponse>;
10921
+ /**
10922
+ * @summary Enables or disables a cluster node.
10923
+ *
10924
+ * @param request ModifyDBNodeHotReplicaModeRequest
10925
+ * @param runtime runtime options for this request RuntimeOptions
10926
+ * @return ModifyDBNodeHotReplicaModeResponse
10927
+ */
9647
10928
  modifyDBNodeHotReplicaModeWithOptions(request: ModifyDBNodeHotReplicaModeRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBNodeHotReplicaModeResponse>;
10929
+ /**
10930
+ * @summary Enables or disables a cluster node.
10931
+ *
10932
+ * @param request ModifyDBNodeHotReplicaModeRequest
10933
+ * @return ModifyDBNodeHotReplicaModeResponse
10934
+ */
9648
10935
  modifyDBNodeHotReplicaMode(request: ModifyDBNodeHotReplicaModeRequest): Promise<ModifyDBNodeHotReplicaModeResponse>;
10936
+ /**
10937
+ * @summary Changes the specifications of a node in a PolarDB cluster.
10938
+ *
10939
+ * @param request ModifyDBNodesClassRequest
10940
+ * @param runtime runtime options for this request RuntimeOptions
10941
+ * @return ModifyDBNodesClassResponse
10942
+ */
9649
10943
  modifyDBNodesClassWithOptions(request: ModifyDBNodesClassRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBNodesClassResponse>;
10944
+ /**
10945
+ * @summary Changes the specifications of a node in a PolarDB cluster.
10946
+ *
10947
+ * @param request ModifyDBNodesClassRequest
10948
+ * @return ModifyDBNodesClassResponse
10949
+ */
9650
10950
  modifyDBNodesClass(request: ModifyDBNodesClassRequest): Promise<ModifyDBNodesClassResponse>;
10951
+ /**
10952
+ * @summary Modifies the parameters of a node and applies them to specified nodes.
10953
+ *
10954
+ * @param request ModifyDBNodesParametersRequest
10955
+ * @param runtime runtime options for this request RuntimeOptions
10956
+ * @return ModifyDBNodesParametersResponse
10957
+ */
9651
10958
  modifyDBNodesParametersWithOptions(request: ModifyDBNodesParametersRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBNodesParametersResponse>;
10959
+ /**
10960
+ * @summary Modifies the parameters of a node and applies them to specified nodes.
10961
+ *
10962
+ * @param request ModifyDBNodesParametersRequest
10963
+ * @return ModifyDBNodesParametersResponse
10964
+ */
9652
10965
  modifyDBNodesParameters(request: ModifyDBNodesParametersRequest): Promise<ModifyDBNodesParametersResponse>;
10966
+ /**
10967
+ * @summary Modifies a Global Database Network (GDN).
10968
+ *
10969
+ * @param request ModifyGlobalDatabaseNetworkRequest
10970
+ * @param runtime runtime options for this request RuntimeOptions
10971
+ * @return ModifyGlobalDatabaseNetworkResponse
10972
+ */
9653
10973
  modifyGlobalDatabaseNetworkWithOptions(request: ModifyGlobalDatabaseNetworkRequest, runtime: $Util.RuntimeOptions): Promise<ModifyGlobalDatabaseNetworkResponse>;
10974
+ /**
10975
+ * @summary Modifies a Global Database Network (GDN).
10976
+ *
10977
+ * @param request ModifyGlobalDatabaseNetworkRequest
10978
+ * @return ModifyGlobalDatabaseNetworkResponse
10979
+ */
9654
10980
  modifyGlobalDatabaseNetwork(request: ModifyGlobalDatabaseNetworkRequest): Promise<ModifyGlobalDatabaseNetworkResponse>;
10981
+ /**
10982
+ * @summary Modifies an IP whitelist template.
10983
+ *
10984
+ * @param request ModifyGlobalSecurityIPGroupRequest
10985
+ * @param runtime runtime options for this request RuntimeOptions
10986
+ * @return ModifyGlobalSecurityIPGroupResponse
10987
+ */
9655
10988
  modifyGlobalSecurityIPGroupWithOptions(request: ModifyGlobalSecurityIPGroupRequest, runtime: $Util.RuntimeOptions): Promise<ModifyGlobalSecurityIPGroupResponse>;
10989
+ /**
10990
+ * @summary Modifies an IP whitelist template.
10991
+ *
10992
+ * @param request ModifyGlobalSecurityIPGroupRequest
10993
+ * @return ModifyGlobalSecurityIPGroupResponse
10994
+ */
9656
10995
  modifyGlobalSecurityIPGroup(request: ModifyGlobalSecurityIPGroupRequest): Promise<ModifyGlobalSecurityIPGroupResponse>;
10996
+ /**
10997
+ * @summary Modifies the name of a global IP whitelist template.
10998
+ *
10999
+ * @param request ModifyGlobalSecurityIPGroupNameRequest
11000
+ * @param runtime runtime options for this request RuntimeOptions
11001
+ * @return ModifyGlobalSecurityIPGroupNameResponse
11002
+ */
9657
11003
  modifyGlobalSecurityIPGroupNameWithOptions(request: ModifyGlobalSecurityIPGroupNameRequest, runtime: $Util.RuntimeOptions): Promise<ModifyGlobalSecurityIPGroupNameResponse>;
11004
+ /**
11005
+ * @summary Modifies the name of a global IP whitelist template.
11006
+ *
11007
+ * @param request ModifyGlobalSecurityIPGroupNameRequest
11008
+ * @return ModifyGlobalSecurityIPGroupNameResponse
11009
+ */
9658
11010
  modifyGlobalSecurityIPGroupName(request: ModifyGlobalSecurityIPGroupNameRequest): Promise<ModifyGlobalSecurityIPGroupNameResponse>;
11011
+ /**
11012
+ * @summary Modifies the relationship between a cluster and a global IP whitelist template.
11013
+ *
11014
+ * @param request ModifyGlobalSecurityIPGroupRelationRequest
11015
+ * @param runtime runtime options for this request RuntimeOptions
11016
+ * @return ModifyGlobalSecurityIPGroupRelationResponse
11017
+ */
9659
11018
  modifyGlobalSecurityIPGroupRelationWithOptions(request: ModifyGlobalSecurityIPGroupRelationRequest, runtime: $Util.RuntimeOptions): Promise<ModifyGlobalSecurityIPGroupRelationResponse>;
11019
+ /**
11020
+ * @summary Modifies the relationship between a cluster and a global IP whitelist template.
11021
+ *
11022
+ * @param request ModifyGlobalSecurityIPGroupRelationRequest
11023
+ * @return ModifyGlobalSecurityIPGroupRelationResponse
11024
+ */
9660
11025
  modifyGlobalSecurityIPGroupRelation(request: ModifyGlobalSecurityIPGroupRelationRequest): Promise<ModifyGlobalSecurityIPGroupRelationResponse>;
11026
+ /**
11027
+ * @summary Modifies the retention policy of the log backups in a PolarDB cluster.
11028
+ *
11029
+ * @param request ModifyLogBackupPolicyRequest
11030
+ * @param runtime runtime options for this request RuntimeOptions
11031
+ * @return ModifyLogBackupPolicyResponse
11032
+ */
9661
11033
  modifyLogBackupPolicyWithOptions(request: ModifyLogBackupPolicyRequest, runtime: $Util.RuntimeOptions): Promise<ModifyLogBackupPolicyResponse>;
11034
+ /**
11035
+ * @summary Modifies the retention policy of the log backups in a PolarDB cluster.
11036
+ *
11037
+ * @param request ModifyLogBackupPolicyRequest
11038
+ * @return ModifyLogBackupPolicyResponse
11039
+ */
9662
11040
  modifyLogBackupPolicy(request: ModifyLogBackupPolicyRequest): Promise<ModifyLogBackupPolicyResponse>;
11041
+ /**
11042
+ * @summary Modifies or adds a data masking rule.
11043
+ *
11044
+ * @param request ModifyMaskingRulesRequest
11045
+ * @param runtime runtime options for this request RuntimeOptions
11046
+ * @return ModifyMaskingRulesResponse
11047
+ */
9663
11048
  modifyMaskingRulesWithOptions(request: ModifyMaskingRulesRequest, runtime: $Util.RuntimeOptions): Promise<ModifyMaskingRulesResponse>;
11049
+ /**
11050
+ * @summary Modifies or adds a data masking rule.
11051
+ *
11052
+ * @param request ModifyMaskingRulesRequest
11053
+ * @return ModifyMaskingRulesResponse
11054
+ */
9664
11055
  modifyMaskingRules(request: ModifyMaskingRulesRequest): Promise<ModifyMaskingRulesResponse>;
11056
+ /**
11057
+ * @summary Modifies the switching time of a pending event.
11058
+ *
11059
+ * @param request ModifyPendingMaintenanceActionRequest
11060
+ * @param runtime runtime options for this request RuntimeOptions
11061
+ * @return ModifyPendingMaintenanceActionResponse
11062
+ */
9665
11063
  modifyPendingMaintenanceActionWithOptions(request: ModifyPendingMaintenanceActionRequest, runtime: $Util.RuntimeOptions): Promise<ModifyPendingMaintenanceActionResponse>;
11064
+ /**
11065
+ * @summary Modifies the switching time of a pending event.
11066
+ *
11067
+ * @param request ModifyPendingMaintenanceActionRequest
11068
+ * @return ModifyPendingMaintenanceActionResponse
11069
+ */
9666
11070
  modifyPendingMaintenanceAction(request: ModifyPendingMaintenanceActionRequest): Promise<ModifyPendingMaintenanceActionResponse>;
11071
+ /**
11072
+ * @summary Enables the PolarDB for AI feature for a cluster.
11073
+ *
11074
+ * @param request OpenAITaskRequest
11075
+ * @param runtime runtime options for this request RuntimeOptions
11076
+ * @return OpenAITaskResponse
11077
+ */
9667
11078
  openAITaskWithOptions(request: OpenAITaskRequest, runtime: $Util.RuntimeOptions): Promise<OpenAITaskResponse>;
11079
+ /**
11080
+ * @summary Enables the PolarDB for AI feature for a cluster.
11081
+ *
11082
+ * @param request OpenAITaskRequest
11083
+ * @return OpenAITaskResponse
11084
+ */
9668
11085
  openAITask(request: OpenAITaskRequest): Promise<OpenAITaskResponse>;
11086
+ /**
11087
+ * @summary Updates the storage usage of a cluster.
11088
+ *
11089
+ * @param request RefreshDBClusterStorageUsageRequest
11090
+ * @param runtime runtime options for this request RuntimeOptions
11091
+ * @return RefreshDBClusterStorageUsageResponse
11092
+ */
9669
11093
  refreshDBClusterStorageUsageWithOptions(request: RefreshDBClusterStorageUsageRequest, runtime: $Util.RuntimeOptions): Promise<RefreshDBClusterStorageUsageResponse>;
11094
+ /**
11095
+ * @summary Updates the storage usage of a cluster.
11096
+ *
11097
+ * @param request RefreshDBClusterStorageUsageRequest
11098
+ * @return RefreshDBClusterStorageUsageResponse
11099
+ */
9670
11100
  refreshDBClusterStorageUsage(request: RefreshDBClusterStorageUsageRequest): Promise<RefreshDBClusterStorageUsageResponse>;
9671
11101
  /**
9672
- * > You cannot remove the primary cluster from a GDN.
9673
- *
9674
- * @param request RemoveDBClusterFromGDNRequest
9675
- * @param runtime runtime options for this request RuntimeOptions
9676
- * @return RemoveDBClusterFromGDNResponse
11102
+ * @summary Removes a secondary cluster from a GDN.
11103
+ *
11104
+ * @description > You cannot remove the primary cluster from a GDN.
11105
+ *
11106
+ * @param request RemoveDBClusterFromGDNRequest
11107
+ * @param runtime runtime options for this request RuntimeOptions
11108
+ * @return RemoveDBClusterFromGDNResponse
9677
11109
  */
9678
11110
  removeDBClusterFromGDNWithOptions(request: RemoveDBClusterFromGDNRequest, runtime: $Util.RuntimeOptions): Promise<RemoveDBClusterFromGDNResponse>;
9679
11111
  /**
9680
- * > You cannot remove the primary cluster from a GDN.
9681
- *
9682
- * @param request RemoveDBClusterFromGDNRequest
9683
- * @return RemoveDBClusterFromGDNResponse
11112
+ * @summary Removes a secondary cluster from a GDN.
11113
+ *
11114
+ * @description > You cannot remove the primary cluster from a GDN.
11115
+ *
11116
+ * @param request RemoveDBClusterFromGDNRequest
11117
+ * @return RemoveDBClusterFromGDNResponse
9684
11118
  */
9685
11119
  removeDBClusterFromGDN(request: RemoveDBClusterFromGDNRequest): Promise<RemoveDBClusterFromGDNResponse>;
9686
11120
  /**
9687
- * >- Only PolarDB for MySQL clusters support this operation.
9688
- * >- If the privileged account of your cluster encounters exceptions, you can call this operation to reset the permissions. For example, the permissions are accidentally revoked.
9689
- *
9690
- * @param request ResetAccountRequest
9691
- * @param runtime runtime options for this request RuntimeOptions
9692
- * @return ResetAccountResponse
11121
+ * @summary Resets the permissions of a privileged account for a PolarDB cluster.
11122
+ *
11123
+ * @description >- Only PolarDB for MySQL clusters support this operation.
11124
+ * >- If the privileged account of your cluster encounters exceptions, you can call this operation to reset the permissions. For example, the permissions are accidentally revoked.
11125
+ *
11126
+ * @param request ResetAccountRequest
11127
+ * @param runtime runtime options for this request RuntimeOptions
11128
+ * @return ResetAccountResponse
9693
11129
  */
9694
11130
  resetAccountWithOptions(request: ResetAccountRequest, runtime: $Util.RuntimeOptions): Promise<ResetAccountResponse>;
9695
11131
  /**
9696
- * >- Only PolarDB for MySQL clusters support this operation.
9697
- * >- If the privileged account of your cluster encounters exceptions, you can call this operation to reset the permissions. For example, the permissions are accidentally revoked.
9698
- *
9699
- * @param request ResetAccountRequest
9700
- * @return ResetAccountResponse
11132
+ * @summary Resets the permissions of a privileged account for a PolarDB cluster.
11133
+ *
11134
+ * @description >- Only PolarDB for MySQL clusters support this operation.
11135
+ * >- If the privileged account of your cluster encounters exceptions, you can call this operation to reset the permissions. For example, the permissions are accidentally revoked.
11136
+ *
11137
+ * @param request ResetAccountRequest
11138
+ * @return ResetAccountResponse
9701
11139
  */
9702
11140
  resetAccount(request: ResetAccountRequest): Promise<ResetAccountResponse>;
11141
+ /**
11142
+ * @summary Rebuilds a secondary cluster in a Global Database Network (GDN).
11143
+ *
11144
+ * @param request ResetGlobalDatabaseNetworkRequest
11145
+ * @param runtime runtime options for this request RuntimeOptions
11146
+ * @return ResetGlobalDatabaseNetworkResponse
11147
+ */
9703
11148
  resetGlobalDatabaseNetworkWithOptions(request: ResetGlobalDatabaseNetworkRequest, runtime: $Util.RuntimeOptions): Promise<ResetGlobalDatabaseNetworkResponse>;
11149
+ /**
11150
+ * @summary Rebuilds a secondary cluster in a Global Database Network (GDN).
11151
+ *
11152
+ * @param request ResetGlobalDatabaseNetworkRequest
11153
+ * @return ResetGlobalDatabaseNetworkResponse
11154
+ */
9704
11155
  resetGlobalDatabaseNetwork(request: ResetGlobalDatabaseNetworkRequest): Promise<ResetGlobalDatabaseNetworkResponse>;
11156
+ /**
11157
+ * @summary 重启代理
11158
+ *
11159
+ * @param request RestartDBLinkRequest
11160
+ * @param runtime runtime options for this request RuntimeOptions
11161
+ * @return RestartDBLinkResponse
11162
+ */
9705
11163
  restartDBLinkWithOptions(request: RestartDBLinkRequest, runtime: $Util.RuntimeOptions): Promise<RestartDBLinkResponse>;
11164
+ /**
11165
+ * @summary 重启代理
11166
+ *
11167
+ * @param request RestartDBLinkRequest
11168
+ * @return RestartDBLinkResponse
11169
+ */
9706
11170
  restartDBLink(request: RestartDBLinkRequest): Promise<RestartDBLinkResponse>;
11171
+ /**
11172
+ * @summary Restarts a node in a PolarDB cluster.
11173
+ *
11174
+ * @param request RestartDBNodeRequest
11175
+ * @param runtime runtime options for this request RuntimeOptions
11176
+ * @return RestartDBNodeResponse
11177
+ */
9707
11178
  restartDBNodeWithOptions(request: RestartDBNodeRequest, runtime: $Util.RuntimeOptions): Promise<RestartDBNodeResponse>;
11179
+ /**
11180
+ * @summary Restarts a node in a PolarDB cluster.
11181
+ *
11182
+ * @param request RestartDBNodeRequest
11183
+ * @return RestartDBNodeResponse
11184
+ */
9708
11185
  restartDBNode(request: RestartDBNodeRequest): Promise<RestartDBNodeResponse>;
11186
+ /**
11187
+ * @summary Restores PolarDB databases and tables.
11188
+ *
11189
+ * @param request RestoreTableRequest
11190
+ * @param runtime runtime options for this request RuntimeOptions
11191
+ * @return RestoreTableResponse
11192
+ */
9709
11193
  restoreTableWithOptions(request: RestoreTableRequest, runtime: $Util.RuntimeOptions): Promise<RestoreTableResponse>;
11194
+ /**
11195
+ * @summary Restores PolarDB databases and tables.
11196
+ *
11197
+ * @param request RestoreTableRequest
11198
+ * @return RestoreTableResponse
11199
+ */
9710
11200
  restoreTable(request: RestoreTableRequest): Promise<RestoreTableResponse>;
11201
+ /**
11202
+ * @summary Revokes the access permissions on one or more databases from a specified PolarDB standard account.
11203
+ *
11204
+ * @param request RevokeAccountPrivilegeRequest
11205
+ * @param runtime runtime options for this request RuntimeOptions
11206
+ * @return RevokeAccountPrivilegeResponse
11207
+ */
9711
11208
  revokeAccountPrivilegeWithOptions(request: RevokeAccountPrivilegeRequest, runtime: $Util.RuntimeOptions): Promise<RevokeAccountPrivilegeResponse>;
11209
+ /**
11210
+ * @summary Revokes the access permissions on one or more databases from a specified PolarDB standard account.
11211
+ *
11212
+ * @param request RevokeAccountPrivilegeRequest
11213
+ * @return RevokeAccountPrivilegeResponse
11214
+ */
9712
11215
  revokeAccountPrivilege(request: RevokeAccountPrivilegeRequest): Promise<RevokeAccountPrivilegeResponse>;
11216
+ /**
11217
+ * @param request SwitchOverGlobalDatabaseNetworkRequest
11218
+ * @param runtime runtime options for this request RuntimeOptions
11219
+ * @return SwitchOverGlobalDatabaseNetworkResponse
11220
+ */
9713
11221
  switchOverGlobalDatabaseNetworkWithOptions(request: SwitchOverGlobalDatabaseNetworkRequest, runtime: $Util.RuntimeOptions): Promise<SwitchOverGlobalDatabaseNetworkResponse>;
11222
+ /**
11223
+ * @param request SwitchOverGlobalDatabaseNetworkRequest
11224
+ * @return SwitchOverGlobalDatabaseNetworkResponse
11225
+ */
9714
11226
  switchOverGlobalDatabaseNetwork(request: SwitchOverGlobalDatabaseNetworkRequest): Promise<SwitchOverGlobalDatabaseNetworkResponse>;
11227
+ /**
11228
+ * @param request TagResourcesRequest
11229
+ * @param runtime runtime options for this request RuntimeOptions
11230
+ * @return TagResourcesResponse
11231
+ */
9715
11232
  tagResourcesWithOptions(request: TagResourcesRequest, runtime: $Util.RuntimeOptions): Promise<TagResourcesResponse>;
11233
+ /**
11234
+ * @param request TagResourcesRequest
11235
+ * @return TagResourcesResponse
11236
+ */
9716
11237
  tagResources(request: TagResourcesRequest): Promise<TagResourcesResponse>;
11238
+ /**
11239
+ * @summary Temporarily upgrades the configuration of a PolarDB cluster or adds one or more nodes to a cluster.
11240
+ *
11241
+ * @param request TempModifyDBNodeRequest
11242
+ * @param runtime runtime options for this request RuntimeOptions
11243
+ * @return TempModifyDBNodeResponse
11244
+ */
9717
11245
  tempModifyDBNodeWithOptions(request: TempModifyDBNodeRequest, runtime: $Util.RuntimeOptions): Promise<TempModifyDBNodeResponse>;
11246
+ /**
11247
+ * @summary Temporarily upgrades the configuration of a PolarDB cluster or adds one or more nodes to a cluster.
11248
+ *
11249
+ * @param request TempModifyDBNodeRequest
11250
+ * @return TempModifyDBNodeResponse
11251
+ */
9718
11252
  tempModifyDBNode(request: TempModifyDBNodeRequest): Promise<TempModifyDBNodeResponse>;
9719
11253
  /**
9720
- * > * PolarDB clusters support the subscription and pay-as-you-go billing methods. You can change the billing method from subscription to pay-as-you-go or from pay-as-you-go to subscription based on your business requirements. For more information, see [Change the billing method from subscription to pay-as-you-go](~~172886~~) and [Change the billing method from pay-as-you-go to subscription](~~84076~~).
9721
- * >* You cannot change the billing method from pay-as-you-go to subscription if your account balance is insufficient.
9722
- * >* If you change the billing method from subscription to pay-as-you-go, the system automatically refunds the balance of the prepaid subscription fees.
9723
- *
9724
- * @param request TransformDBClusterPayTypeRequest
9725
- * @param runtime runtime options for this request RuntimeOptions
9726
- * @return TransformDBClusterPayTypeResponse
11254
+ * @summary Changes the billing method of a PolarDB cluster.
11255
+ *
11256
+ * @description > * PolarDB clusters support the subscription and pay-as-you-go billing methods. You can change the billing method from subscription to pay-as-you-go or from pay-as-you-go to subscription based on your business requirements. For more information, see [Change the billing method from subscription to pay-as-you-go](https://help.aliyun.com/document_detail/172886.html) and [Change the billing method from pay-as-you-go to subscription](https://help.aliyun.com/document_detail/84076.html).
11257
+ * >* You cannot change the billing method from pay-as-you-go to subscription if your account balance is insufficient.
11258
+ * >* If you change the billing method from subscription to pay-as-you-go, the system automatically refunds the balance of the prepaid subscription fees.
11259
+ *
11260
+ * @param request TransformDBClusterPayTypeRequest
11261
+ * @param runtime runtime options for this request RuntimeOptions
11262
+ * @return TransformDBClusterPayTypeResponse
9727
11263
  */
9728
11264
  transformDBClusterPayTypeWithOptions(request: TransformDBClusterPayTypeRequest, runtime: $Util.RuntimeOptions): Promise<TransformDBClusterPayTypeResponse>;
9729
11265
  /**
9730
- * > * PolarDB clusters support the subscription and pay-as-you-go billing methods. You can change the billing method from subscription to pay-as-you-go or from pay-as-you-go to subscription based on your business requirements. For more information, see [Change the billing method from subscription to pay-as-you-go](~~172886~~) and [Change the billing method from pay-as-you-go to subscription](~~84076~~).
9731
- * >* You cannot change the billing method from pay-as-you-go to subscription if your account balance is insufficient.
9732
- * >* If you change the billing method from subscription to pay-as-you-go, the system automatically refunds the balance of the prepaid subscription fees.
9733
- *
9734
- * @param request TransformDBClusterPayTypeRequest
9735
- * @return TransformDBClusterPayTypeResponse
11266
+ * @summary Changes the billing method of a PolarDB cluster.
11267
+ *
11268
+ * @description > * PolarDB clusters support the subscription and pay-as-you-go billing methods. You can change the billing method from subscription to pay-as-you-go or from pay-as-you-go to subscription based on your business requirements. For more information, see [Change the billing method from subscription to pay-as-you-go](https://help.aliyun.com/document_detail/172886.html) and [Change the billing method from pay-as-you-go to subscription](https://help.aliyun.com/document_detail/84076.html).
11269
+ * >* You cannot change the billing method from pay-as-you-go to subscription if your account balance is insufficient.
11270
+ * >* If you change the billing method from subscription to pay-as-you-go, the system automatically refunds the balance of the prepaid subscription fees.
11271
+ *
11272
+ * @param request TransformDBClusterPayTypeRequest
11273
+ * @return TransformDBClusterPayTypeResponse
9736
11274
  */
9737
11275
  transformDBClusterPayType(request: TransformDBClusterPayTypeRequest): Promise<TransformDBClusterPayTypeResponse>;
11276
+ /**
11277
+ * @summary Unbinds tags from PolarDB clusters.
11278
+ *
11279
+ * @param request UntagResourcesRequest
11280
+ * @param runtime runtime options for this request RuntimeOptions
11281
+ * @return UntagResourcesResponse
11282
+ */
9738
11283
  untagResourcesWithOptions(request: UntagResourcesRequest, runtime: $Util.RuntimeOptions): Promise<UntagResourcesResponse>;
11284
+ /**
11285
+ * @summary Unbinds tags from PolarDB clusters.
11286
+ *
11287
+ * @param request UntagResourcesRequest
11288
+ * @return UntagResourcesResponse
11289
+ */
9739
11290
  untagResources(request: UntagResourcesRequest): Promise<UntagResourcesResponse>;
9740
11291
  /**
9741
- * > * You can update only the revision version of a PolarDB for MySQL cluster, for example, from 8.0.1.1.3 to 8.0.1.1.4.
9742
- * >* You can use only your Alibaba Cloud account to create scheduled tasks that update the kernel version of a PolarDB for MySQL cluster. RAM users are not authorized to update the kernel version of a PolarDB for MySQL cluster.
9743
- *
9744
- * @param request UpgradeDBClusterVersionRequest
9745
- * @param runtime runtime options for this request RuntimeOptions
9746
- * @return UpgradeDBClusterVersionResponse
11292
+ * @summary Upgrades the kernel version of a PolarDB for MySQL cluster.
11293
+ *
11294
+ * @description > * You can update only the revision version of a PolarDB for MySQL cluster, for example, from 8.0.1.1.3 to 8.0.1.1.4.
11295
+ * >* You can use only your Alibaba Cloud account to create scheduled tasks that update the kernel version of a PolarDB for MySQL cluster. RAM users are not authorized to update the kernel version of a PolarDB for MySQL cluster.
11296
+ *
11297
+ * @param request UpgradeDBClusterVersionRequest
11298
+ * @param runtime runtime options for this request RuntimeOptions
11299
+ * @return UpgradeDBClusterVersionResponse
9747
11300
  */
9748
11301
  upgradeDBClusterVersionWithOptions(request: UpgradeDBClusterVersionRequest, runtime: $Util.RuntimeOptions): Promise<UpgradeDBClusterVersionResponse>;
9749
11302
  /**
9750
- * > * You can update only the revision version of a PolarDB for MySQL cluster, for example, from 8.0.1.1.3 to 8.0.1.1.4.
9751
- * >* You can use only your Alibaba Cloud account to create scheduled tasks that update the kernel version of a PolarDB for MySQL cluster. RAM users are not authorized to update the kernel version of a PolarDB for MySQL cluster.
9752
- *
9753
- * @param request UpgradeDBClusterVersionRequest
9754
- * @return UpgradeDBClusterVersionResponse
11303
+ * @summary Upgrades the kernel version of a PolarDB for MySQL cluster.
11304
+ *
11305
+ * @description > * You can update only the revision version of a PolarDB for MySQL cluster, for example, from 8.0.1.1.3 to 8.0.1.1.4.
11306
+ * >* You can use only your Alibaba Cloud account to create scheduled tasks that update the kernel version of a PolarDB for MySQL cluster. RAM users are not authorized to update the kernel version of a PolarDB for MySQL cluster.
11307
+ *
11308
+ * @param request UpgradeDBClusterVersionRequest
11309
+ * @return UpgradeDBClusterVersionResponse
9755
11310
  */
9756
11311
  upgradeDBClusterVersion(request: UpgradeDBClusterVersionRequest): Promise<UpgradeDBClusterVersionResponse>;
9757
11312
  }