@alicloud/polardb20170801 5.0.6 → 5.1.1

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