tencentcloud-sdk-nodejs-intl-en
Version:
1,900 lines (1,589 loc) • 259 kB
JavaScript
/*
* Copyright (c) 2018 THL A29 Limited, a Tencent company. 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");
/**
* InitDCDBInstances response structure.
* @class
*/
class InitDCDBInstancesResponse extends AbstractModel {
constructor(){
super();
/**
* Async task ID. The task status can be queried through the `DescribeFlow` API.
* @type {Array.<number> || null}
*/
this.FlowIds = null;
/**
* Passed through from input parameters.
* @type {Array.<string> || null}
*/
this.InstanceIds = 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.FlowIds = 'FlowIds' in params ? params.FlowIds : null;
this.InstanceIds = 'InstanceIds' in params ? params.InstanceIds : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeDBTmpInstances request structure.
* @class
*/
class DescribeDBTmpInstancesRequest extends AbstractModel {
constructor(){
super();
/**
* The instance ID
* @type {string || null}
*/
this.InstanceId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
}
}
/**
* DescribeAccountPrivileges response structure.
* @class
*/
class DescribeAccountPrivilegesResponse extends AbstractModel {
constructor(){
super();
/**
* Instance ID
* @type {string || null}
*/
this.InstanceId = null;
/**
* Permission list
* @type {Array.<string> || null}
*/
this.Privileges = null;
/**
* Database account username
* @type {string || null}
*/
this.UserName = null;
/**
* Database account host
* @type {string || null}
*/
this.Host = 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.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
this.Privileges = 'Privileges' in params ? params.Privileges : null;
this.UserName = 'UserName' in params ? params.UserName : null;
this.Host = 'Host' in params ? params.Host : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeDatabases request structure.
* @class
*/
class DescribeDatabasesRequest extends AbstractModel {
constructor(){
super();
/**
* Instance ID in the format of dcdbt-ow7t8lmc.
* @type {string || null}
*/
this.InstanceId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
}
}
/**
* Database parameter description
* @class
*/
class ParamDesc extends AbstractModel {
constructor(){
super();
/**
* Parameter name
* @type {string || null}
*/
this.Param = null;
/**
* Current parameter value
* @type {string || null}
*/
this.Value = null;
/**
* Previously set value, which is the same as `value` after the parameter takes effect. If no value has been set, this field will not be returned.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.SetValue = null;
/**
* Default value
* @type {string || null}
*/
this.Default = null;
/**
* Parameter constraint
* @type {ParamConstraint || null}
*/
this.Constraint = null;
/**
* Whether a value has been set. false: no, true: yes.
* @type {boolean || null}
*/
this.HaveSetValue = null;
/**
* Whether restart is required. false: no;
true: yes.
* @type {boolean || null}
*/
this.NeedRestart = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Param = 'Param' in params ? params.Param : null;
this.Value = 'Value' in params ? params.Value : null;
this.SetValue = 'SetValue' in params ? params.SetValue : null;
this.Default = 'Default' in params ? params.Default : null;
if (params.Constraint) {
let obj = new ParamConstraint();
obj.deserialize(params.Constraint)
this.Constraint = obj;
}
this.HaveSetValue = 'HaveSetValue' in params ? params.HaveSetValue : null;
this.NeedRestart = 'NeedRestart' in params ? params.NeedRestart : null;
}
}
/**
* DestroyDCDBInstance response structure.
* @class
*/
class DestroyDCDBInstanceResponse extends AbstractModel {
constructor(){
super();
/**
* Instance ID, which is the same as the request parameter `InstanceId`.
* @type {string || null}
*/
this.InstanceId = null;
/**
* Async task ID, which can be used in the [DescribeFlow](https://intl.cloud.tencent.com/document/product/557/56485?from_cn_redirect=1) API to query the async task result.
* @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.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
this.FlowId = 'FlowId' in params ? params.FlowId : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeDBParameters request structure.
* @class
*/
class DescribeDBParametersRequest extends AbstractModel {
constructor(){
super();
/**
* Instance ID in the format of dcdbt-ow7t8lmc.
* @type {string || null}
*/
this.InstanceId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
}
}
/**
* DescribeAccounts request structure.
* @class
*/
class DescribeAccountsRequest extends AbstractModel {
constructor(){
super();
/**
* Instance ID in the format of dcdbt-ow728lmc.
* @type {string || null}
*/
this.InstanceId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
}
}
/**
* UpgradeHourDCDBInstance response structure.
* @class
*/
class UpgradeHourDCDBInstanceResponse 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;
}
}
/**
* ActiveHourDCDBInstance response structure.
* @class
*/
class ActiveHourDCDBInstanceResponse extends AbstractModel {
constructor(){
super();
/**
* IDs of instances removed from isolation
* @type {Array.<string> || null}
*/
this.SuccessInstanceIds = null;
/**
* IDs of instances failed to be removed from isolation
* @type {Array.<string> || null}
*/
this.FailedInstanceIds = 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.SuccessInstanceIds = 'SuccessInstanceIds' in params ? params.SuccessInstanceIds : null;
this.FailedInstanceIds = 'FailedInstanceIds' in params ? params.FailedInstanceIds : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeDCDBPrice response structure.
* @class
*/
class DescribeDCDBPriceResponse extends AbstractModel {
constructor(){
super();
/**
* Original price
* Unit: Cent (default). If the request parameter contains `AmountUnit`, see `AmountUnit` description.
* Currency: CNY (Chinese site), USD (international site)
* @type {number || null}
*/
this.OriginalPrice = null;
/**
* The actual price may be different from the original price due to discounts.
* Unit: Cent (default). If the request parameter contains `AmountUnit`, see `AmountUnit` description.
* Currency: CNY (Chinese site), USD (international site)
* @type {number || null}
*/
this.Price = 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.OriginalPrice = 'OriginalPrice' in params ? params.OriginalPrice : null;
this.Price = 'Price' in params ? params.Price : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* ModifyInstanceVport response structure.
* @class
*/
class ModifyInstanceVportResponse 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;
}
}
/**
* DescribeDCDBInstanceDetail request structure.
* @class
*/
class DescribeDCDBInstanceDetailRequest extends AbstractModel {
constructor(){
super();
/**
* Instance ID, such as dcdbt-7oaxtcb7.
* @type {string || null}
*/
this.InstanceId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
}
}
/**
* ModifyInstanceVip response structure.
* @class
*/
class ModifyInstanceVipResponse 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;
}
}
/**
* AssociateSecurityGroups request structure.
* @class
*/
class AssociateSecurityGroupsRequest extends AbstractModel {
constructor(){
super();
/**
* Database engine name. Valid value: `dcdb`.
* @type {string || null}
*/
this.Product = null;
/**
* ID of the security group to be associated in the format of sg-efil73jd.
* @type {string || null}
*/
this.SecurityGroupId = null;
/**
* ID(s) of the instance(s) to be associated in the format of tdsqlshard-lesecurk. You can specify multiple instances.
* @type {Array.<string> || null}
*/
this.InstanceIds = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Product = 'Product' in params ? params.Product : null;
this.SecurityGroupId = 'SecurityGroupId' in params ? params.SecurityGroupId : null;
this.InstanceIds = 'InstanceIds' in params ? params.InstanceIds : null;
}
}
/**
* TDSQL shard information
* @class
*/
class ShardBriefInfo extends AbstractModel {
constructor(){
super();
/**
* Shard serial ID
* @type {string || null}
*/
this.ShardSerialId = null;
/**
* Shard ID, such as shard-7vg1o339.
* @type {string || null}
*/
this.ShardInstanceId = null;
/**
* Shard running status
* @type {number || null}
*/
this.Status = null;
/**
* Description of shard running status
* @type {string || null}
*/
this.StatusDesc = null;
/**
* Shard creation time
* @type {string || null}
*/
this.CreateTime = null;
/**
* Shard memory size in GB
* @type {number || null}
*/
this.Memory = null;
/**
* Shard disk size in GB
* @type {number || null}
*/
this.Storage = null;
/**
* Log disk space size of a shard in GB
* @type {number || null}
*/
this.LogDisk = null;
/**
* Number of shard nodes
* @type {number || null}
*/
this.NodeCount = null;
/**
* Disk space utilization of a shard
* @type {number || null}
*/
this.StorageUsage = null;
/**
* Version information of the shard proxy
* @type {string || null}
*/
this.ProxyVersion = null;
/**
* Source AZ of a shard
* @type {string || null}
*/
this.ShardMasterZone = null;
/**
* Replica AZ of a shard
* @type {Array.<string> || null}
*/
this.ShardSlaveZones = null;
/**
* Number of CPU cores
* @type {number || null}
*/
this.Cpu = null;
/**
* Node information
Note: This field may return null, indicating that no valid values can be obtained.
* @type {Array.<NodeInfo> || null}
*/
this.NodesInfo = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ShardSerialId = 'ShardSerialId' in params ? params.ShardSerialId : null;
this.ShardInstanceId = 'ShardInstanceId' in params ? params.ShardInstanceId : null;
this.Status = 'Status' in params ? params.Status : null;
this.StatusDesc = 'StatusDesc' in params ? params.StatusDesc : null;
this.CreateTime = 'CreateTime' in params ? params.CreateTime : null;
this.Memory = 'Memory' in params ? params.Memory : null;
this.Storage = 'Storage' in params ? params.Storage : null;
this.LogDisk = 'LogDisk' in params ? params.LogDisk : null;
this.NodeCount = 'NodeCount' in params ? params.NodeCount : null;
this.StorageUsage = 'StorageUsage' in params ? params.StorageUsage : null;
this.ProxyVersion = 'ProxyVersion' in params ? params.ProxyVersion : null;
this.ShardMasterZone = 'ShardMasterZone' in params ? params.ShardMasterZone : null;
this.ShardSlaveZones = 'ShardSlaveZones' in params ? params.ShardSlaveZones : null;
this.Cpu = 'Cpu' in params ? params.Cpu : null;
if (params.NodesInfo) {
this.NodesInfo = new Array();
for (let z in params.NodesInfo) {
let obj = new NodeInfo();
obj.deserialize(params.NodesInfo[z]);
this.NodesInfo.push(obj);
}
}
}
}
/**
* DescribeDBSecurityGroups response structure.
* @class
*/
class DescribeDBSecurityGroupsResponse extends AbstractModel {
constructor(){
super();
/**
* Security group details
* @type {Array.<SecurityGroup> || null}
*/
this.Groups = null;
/**
* Instance VIP
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.VIP = null;
/**
* Instance Port
Note: This field may return null, indicating that no valid value can be obtained.
* @type {string || null}
*/
this.VPort = 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.Groups) {
this.Groups = new Array();
for (let z in params.Groups) {
let obj = new SecurityGroup();
obj.deserialize(params.Groups[z]);
this.Groups.push(obj);
}
}
this.VIP = 'VIP' in params ? params.VIP : null;
this.VPort = 'VPort' in params ? params.VPort : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* CancelDcnJob response structure.
* @class
*/
class CancelDcnJobResponse extends AbstractModel {
constructor(){
super();
/**
* Task 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;
}
}
/**
* DescribeFileDownloadUrl request structure.
* @class
*/
class DescribeFileDownloadUrlRequest extends AbstractModel {
constructor(){
super();
/**
* Instance ID
* @type {string || null}
*/
this.InstanceId = null;
/**
* Shard ID
* @type {string || null}
*/
this.ShardId = null;
/**
* Unsigned file path
* @type {string || null}
*/
this.FilePath = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
this.ShardId = 'ShardId' in params ? params.ShardId : null;
this.FilePath = 'FilePath' in params ? params.FilePath : null;
}
}
/**
* DescribeDBSyncMode response structure.
* @class
*/
class DescribeDBSyncModeResponse extends AbstractModel {
constructor(){
super();
/**
* Sync mode. 0: async; 1: strong sync; 2: downgradable strong sync
* @type {number || null}
*/
this.SyncMode = null;
/**
* Whether a modification is in progress. 1: yes; 0: no.
* @type {number || null}
*/
this.IsModifying = null;
/**
* Current sync mode. Valid values: `0` (async), `1` (sync).
* @type {number || null}
*/
this.CurrentSyncMode = 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.SyncMode = 'SyncMode' in params ? params.SyncMode : null;
this.IsModifying = 'IsModifying' in params ? params.IsModifying : null;
this.CurrentSyncMode = 'CurrentSyncMode' in params ? params.CurrentSyncMode : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeProjectSecurityGroups request structure.
* @class
*/
class DescribeProjectSecurityGroupsRequest extends AbstractModel {
constructor(){
super();
/**
* Database engine name. Valid value: `dcdb`.
* @type {string || null}
*/
this.Product = null;
/**
* Project ID
* @type {number || null}
*/
this.ProjectId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Product = 'Product' in params ? params.Product : null;
this.ProjectId = 'ProjectId' in params ? params.ProjectId : null;
}
}
/**
* DescribeDBSlowLogs request structure.
* @class
*/
class DescribeDBSlowLogsRequest extends AbstractModel {
constructor(){
super();
/**
* Instance ID in the format of dcdbt-hw0qj6m1
* @type {string || null}
*/
this.InstanceId = null;
/**
* Data entry number starting from which to return results
* @type {number || null}
*/
this.Offset = null;
/**
* Number of results to be returned
* @type {number || null}
*/
this.Limit = null;
/**
* Query start time in the format of 2016-07-23 14:55:20
* @type {string || null}
*/
this.StartTime = null;
/**
* Shard ID of the instance in the format of shard-53ima8ln
* @type {string || null}
*/
this.ShardId = null;
/**
* Query end time in the format of 2016-08-22 14:55:20. If this parameter is left empty, the current time will be used as the query end time.
* @type {string || null}
*/
this.EndTime = null;
/**
* Specific name of the database to be queried
* @type {string || null}
*/
this.Db = null;
/**
* Sorting metric. Valid values: `query_time_sum`, `query_count`. Default value: `query_time_sum`
* @type {string || null}
*/
this.OrderBy = null;
/**
* Sorting order. Valid values: `desc` (descending), `asc` (ascending). Default value: `desc`
* @type {string || null}
*/
this.OrderByType = null;
/**
* Query slow queries from either the source or the replica. Valid values: `0` (source), `1` (replica). Default value: `0`
* @type {number || null}
*/
this.Slave = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
this.Offset = 'Offset' in params ? params.Offset : null;
this.Limit = 'Limit' in params ? params.Limit : null;
this.StartTime = 'StartTime' in params ? params.StartTime : null;
this.ShardId = 'ShardId' in params ? params.ShardId : null;
this.EndTime = 'EndTime' in params ? params.EndTime : null;
this.Db = 'Db' in params ? params.Db : null;
this.OrderBy = 'OrderBy' in params ? params.OrderBy : null;
this.OrderByType = 'OrderByType' in params ? params.OrderByType : null;
this.Slave = 'Slave' in params ? params.Slave : null;
}
}
/**
* CreateAccount request structure.
* @class
*/
class CreateAccountRequest extends AbstractModel {
constructor(){
super();
/**
* Instance ID in the format of dcdbt-ow728lmc, which can be obtained through the `DescribeDCDBInstances` API.
* @type {string || null}
*/
this.InstanceId = null;
/**
* AccountName
* @type {string || null}
*/
this.UserName = null;
/**
* Host that can be logged in to, which is in the same format as the host of the MySQL account and supports wildcards, such as %, 10.%, and 10.20.%.
* @type {string || null}
*/
this.Host = null;
/**
* Account password. It must contain 8-32 characters in all of the following four types: lowercase letters, uppercase letters, digits, and symbols (()~!@#$%^&*-+=_|{}[]:<>,.?/), and cannot start with a slash (/).
* @type {string || null}
*/
this.Password = null;
/**
* Whether to create a read-only account. 0: no; 1: for the account's SQL requests, the secondary will be used first, and if it is unavailable, the primary will be used; 2: the secondary will be used first, and if it is unavailable, the operation will fail; 3: only the secondary will be read from.
* @type {number || null}
*/
this.ReadOnly = null;
/**
* Account remarks, which can contain 0-256 letters, digits, and common symbols.
* @type {string || null}
*/
this.Description = null;
/**
* If the secondary delay exceeds the set value of this parameter, the secondary will be deemed to have failed.
It is recommended that this parameter be set to a value greater than 10. This parameter takes effect when `ReadOnly` is 1 or 2.
* @type {number || null}
*/
this.DelayThresh = null;
/**
* Whether to specify a replica server for read-only account. Valid values: `0` (No replica server is specified, which means that the proxy will select another available replica server to keep connection with the client if the current replica server doesn’t meet the requirement). `1` (The replica server is specified, which means that the connection will be disconnected if the specified replica server doesn’t meet the requirement.)
* @type {number || null}
*/
this.SlaveConst = null;
/**
* Maximum number of connections. If left empty or `0` is passed in, the connections will be unlimited. This parameter configuration is not supported for kernel version 10.1.
* @type {number || null}
*/
this.MaxUserConnections = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
this.UserName = 'UserName' in params ? params.UserName : null;
this.Host = 'Host' in params ? params.Host : null;
this.Password = 'Password' in params ? params.Password : null;
this.ReadOnly = 'ReadOnly' in params ? params.ReadOnly : null;
this.Description = 'Description' in params ? params.Description : null;
this.DelayThresh = 'DelayThresh' in params ? params.DelayThresh : null;
this.SlaveConst = 'SlaveConst' in params ? params.SlaveConst : null;
this.MaxUserConnections = 'MaxUserConnections' in params ? params.MaxUserConnections : null;
}
}
/**
* UpgradeDedicatedDCDBInstance response structure.
* @class
*/
class UpgradeDedicatedDCDBInstanceResponse 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;
}
}
/**
* CreateOnlineDDLJob response structure.
* @class
*/
class CreateOnlineDDLJobResponse extends AbstractModel {
constructor(){
super();
/**
* Online DDL task 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;
}
}
/**
* DescribeDBParameters response structure.
* @class
*/
class DescribeDBParametersResponse extends AbstractModel {
constructor(){
super();
/**
* Instance ID in the format of dcdbt-ow7t8lmc.
* @type {string || null}
*/
this.InstanceId = null;
/**
* Requests the current parameter values of the database
* @type {Array.<ParamDesc> || null}
*/
this.Params = 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.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
if (params.Params) {
this.Params = new Array();
for (let z in params.Params) {
let obj = new ParamDesc();
obj.deserialize(params.Params[z]);
this.Params.push(obj);
}
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeBackupFiles request structure.
* @class
*/
class DescribeBackupFilesRequest extends AbstractModel {
constructor(){
super();
/**
* Query by instance ID
* @type {string || null}
*/
this.InstanceId = null;
/**
* Query by shard ID
* @type {string || null}
*/
this.ShardId = null;
/**
* Backup type. Valid values: `Data` (data backup), `Binlog` (Binlog backup), `Errlog` (error log), `Slowlog` (slow log).
* @type {string || null}
*/
this.BackupType = null;
/**
* Query by start time
* @type {string || null}
*/
this.StartTime = null;
/**
* Query by end time
* @type {string || null}
*/
this.EndTime = null;
/**
* Pagination parameter
* @type {number || null}
*/
this.Limit = null;
/**
* Pagination parameter
* @type {number || null}
*/
this.Offset = null;
/**
* Sorting dimension. Valid values: `Time`, `Size`.
* @type {string || null}
*/
this.OrderBy = null;
/**
* Sorting order. Valid values: `DESC`, `ASC`.
* @type {string || null}
*/
this.OrderType = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
this.ShardId = 'ShardId' in params ? params.ShardId : null;
this.BackupType = 'BackupType' in params ? params.BackupType : null;
this.StartTime = 'StartTime' in params ? params.StartTime : null;
this.EndTime = 'EndTime' in params ? params.EndTime : 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.OrderType = 'OrderType' in params ? params.OrderType : null;
}
}
/**
* IsolateHourDCDBInstance request structure.
* @class
*/
class IsolateHourDCDBInstanceRequest extends AbstractModel {
constructor(){
super();
/**
* ID list of the instances to be upgraded in the format of `dcdbt-ow728lmc`, which can be obtained through the `DescribeDCDBInstances` API.
* @type {Array.<string> || null}
*/
this.InstanceIds = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InstanceIds = 'InstanceIds' in params ? params.InstanceIds : null;
}
}
/**
* ModifyDBInstanceName response structure.
* @class
*/
class ModifyDBInstanceNameResponse extends AbstractModel {
constructor(){
super();
/**
* Instance ID.
* @type {string || null}
*/
this.InstanceId = 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.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeFlow response structure.
* @class
*/
class DescribeFlowResponse extends AbstractModel {
constructor(){
super();
/**
* Task status. Valid values: `0` (succeeded), `1` (failed), `2` (running)
* @type {number || null}
*/
this.Status = 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.Status = 'Status' in params ? params.Status : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* UpgradeHourDCDBInstance request structure.
* @class
*/
class UpgradeHourDCDBInstanceRequest extends AbstractModel {
constructor(){
super();
/**
* Instance ID to be upgraded in the format of dcdbt-ow728lmc, which can be obtained through the `DescribeDCDBInstances` API.
* @type {string || null}
*/
this.InstanceId = null;
/**
* Upgrade type. Valid values:
<li> `ADD`: Add a new shard </li>
<li> `EXPAND`: Upgrade the existing shads</li>
<li> `SPLIT`: Split data of the existing shads to the new ones</li>
* @type {string || null}
*/
this.UpgradeType = null;
/**
* Add shards when `UpgradeType` is `ADD`.
* @type {AddShardConfig || null}
*/
this.AddShardConfig = null;
/**
* Expand shard when `UpgradeType` is `EXPAND`.
* @type {ExpandShardConfig || null}
*/
this.ExpandShardConfig = null;
/**
* Split shard when `UpgradeType` is `SPLIT`.
* @type {SplitShardConfig || null}
*/
this.SplitShardConfig = null;
/**
* Switch start time in the format of "2019-12-12 07:00:00", which is no less than one hour and within 3 days from the current time.
* @type {string || null}
*/
this.SwitchStartTime = null;
/**
* Switch end time in the format of "2019-12-12 07:15:00", which must be later than the start time.
* @type {string || null}
*/
this.SwitchEndTime = null;
/**
* Whether to retry automatically. Valid values: `0` (no), `1` (yes).
* @type {number || null}
*/
this.SwitchAutoRetry = null;
/**
* The list of new AZs specified in deployment modification. The first one is the source AZ, and the rest are replica AZs.
* @type {Array.<string> || null}
*/
this.Zones = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
this.UpgradeType = 'UpgradeType' in params ? params.UpgradeType : null;
if (params.AddShardConfig) {
let obj = new AddShardConfig();
obj.deserialize(params.AddShardConfig)
this.AddShardConfig = obj;
}
if (params.ExpandShardConfig) {
let obj = new ExpandShardConfig();
obj.deserialize(params.ExpandShardConfig)
this.ExpandShardConfig = obj;
}
if (params.SplitShardConfig) {
let obj = new SplitShardConfig();
obj.deserialize(params.SplitShardConfig)
this.SplitShardConfig = obj;
}
this.SwitchStartTime = 'SwitchStartTime' in params ? params.SwitchStartTime : null;
this.SwitchEndTime = 'SwitchEndTime' in params ? params.SwitchEndTime : null;
this.SwitchAutoRetry = 'SwitchAutoRetry' in params ? params.SwitchAutoRetry : null;
this.Zones = 'Zones' in params ? params.Zones : null;
}
}
/**
* CloneAccount response structure.
* @class
*/
class CloneAccountResponse 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;
}
}
/**
* IsolateDCDBInstance request structure.
* @class
*/
class IsolateDCDBInstanceRequest extends AbstractModel {
constructor(){
super();
/**
* Instance ID in the format of `tdsqlshard-avw0207d`, which is the same as the instance ID displayed on the TencentDB console and can be queried through the `DescribeDBInstances` API.
* @type {Array.<string> || null}
*/
this.InstanceIds = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InstanceIds = 'InstanceIds' in params ? params.InstanceIds : null;
}
}
/**
* IsolateDedicatedDBInstance request structure.
* @class
*/
class IsolateDedicatedDBInstanceRequest extends AbstractModel {
constructor(){
super();
/**
* Instance ID in the format of `dcdbt-ow728lmc`
* @type {string || null}
*/
this.InstanceId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
}
}
/**
* ModifyAccountDescription response structure.
* @class
*/
class ModifyAccountDescriptionResponse 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;
}
}
/**
* DestroyDCDBInstance request structure.
* @class
*/
class DestroyDCDBInstanceRequest extends AbstractModel {
constructor(){
super();
/**
* Instance ID in the format of tdsqlshard-c1nl9rpv. It is the same as the instance ID displayed in the TencentDB console.
* @type {string || null}
*/
this.InstanceId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
}
}
/**
* CreateDCDBInstance response structure.
* @class
*/
class CreateDCDBInstanceResponse extends AbstractModel {
constructor(){
super();
/**
* Long order ID, which is used to call the `DescribeOrders` API.
The parameter can be used to either query order details or call the user account APIs to make another payment when this payment fails.
* @type {string || null}
*/
this.DealName = null;
/**
* IDs of the instances you have purchased in this order. If no instance IDs are returned, you can query them with the `DescribeOrders` API. You can also use the `DescribeDBInstances` API to check whether an instance has been created successfully.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {Array.<string> || null}
*/
this.InstanceIds = 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.InstanceIds = 'InstanceIds' in params ? params.InstanceIds : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Node information of a sharded database
* @class
*/
class BriefNodeInfo extends AbstractModel {
constructor(){
super();
/**
* Node ID
* @type {string || null}
*/
this.NodeId = null;
/**
* Node role. Valid values: `master`, `slave`
* @type {string || null}
*/
this.Role = null;
/**
* The ID of the shard where the node resides
* @type {string || null}
*/
this.ShardId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.NodeId = 'NodeId' in params ? params.NodeId : null;
this.Role = 'Role' in params ? params.Role : null;
this.ShardId = 'ShardId' in params ? params.ShardId : null;
}
}
/**
* ModifyDBInstancesProject response structure.
* @class
*/
class ModifyDBInstancesProjectResponse 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;
}
}
/**
* ModifyDBEncryptAttributes response structure.
* @class
*/
class ModifyDBEncryptAttributesResponse 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;
}
}
/**
* DescribeDCDBInstanceNodeInfo request structure.
* @class
*/
class DescribeDCDBInstanceNodeInfoRequest extends AbstractModel {
constructor(){
super();
/**
* Instance ID
* @type {string || null}
*/
this.InstanceId = null;
/**
* The maximum number of results returned at a time. Value range: (0-100]. Default value: `100`.
* @type {number || null}
*/
this.Limit = null;
/**
* Offset of the returned results. Default value: `0`.
* @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.Offset = 'Offset' in params ? params.Offset : null;
}
}
/**
* Database view information
* @class
*/
class DatabaseView extends AbstractModel {
constructor(){
super();
/**
* View name
* @type {string || null}
*/
this.View = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.View = 'View' in params ? params.View : null;
}
}
/**
* Configuration information, which contains `Config` and `Value`.
* @class
*/
class ConfigValue extends AbstractModel {
constructor(){
super();
/**