tencentcloud-sdk-nodejs-intl-en
Version:
1,810 lines (1,521 loc) • 574 kB
JavaScript
/*
* Copyright (c) 2018 Tencent. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
const AbstractModel = require("../../common/abstract_model");
/**
* DescribeCrossBackupStatistical response structure.
* @class
*/
class DescribeCrossBackupStatisticalResponse extends AbstractModel {
constructor(){
super();
/**
* Real-time statistics on the total number of cross-region backup overview data entries.
* @type {number || null}
*/
this.TotalCount = null;
/**
* Real-time statistics list of cross-region backups.
* @type {Array.<CrossSummaryDetailRes> || null}
*/
this.Items = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
if (params.Items) {
this.Items = new Array();
for (let z in params.Items) {
let obj = new CrossSummaryDetailRes();
obj.deserialize(params.Items[z]);
this.Items.push(obj);
}
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
*
* @class
*/
class InstanceRenewInfo extends AbstractModel {
constructor(){
super();
/**
*
* @type {string || null}
*/
this.InstanceId = null;
/**
*
* @type {number || null}
*/
this.RenewFlag = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
this.RenewFlag = 'RenewFlag' in params ? params.RenewFlag : null;
}
}
/**
* Order information
* @class
*/
class DealInfo extends AbstractModel {
constructor(){
super();
/**
* Order name
* @type {string || null}
*/
this.DealName = null;
/**
* Number of items
* @type {number || null}
*/
this.Count = null;
/**
* ID of associated flow, which can be used to query the flow execution status
* @type {number || null}
*/
this.FlowId = null;
/**
* This field is required only for an order that creates an instance, indicating the ID of the instance created by the order
* @type {Array.<string> || null}
*/
this.InstanceIdSet = null;
/**
* Account
* @type {string || null}
*/
this.OwnerUin = null;
/**
* Instance billing type
* @type {string || null}
*/
this.InstanceChargeType = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.DealName = 'DealName' in params ? params.DealName : null;
this.Count = 'Count' in params ? params.Count : null;
this.FlowId = 'FlowId' in params ? params.FlowId : null;
this.InstanceIdSet = 'InstanceIdSet' in params ? params.InstanceIdSet : null;
this.OwnerUin = 'OwnerUin' in params ? params.OwnerUin : null;
this.InstanceChargeType = 'InstanceChargeType' in params ? params.InstanceChargeType : null;
}
}
/**
* DescribeDatabases request structure.
* @class
*/
class DescribeDatabasesRequest extends AbstractModel {
constructor(){
super();
/**
* Instance ID
* @type {Array.<string> || null}
*/
this.InstanceIdSet = null;
/**
* The number of returned entries per page in pagination mode. Value range: 1-100. The default value is 20.
* @type {number || null}
*/
this.Limit = null;
/**
* Page number in pagination mode. The default value is 0.
* @type {number || null}
*/
this.Offset = null;
/**
* Database name.
* @type {string || null}
*/
this.Name = null;
/**
* Collation rule (desc - descending order; asc - ascending order). The default value is desc.
* @type {string || null}
*/
this.OrderByType = null;
/**
* Whether TDE encryption is enabled. enable - encrypted; disable - unencrypted.
* @type {string || null}
*/
this.Encryption = null;
/**
* Sorting field. (Name - sort by name; CreateTime - sort by creation time). The default value is CreateTime.
* @type {string || null}
*/
this.OrderBy = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InstanceIdSet = 'InstanceIdSet' in params ? params.InstanceIdSet : null;
this.Limit = 'Limit' in params ? params.Limit : null;
this.Offset = 'Offset' in params ? params.Offset : null;
this.Name = 'Name' in params ? params.Name : null;
this.OrderByType = 'OrderByType' in params ? params.OrderByType : null;
this.Encryption = 'Encryption' in params ? params.Encryption : null;
this.OrderBy = 'OrderBy' in params ? params.OrderBy : null;
}
}
/**
* The target region and status of cross-region backup
* @class
*/
class CrossRegionStatus extends AbstractModel {
constructor(){
super();
/**
* The target region of cross-region backup
* @type {string || null}
*/
this.CrossRegion = null;
/**
* Synchronization status of cross-region backup. Valid values: `0` (creating), `1` (succeeded), `2`: (failed), `4` (syncing)
* @type {number || null}
*/
this.CrossStatus = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.CrossRegion = 'CrossRegion' in params ? params.CrossRegion : null;
this.CrossStatus = 'CrossStatus' in params ? params.CrossStatus : null;
}
}
/**
* StartMigrationCheck response structure.
* @class
*/
class StartMigrationCheckResponse extends AbstractModel {
constructor(){
super();
/**
* Process ID returned after the migration verification process is initiated.
* @type {number || null}
*/
this.FlowId = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.FlowId = 'FlowId' in params ? params.FlowId : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeBackupStatistical response structure.
* @class
*/
class DescribeBackupStatisticalResponse extends AbstractModel {
constructor(){
super();
/**
* Total number of instances meeting conditions. When results are returned in pagination mode, this value refers to the total number of instances that meet conditions, rather than the number of instances returned based on the specified Limit and Offset values.
* @type {number || null}
*/
this.TotalCount = null;
/**
* Instance list.
* @type {Array.<SummaryDetailRes> || null}
*/
this.Items = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
if (params.Items) {
this.Items = new Array();
for (let z in params.Items) {
let obj = new SummaryDetailRes();
obj.deserialize(params.Items[z]);
this.Items.push(obj);
}
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DeleteBackupMigration request structure.
* @class
*/
class DeleteBackupMigrationRequest extends AbstractModel {
constructor(){
super();
/**
* Target instance ID, which is returned through the API DescribeBackupMigration.
* @type {string || null}
*/
this.InstanceId = null;
/**
* Backup import task ID, which is returned through the API DescribeBackupMigration.
* @type {string || null}
*/
this.BackupMigrationId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
this.BackupMigrationId = 'BackupMigrationId' in params ? params.BackupMigrationId : null;
}
}
/**
* DescribeInstanceTasks response structure.
* @class
*/
class DescribeInstanceTasksResponse extends AbstractModel {
constructor(){
super();
/**
* Total number of asynchronous tasks.
* @type {number || null}
*/
this.TotalCount = null;
/**
* Asynchronous task information array.
* @type {Array.<InstanceTask> || null}
*/
this.InstanceTaskSet = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
if (params.InstanceTaskSet) {
this.InstanceTaskSet = new Array();
for (let z in params.InstanceTaskSet) {
let obj = new InstanceTask();
obj.deserialize(params.InstanceTaskSet[z]);
this.InstanceTaskSet.push(obj);
}
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* CreateBusinessDBInstances response structure.
* @class
*/
class CreateBusinessDBInstancesResponse extends AbstractModel {
constructor(){
super();
/**
* Order name
* @type {string || null}
*/
this.DealName = null;
/**
* Process ID Note: This field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.FlowId = null;
/**
* IDs of instances Note: This field may return null, indicating that no valid values can be obtained.
* @type {Array.<string> || null}
*/
this.InstanceIdSet = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.DealName = 'DealName' in params ? params.DealName : null;
this.FlowId = 'FlowId' in params ? params.FlowId : null;
this.InstanceIdSet = 'InstanceIdSet' in params ? params.InstanceIdSet : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* This data structure represents two databases with a publish-subscribe relationship, along with the status information of that relationship between them.
* @class
*/
class DatabaseTupleStatus extends AbstractModel {
constructor(){
super();
/**
* Publish Database Name
* @type {string || null}
*/
this.PublishDatabase = null;
/**
* Subscription Database Name
* @type {string || null}
*/
this.SubscribeDatabase = null;
/**
* Latest Synchronization Time
* @type {string || null}
*/
this.LastSyncTime = null;
/**
* Publish/Subscribe Status Between Databases: running, success, fail, unknow
* @type {string || null}
*/
this.Status = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.PublishDatabase = 'PublishDatabase' in params ? params.PublishDatabase : null;
this.SubscribeDatabase = 'SubscribeDatabase' in params ? params.SubscribeDatabase : null;
this.LastSyncTime = 'LastSyncTime' in params ? params.LastSyncTime : null;
this.Status = 'Status' in params ? params.Status : null;
}
}
/**
* DescribeDatabasesNormal request structure.
* @class
*/
class DescribeDatabasesNormalRequest extends AbstractModel {
constructor(){
super();
/**
* Instance ID, in the format of mssql-7vfv3rk3.
* @type {string || null}
*/
this.InstanceId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
}
}
/**
* ModifyDatabasePrivilege request structure.
* @class
*/
class ModifyDatabasePrivilegeRequest extends AbstractModel {
constructor(){
super();
/**
* Instance ID, in the format of mssql-njj2mtpl.
* @type {string || null}
*/
this.InstanceId = null;
/**
* Database permission change information.
* @type {Array.<DataBasePrivilegeModifyInfo> || null}
*/
this.DataBaseSet = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
if (params.DataBaseSet) {
this.DataBaseSet = new Array();
for (let z in params.DataBaseSet) {
let obj = new DataBasePrivilegeModifyInfo();
obj.deserialize(params.DataBaseSet[z]);
this.DataBaseSet.push(obj);
}
}
}
}
/**
* DescribeCollationTimeZone response structure.
* @class
*/
class DescribeCollationTimeZoneResponse extends AbstractModel {
constructor(){
super();
/**
* System character set collation list.
* @type {Array.<string> || null}
*/
this.Collation = null;
/**
* System time zone list.
* @type {Array.<string> || null}
*/
this.TimeZone = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Collation = 'Collation' in params ? params.Collation : null;
this.TimeZone = 'TimeZone' in params ? params.TimeZone : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* CreateBusinessIntelligenceFile response structure.
* @class
*/
class CreateBusinessIntelligenceFileResponse extends AbstractModel {
constructor(){
super();
/**
* File name
* @type {string || null}
*/
this.FileTaskId = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.FileTaskId = 'FileTaskId' in params ? params.FileTaskId : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Instance parameter modification record
* @class
*/
class ParamRecord extends AbstractModel {
constructor(){
super();
/**
* Instance ID
* @type {string || null}
*/
this.InstanceId = null;
/**
* Parameter name
* @type {string || null}
*/
this.ParamName = null;
/**
* Parameter value before modification
* @type {string || null}
*/
this.OldValue = null;
/**
* Parameter value after modification
* @type {string || null}
*/
this.NewValue = null;
/**
* Parameter modification status. Valid values: `1` (initializing and waiting for modification), `2` (modification succeed), `3` (modification failed), `4` (modifying)
* @type {number || null}
*/
this.Status = null;
/**
* Modification time
* @type {string || null}
*/
this.ModifyTime = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
this.ParamName = 'ParamName' in params ? params.ParamName : null;
this.OldValue = 'OldValue' in params ? params.OldValue : null;
this.NewValue = 'NewValue' in params ? params.NewValue : null;
this.Status = 'Status' in params ? params.Status : null;
this.ModifyTime = 'ModifyTime' in params ? params.ModifyTime : null;
}
}
/**
* RollbackInstance response structure.
* @class
*/
class RollbackInstanceResponse extends AbstractModel {
constructor(){
super();
/**
* The async job ID
* @type {number || null}
*/
this.FlowId = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.FlowId = 'FlowId' in params ? params.FlowId : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* List of databases to be migrated
* @class
*/
class MigrateDB extends AbstractModel {
constructor(){
super();
/**
* Name of migrated database
* @type {string || null}
*/
this.DBName = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.DBName = 'DBName' in params ? params.DBName : null;
}
}
/**
* DescribeDBCharsets response structure.
* @class
*/
class DescribeDBCharsetsResponse extends AbstractModel {
constructor(){
super();
/**
* Database character set list
* @type {Array.<string> || null}
*/
this.DatabaseCharsets = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.DatabaseCharsets = 'DatabaseCharsets' in params ? params.DatabaseCharsets : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* ModifyDBInstanceProject response structure.
* @class
*/
class ModifyDBInstanceProjectResponse extends AbstractModel {
constructor(){
super();
/**
* Number of successfully modified instances
* @type {number || null}
*/
this.Count = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Count = 'Count' in params ? params.Count : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeIncrementalMigration request structure.
* @class
*/
class DescribeIncrementalMigrationRequest extends AbstractModel {
constructor(){
super();
/**
* Backup import task ID, which is returned through the API CreateBackupMigration
* @type {string || null}
*/
this.BackupMigrationId = null;
/**
* ID of imported target instance
* @type {string || null}
*/
this.InstanceId = null;
/**
* Backup file name
* @type {string || null}
*/
this.BackupFileName = null;
/**
* Status set of import tasks
* @type {Array.<number> || null}
*/
this.StatusSet = null;
/**
* The maximum number of results returned per page. Default value: `100`.
* @type {number || null}
*/
this.Limit = null;
/**
* Page number. Default value: `0`.
* @type {number || null}
*/
this.Offset = null;
/**
* Sort by field. Valid values: `name`, `createTime`, `startTime`, `endTime`. By default, the results returned are sorted by `createTime` in the ascending order.
* @type {string || null}
*/
this.OrderBy = null;
/**
* Sorting order which is valid only when `OrderBy` is specified. Valid values: `asc` (ascending), `desc` (descending). Default value: `asc`.
* @type {string || null}
*/
this.OrderByType = null;
/**
* Incremental backup import task ID, which is returned through the `CreateIncrementalMigration` API.
* @type {string || null}
*/
this.IncrementalMigrationId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.BackupMigrationId = 'BackupMigrationId' in params ? params.BackupMigrationId : null;
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
this.BackupFileName = 'BackupFileName' in params ? params.BackupFileName : null;
this.StatusSet = 'StatusSet' in params ? params.StatusSet : null;
this.Limit = 'Limit' in params ? params.Limit : null;
this.Offset = 'Offset' in params ? params.Offset : null;
this.OrderBy = 'OrderBy' in params ? params.OrderBy : null;
this.OrderByType = 'OrderByType' in params ? params.OrderByType : null;
this.IncrementalMigrationId = 'IncrementalMigrationId' in params ? params.IncrementalMigrationId : null;
}
}
/**
* DescribeSpecSellStatus response structure.
* @class
*/
class DescribeSpecSellStatusResponse extends AbstractModel {
constructor(){
super();
/**
* Status set of specifications in different regions.
* @type {Array.<SpecSellStatus> || null}
*/
this.DescribeSpecSellStatusSet = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.DescribeSpecSellStatusSet) {
this.DescribeSpecSellStatusSet = new Array();
for (let z in params.DescribeSpecSellStatusSet) {
let obj = new SpecSellStatus();
obj.deserialize(params.DescribeSpecSellStatusSet[z]);
this.DescribeSpecSellStatusSet.push(obj);
}
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* RestoreInstance response structure.
* @class
*/
class RestoreInstanceResponse extends AbstractModel {
constructor(){
super();
/**
* Async flow task ID, which can be used to call the `DescribeFlowStatus` API to get the task execution status
* @type {number || null}
*/
this.FlowId = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.FlowId = 'FlowId' in params ? params.FlowId : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Instance Asynchronous Task
* @class
*/
class InstanceTask extends AbstractModel {
constructor(){
super();
/**
* Unique id
* @type {number || null}
*/
this.Id = null;
/**
* Job Type
* @type {number || null}
*/
this.Type = null;
/**
* Job Status
* @type {number || null}
*/
this.Status = null;
/**
* Progress Percentage 0~100
* @type {number || null}
*/
this.Progress = null;
/**
* Start Time
* @type {string || null}
*/
this.StartTime = null;
/**
* End Time
* @type {string || null}
*/
this.EndTime = null;
/**
* Error Code
* @type {number || null}
*/
this.ErrorCode = null;
/**
* Error Message Description
* @type {string || null}
*/
this.Message = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Id = 'Id' in params ? params.Id : null;
this.Type = 'Type' in params ? params.Type : null;
this.Status = 'Status' in params ? params.Status : null;
this.Progress = 'Progress' in params ? params.Progress : null;
this.StartTime = 'StartTime' in params ? params.StartTime : null;
this.EndTime = 'EndTime' in params ? params.EndTime : null;
this.ErrorCode = 'ErrorCode' in params ? params.ErrorCode : null;
this.Message = 'Message' in params ? params.Message : null;
}
}
/**
* ModifyInstanceParam request structure.
* @class
*/
class ModifyInstanceParamRequest extends AbstractModel {
constructor(){
super();
/**
* Instance ID list.
* @type {Array.<string> || null}
*/
this.InstanceIds = null;
/**
* List of modified parameters. Each list element has two fields: `Name` and `CurrentValue`. Set `Name` to the parameter name and `CurrentValue` to the new value after modification. <b>Note</b>: if the instance needs to be <b>restarted</b> for the modified parameter to take effect, it will be <b>restarted</b> immediately or during the maintenance time. Before you modify a parameter, you can use the `DescribeInstanceParams` API to query whether the instance needs to be restarted.
* @type {Array.<Parameter> || null}
*/
this.ParamList = null;
/**
* When to execute the parameter modification task. Valid values: `0` (execute immediately), `1` (execute during maintenance time). Default value: `0`.
* @type {number || null}
*/
this.WaitSwitch = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InstanceIds = 'InstanceIds' in params ? params.InstanceIds : null;
if (params.ParamList) {
this.ParamList = new Array();
for (let z in params.ParamList) {
let obj = new Parameter();
obj.deserialize(params.ParamList[z]);
this.ParamList.push(obj);
}
}
this.WaitSwitch = 'WaitSwitch' in params ? params.WaitSwitch : null;
}
}
/**
* SSL Encryption Configuration
* @class
*/
class SSLConfig extends AbstractModel {
constructor(){
super();
/**
* SSL Encryption Status
enable - Enabled
disable - Disabled
enable_doing - Enabling
disable_doing - Disabling
renew_doing - Updating
wait_doing - Waiting to be executed during maintenance window
* @type {string || null}
*/
this.Encryption = null;
/**
* SSL Certificates Validity Period, Time Format YYYY-MM-DD HH:MM:SS
* @type {string || null}
*/
this.SSLValidityPeriod = null;
/**
* SSL Certificates Validity: 0 - Invalid, 1 - Valid
* @type {number || null}
*/
this.SSLValidity = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Encryption = 'Encryption' in params ? params.Encryption : null;
this.SSLValidityPeriod = 'SSLValidityPeriod' in params ? params.SSLValidityPeriod : null;
this.SSLValidity = 'SSLValidity' in params ? params.SSLValidity : null;
}
}
/**
* DescribeFlowStatus request structure.
* @class
*/
class DescribeFlowStatusRequest extends AbstractModel {
constructor(){
super();
/**
* Flow ID
* @type {number || null}
*/
this.FlowId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.FlowId = 'FlowId' in params ? params.FlowId : null;
}
}
/**
* ModifyAccountPrivilege response structure.
* @class
*/
class ModifyAccountPrivilegeResponse extends AbstractModel {
constructor(){
super();
/**
* Async task flow ID
* @type {number || null}
*/
this.FlowId = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.FlowId = 'FlowId' in params ? params.FlowId : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* ModifyMigration response structure.
* @class
*/
class ModifyMigrationResponse extends AbstractModel {
constructor(){
super();
/**
* Migration task ID
* @type {number || null}
*/
this.MigrateId = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.MigrateId = 'MigrateId' in params ? params.MigrateId : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeInstanceTasks request structure.
* @class
*/
class DescribeInstanceTasksRequest extends AbstractModel {
constructor(){
super();
/**
* Database instance ID, in the format of mssql-njj2mtpl.
* @type {string || null}
*/
this.InstanceId = null;
/**
* Pagination size.
* @type {number || null}
*/
this.Limit = null;
/**
* Asynchronous task status. 1 - running; 2 - running successful; 3 - running failed.
* @type {number || null}
*/
this.Status = null;
/**
* Pagination offset.
* @type {number || null}
*/
this.Offset = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
this.Limit = 'Limit' in params ? params.Limit : null;
this.Status = 'Status' in params ? params.Status : null;
this.Offset = 'Offset' in params ? params.Offset : null;
}
}
/**
* DescribeDBInstances request structure.
* @class
*/
class DescribeDBInstancesRequest extends AbstractModel {
constructor(){
super();
/**
* Project ID
* @type {number || null}
*/
this.ProjectId = null;
/**
* Instance status. Valid values:
<li>1: applying</li>
<li>2: running</li>
<li>3: running restrictedly (primary/secondary switching)</li>
<li>4: isolated</li>
<li>5: repossessing</li>
<li>6: repossessed</li>
<li>7: executing task (e.g., backing up or rolling back instance)</li>
<li>8: deactivated</li>
<li>9: scaling out instance</li>
<li>10: migrating instance</li>
<li>11: read-only</li>
<li>12: restarting</li>
* @type {number || null}
*/
this.Status = null;
/**
* Page number. Default value: 0
* @type {number || null}
*/
this.Offset = null;
/**
* Number of results per page. Value range: 1-100. Default value: 100
* @type {number || null}
*/
this.Limit = null;
/**
* One or more instance IDs in the format of mssql-si2823jyl
* @type {Array.<string> || null}
*/
this.InstanceIdSet = null;
/**
* Retrieves billing type. 0: pay-as-you-go
* @type {number || null}
*/
this.PayMode = null;
/**
* Unique string-type ID of instance VPC in the format of `vpc-xxx`. If an empty string ("") is passed in, filtering will be made by basic network.
* @type {string || null}
*/
this.VpcId = null;
/**
* Unique string-type ID of instance subnet in the format of `subnet-xxx`. If an empty string ("") is passed in, filtering will be made by basic network.
* @type {string || null}
*/
this.SubnetId = null;
/**
* The list of instance private IPs, such as 172.1.0.12
* @type {Array.<string> || null}
*/
this.VipSet = null;
/**
* The list of instance names used for fuzzy match
* @type {Array.<string> || null}
*/
this.InstanceNameSet = null;
/**
* The list of instance version numbers, such as 2008R2, 2012SP3
* @type {Array.<string> || null}
*/
this.VersionSet = null;
/**
* Instance availability zone, such as ap-guangzhou-3
* @type {string || null}
*/
this.Zone = null;
/**
* The list of instance tags
* @type {Array.<string> || null}
*/
this.TagKeys = null;
/**
* Keyword used for fuzzy match, including instance ID, instance name, and instance private IP
* @type {string || null}
*/
this.SearchKey = null;
/**
* Unique Uid of an instance
* @type {Array.<string> || null}
*/
this.UidSet = null;
/**
* Instance type. HA: high-availability instance; RO: read-only instance; SI: basic edition instance; BI: business intelligence service instance; cvmHA: dual-server high-availability instance with cloud disk; cvmRO: read-only instance with cloud disk; MultiHA: multi-node instance; cvmMultiHA: multi-node instance with cloud disk.
* @type {string || null}
*/
this.InstanceType = null;
/**
* Pagination query method. offset - pagination query by offset; pageNumber - pagination query by number of pages. The default value is pageNumber.
* @type {string || null}
*/
this.PaginationType = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ProjectId = 'ProjectId' in params ? params.ProjectId : null;
this.Status = 'Status' in params ? params.Status : null;
this.Offset = 'Offset' in params ? params.Offset : null;
this.Limit = 'Limit' in params ? params.Limit : null;
this.InstanceIdSet = 'InstanceIdSet' in params ? params.InstanceIdSet : null;
this.PayMode = 'PayMode' in params ? params.PayMode : null;
this.VpcId = 'VpcId' in params ? params.VpcId : null;
this.SubnetId = 'SubnetId' in params ? params.SubnetId : null;
this.VipSet = 'VipSet' in params ? params.VipSet : null;
this.InstanceNameSet = 'InstanceNameSet' in params ? params.InstanceNameSet : null;
this.VersionSet = 'VersionSet' in params ? params.VersionSet : null;
this.Zone = 'Zone' in params ? params.Zone : null;
this.TagKeys = 'TagKeys' in params ? params.TagKeys : null;
this.SearchKey = 'SearchKey' in params ? params.SearchKey : null;
this.UidSet = 'UidSet' in params ? params.UidSet : null;
this.InstanceType = 'InstanceType' in params ? params.InstanceType : null;
this.PaginationType = 'PaginationType' in params ? params.PaginationType : null;
}
}
/**
* ModifyDBInstanceRenewFlag response structure.
* @class
*/
class ModifyDBInstanceRenewFlagResponse extends AbstractModel {
constructor(){
super();
/**
* Number of instances whose renewal flags are modified successfully.
* @type {number || null}
*/
this.Count = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Count = 'Count' in params ? params.Count : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Information of purchasable specification for an instance
* @class
*/
class SpecInfo extends AbstractModel {
constructor(){
super();
/**
* Instance specification ID. The `SpecId` returned by `DescribeZones` together with the purchasable specification information returned by `DescribeProductConfig` can be used to find out what specifications can be purchased in a specified AZ
* @type {number || null}
*/
this.SpecId = null;
/**
* Model ID
* @type {string || null}
*/
this.MachineType = null;
/**
* Model name
* @type {string || null}
*/
this.MachineTypeName = null;
/**
* Database version information. Valid values: 2008R2 (SQL Server 2008 Enterprise), 2012SP3 (SQL Server 2012 Enterprise), 2016SP1 (SQL Server 2016 Enterprise), 201602 (SQL Server 2016 Standard), 2017 (SQL Server 2017 Enterprise)
* @type {string || null}
*/
this.Version = null;
/**
* Version name corresponding to the `Version` field
* @type {string || null}
*/
this.VersionName = null;
/**
* Memory size in GB
* @type {number || null}
*/
this.Memory = null;
/**
* Number of CPU cores
* @type {number || null}
*/
this.CPU = null;
/**
* Minimum disk size under this specification in GB
* @type {number || null}
*/
this.MinStorage = null;
/**
* Maximum disk size under this specification in GB
* @type {number || null}
*/
this.MaxStorage = null;
/**
* QPS of this specification
* @type {number || null}
*/
this.QPS = null;
/**
* Description of this specification
* @type {string || null}
*/
this.SuitInfo = null;
/**
* Pid of this specification
* @type {number || null}
*/
this.Pid = null;
/**
* Pay-as-you-go Pid list corresponding to this specification
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<number> || null}
*/
this.PostPid = null;
/**
* Billing mode under this specification. POST: pay-as-you-go
* @type {string || null}
*/
this.PayModeStatus = null;
/**
* Instance type. Valid values: HA (High-Availability Edition, including dual-server high availability and AlwaysOn cluster), RO (read-only replica), SI (Basic Edition)
* @type {string || null}
*/
this.InstanceType = null;
/**
* Whether multi-AZ deployment is supported. Valid values: MultiZones (only multi-AZ deployment is supported), SameZones (only single-AZ deployment is supported), ALL (both deployments are supported)
* @type {string || null}
*/
this.MultiZonesStatus = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.SpecId = 'SpecId' in params ? params.SpecId : null;
this.MachineType = 'MachineType' in params ? params.MachineType : null;
this.MachineTypeName = 'MachineTypeName' in params ? params.MachineTypeName : null;
this.Version = 'Version' in params ? params.Version : null;
this.VersionName = 'VersionName' in params ? params.VersionName : null;
this.Memory = 'Memory' in params ? params.Memory : null;
this.CPU = 'CPU' in params ? params.CPU : null;
this.MinStorage = 'MinStorage' in params ? params.MinStorage : null;
this.MaxStorage = 'MaxStorage' in params ? params.MaxStorage : null;
this.QPS = 'QPS' in params ? params.QPS : null;
this.SuitInfo = 'SuitInfo' in params ? params.SuitInfo : null;
this.Pid = 'Pid' in params ? params.Pid : null;
this.PostPid = 'PostPid' in params ? params.PostPid : null;
this.PayModeStatus = 'PayModeStatus' in params ? params.PayModeStatus : null;
this.InstanceType = 'InstanceType' in params ? params.InstanceType : null;
this.MultiZonesStatus = 'MultiZonesStatus' in params ? params.MultiZonesStatus : null;
}
}
/**
* ModifyBackupName response structure.
* @class
*/
class ModifyBackupNameResponse extends AbstractModel {
constructor(){
super();
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* CreateReadOnlyDBInstances request structure.
* @class
*/
class CreateReadOnlyDBInstancesRequest extends AbstractModel {
constructor(){
super();
/**
* Instance ID in the format of `mssql-3l3fgqn7`.
* @type {string || null}
*/
this.InstanceId = null;
/**
* Instance AZ, such as `ap-guangzhou-1` (Guangzhou Zone 1). Purchasable AZs for an instance can be obtained through the`DescribeZones` API.
* @type {string || null}
*/
this.Zone = null;
/**
* Read-only group types. Valid values: `1` (each read-only replica is placed in one auto-created read-only group), `2` (all read-only replicas are placed in one auto-created read-only group), `3` (all read-only replicas are placed in one existing read-only group).
* @type {number || null}
*/
this.ReadOnlyGroupType = null;
/**
* Instance memory size in GB.
* @type {number || null}
*/
this.Memory = null;
/**
* Instance disk size in GB.
* @type {number || null}
*/
this.Storage = null;
/**
* Valid values: `0` (not upgrade the primary instance by default), `1` (upgrade the primary instance to complete the RO deployment). You need to pass in `1` for this parameter and upgrade the primary instance to cluster edition.
* @type {number || null}
*/
this.ReadOnlyGroupForcedUpgrade = null;
/**
* Existing read-only group ID, which is required when `ReadOnlyGroupType` is `3`.
* @type {string || null}
*/
this.ReadOnlyGroupId = null;
/**
* New read-only group ID, which is required when `ReadOnlyGroupType` is `2`.
* @type {string || null}
*/
this.ReadOnlyGroupName = null;
/**
* Whether delayed read-only instance removal is enabled in a new read-only group, which is required when `ReadOnlyGroupType` is `2`. Valid values: `1` (enabled), `0` (disabled). The read-only replica will be automatically removed when the delay between it and the primary instance exceeds the threshold.
* @type {number || null}
*/
this.ReadOnlyGroupIsOfflineDelay = null;
/**
* The delay threshold for a new read-only group, which is required when `ReadOnlyGroupType` is `2` and `ReadOnlyGroupIsOfflineDelay` is `1`.
* @type {number || null}
*/
this.ReadOnlyGroupMaxDelayTime = null;
/**
* Minimum number of reserved read-only replicas when the delayed removal is enabled for the new read-only group, which is required when `ReadOnlyGroupType` is `2` and `ReadOnlyGroupIsOfflineDelay` is `1`.
* @type {number || null}
*/
this.ReadOnlyGroupMinInGroup = null;
/**
* Billing mode. Valid values: `PREPAID` (monthly subscription), `POSTPAID` (pay-as-you-go).
* @type {string || null}
*/
this.InstanceChargeType = null;
/**
* Number of read-only instances to be purchased this time. Default value: `2`.
* @type {number || null}
*/
this.GoodsNum = null;
/**
* VPC subnet ID in the format of `subnet-bdoe83fa`. Both `SubnetId` and `VpcId` need to be set or unset at the same time.
* @type {string || null}
*/
this.SubnetId = null;
/**
* VPC ID in the format of `vpc-dsp338hz`