tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
TencentDB for SQL Server
    Documentation
    Download PDF

    Data Types

    Last updated: 2022-06-06 15:27:00
    Download PDF

    AccountCreateInfo

    Account creation information

    Used by actions: CreateAccount.

    Name Type Required Description
    UserName String Yes Instance username
    Password String Yes Instance password
    DBPrivileges Array of DBPrivilege No List of database permissions
    Remark String No Account remarks
    IsAdmin Boolean No Whether it is an admin account. Default value: no
    Authentication String No Valid values: win-windows authentication, sql-sqlserver authentication. Default value: sql-sqlserver authentication.

    AccountDetail

    Account details

    Used by actions: DescribeAccounts.

    Name Type Description
    Name String Account name
    Remark String Account remarks
    CreateTime Timestamp Account creation time
    Status Integer Account status. 1: creating, 2: normal, 3: modifying, 4: resetting password, -1: deleting
    UpdateTime Timestamp Account update time
    PassTime Timestamp Password update time
    InternalStatus String Internal account status, which should be enable normally
    Dbs Array of DBPrivilege Information of read and write permissions of this account on relevant databases
    IsAdmin Boolean Whether it is an admin account
    Authentication String Valid values: win-windows authentication, sql-sqlserver authentication.
    Host String The host required for win-windows authentication account

    AccountPassword

    Instance account password information

    Used by actions: ResetAccountPassword.

    Name Type Required Description
    UserName String Yes Username
    Password String Yes Password

    AccountPrivilege

    Database account permission information, which is set when the database is created

    Used by actions: CreateDB, DescribeDBs.

    Name Type Required Description
    UserName String Yes Database username
    Privilege String Yes Database permissions. ReadWrite: read/write, ReadOnly: read-only

    AccountPrivilegeModifyInfo

    Database account permission change information

    Used by actions: ModifyAccountPrivilege.

    Name Type Required Description
    UserName String Yes Database username
    DBPrivileges Array of DBPrivilegeModifyInfo Yes Account permission change information
    IsAdmin Boolean No Whether it is an admin account

    AccountRemark

    Account remarks

    Used by actions: ModifyAccountRemark.

    Name Type Description
    UserName String Account name
    Remark String New remarks of account

    Backup

    Backup file details

    Used by actions: DescribeBackups.

    Name Type Description
    FileName String File name. The name of an unarchived backup file is returned by the DescribeBackupFiles API instead of this parameter.
    Size Integer File size in KB. The size of an unarchived backup file is returned by the DescribeBackupFiles API instead of this parameter.
    StartTime Timestamp Backup start time
    EndTime Timestamp Backup end time
    InternalAddr String Private network download address. The download address of an unarchived backup file is returned by the DescribeBackupFiles API instead of this parameter.
    ExternalAddr String Public network download address. The download address of an unarchived backup file is returned by the DescribeBackupFiles API instead of this parameter.
    Id Integer Unique ID of a backup file, which is used by the RestoreInstance API. The unique ID of an unarchived backup file is returned by the DescribeBackupFiles API instead of this parameter.
    Status Integer Backup file status (0: creating, 1: succeeded, 2: failed)
    DBs Array of String List of databases for multi-database backup
    Strategy Integer Backup policy (0: instance backup, 1: multi-database backup)
    BackupWay Integer Backup mode. 0: scheduled, 1: manual
    BackupName String Backup task name (customizable)
    GroupId String Group ID of unarchived backup files, which can be used as a request parameter in the DescribeBackupFiles API to get details of unarchived backup files in the specified group. This parameter is invalid for archived backup files.
    BackupFormat String Backup file format. Valid values:pkg (archive file), single (unarchived files).

    BackupFile

    If the backup files are unarchived, each database corresponds to one backup file.

    Used by actions: DescribeBackupFiles.

    Name Type Description
    Id Integer Unique ID of a backup file
    FileName String Backup file name
    Size Integer File size in KB
    DBs Array of String Name of the database corresponding to the backup file
    DownloadLink String Download address

    CosUploadBackupFile

    Querying the size of uploaded backup files.

    Used by actions: DescribeBackupUploadSize.

    Name Type Description
    FileName String Backup name
    Size Integer Backup size

    DBCreateInfo

    Database creation information

    Used by actions: CreateDB.

    Name Type Required Description
    DBName String Yes Database name
    Charset String No Character set, which can be queried by the DescribeDBCharsets API. Default value: Chinese_PRC_CI_AS.
    Accounts Array of AccountPrivilege No Database account permission information
    Remark String No Remarks

    DBDetail

    Database information

    Used by actions: DescribeDBs.

    Name Type Description
    Name String Database name
    Charset String Character set
    Remark String Remarks
    CreateTime Timestamp Database creation time
    Status Integer Database status. 1: creating, 2: running, 3: modifying, -1: dropping
    Accounts Array of AccountPrivilege Database account permission information
    InternalStatus String Internal status. ONLINE: running

    DBInstance

    Instance details

    Used by actions: DescribeDBInstances.

    Name Type Description
    InstanceId String Instance ID
    Name String Instance name
    ProjectId Integer Project ID of instance
    RegionId Integer Instance region ID
    ZoneId Integer Instance AZ ID
    VpcId Integer Instance VPC ID, which will be 0 if the basic network is used
    SubnetId Integer Instance VPC subnet ID, which will be 0 if the basic network is used
    Status Integer Instance status. Valid values:
  • 1: creating
  • 2: running
  • 3: instance operations restricted (due to the ongoing primary-replica switch)
  • 4: isolated
  • 5: repossessing
  • 6: repossessed
  • 7: running tasks (such as backup and rollback tasks)
  • 8: eliminated
  • 9: expanding capacity
  • 10: migrating
  • 11: read-only
  • 12: restarting
  • 13: modifying configuration and waiting for switch
  • 14: implementing pub/sub
  • 15: modifying pub/sub configuration
  • 16: modifying configuration and switching
  • 17: creating read-only instances
    		•
    Vip String Instance access IP
    Vport Integer Instance access port
    CreateTime Timestamp Instance creation time
    UpdateTime Timestamp Instance update time
    StartTime Timestamp Instance billing start time
    EndTime Timestamp Instance billing end time
    IsolateTime Timestamp Instance isolation time
    Memory Integer Instance memory size in GB
    UsedStorage Integer Used storage capacity of instance in GB
    Storage Integer Instance storage capacity in GB
    VersionName String Instance version
    RenewFlag Integer Instance renewal flag
    Model Integer High-availability instance type. Valid values: 1 (dual-server high-availability), 2 (standalone), 3 (multi-AZ), 4 (multi-AZ cluster), 5 (cluster), 9 (private consumption)
    Region String Instance region name, such as ap-guangzhou
    Zone String Instance AZ name, such as ap-guangzhou-1
    BackupTime String Backup time point
    PayMode Integer Instance billing mode. 0: pay-as-you-go
    Uid String Instance UID
    Cpu Integer Number of CPU cores of instance
    Version String Instance version code
    Type String Physical server code
    Pid Integer Billing ID
    UniqVpcId String Unique string-type ID of instance VPC in the format of vpc-xxx, which is an empty string if the basic network is used
    UniqSubnetId String Unique string-type ID of instance subnet in the format of subnet-xxx, which is an empty string if the basic network is used
    IsolateOperator String Instance isolation.
    Note: this field may return null, indicating that no valid values can be obtained.
    SubFlag String Pub/sub flag. Valid values: SUB (subscribe instance), PUB (publish instance). If it is left empty, it refers to a regular instance without a pub/sub design.
    Note: this field may return null, indicating that no valid values can be obtained.
    ROFlag String Read-only flag. Valid values: RO (read-only instance), MASTER (primary instance with read-only instances). If it is left empty, it refers to an instance which is not read-only and has no RO group.
    Note: this field may return null, indicating that no valid values can be obtained.
    HAFlag String Disaster recovery type. Valid values: MIRROR (image), ALWAYSON (AlwaysOn), SINGLE (singleton).
    Note: this field may return null, indicating that no valid values can be obtained.
    ResourceTags Array of ResourceTag The list of tags associated with the instance
    Note: this field may return null, indicating that no valid values can be obtained.
    BackupModel String Backup mode. Valid values: master_pkg (archive the backup files of the primary node (default value)), master_no_pkg (do not archive the backup files of the primary node), slave_pkg (archive the backup files of the replica node (valid for Always On clusters)), slave_no_pkg (do not archive the backup files of the replica node (valid for Always On clusters)). This parameter is invalid for read-only instances.
    Note: this field may return null, indicating that no valid values can be obtained.
    InstanceNote String Instance backup info
    Note: This field may return null, indicating that no valid values can be obtained.
    BackupCycle Array of Integer Backup cycle
    BackupCycleType String Backup cycle type. Valid values: daily, weekly, monthly.
    BackupSaveDays Integer Data (log) backup retention period
    InstanceType String Instance type. Valid values: HA (high-availability), RO (read-only), SI (basic edition), BI (business intelligence service).

    DBPrivilege

    Database permission information of account

    Used by actions: CreateAccount, DescribeAccounts.

    Name Type Required Description
    DBName String Yes Database name
    Privilege String Yes Database permissions. ReadWrite: read/write, ReadOnly: read-only

    DBPrivilegeModifyInfo

    Database permission change information

    Used by actions: ModifyAccountPrivilege.

    Name Type Required Description
    DBName String Yes Database name
    Privilege String Yes Permission change information. ReadWrite: read/write, ReadOnly: read-only, Delete: the account has the permission to delete this database

    DBRemark

    Database remarks

    Used by actions: ModifyDBRemark.

    Name Type Required Description
    Name String Yes Database name
    Remark String Yes Remarks

    DbNormalDetail

    Database configurations

    Used by actions: DescribeDBsNormal.

    Name Type Description
    IsSubscribed String Whether it is subscribed. Valid values: 0 (no), 1 (yes)
    CollationName String Database collation
    IsAutoCleanupOn String Whether the cleanup task is enabled to automatically remove old change tracking information when CT is enabled. Valid values: 0 (no), 1 (yes)
    IsBrokerEnabled String Whether SQL Server Service Broker is enabled. Valid values: 0 (no), 1 (yes)
    IsCdcEnabled String Whether CDC is enabled. Valid values: 0 (disabled), 1 (enabled)
    IsDbChainingOn String Whether CT is enabled. Valid values: 0 (disabled), 1 (enabled)
    IsEncrypted String Whether it is encrypted. Valid values: 0 (no), 1 (yes)
    IsFulltextEnabled String Whether full-text indexes are enabled. Valid values: 0 (no), 1 (yes)
    IsMirroring String Whether it is a mirror database. Valid values: 0 (no), 1 (yes)
    IsPublished String Whether it is published. Valid values: 0 (no), 1 (yes)
    IsReadCommittedSnapshotOn String Whether snapshots are enabled. Valid values: 0 (no), 1 (yes)
    IsTrustworthyOn String Whether it is trustworthy. Valid values: 0 (no), 1 (yes)
    MirroringState String Mirroring state
    Name String Database name
    RecoveryModelDesc String Recovery model
    RetentionPeriod String Retention period (in days) of change tracking information
    StateDesc String Database status
    UserAccessDesc String User type

    DbRollbackTimeInfo

    Information of time range available for database rollback

    Used by actions: DescribeRollbackTime.

    Name Type Description
    DBName String Database name
    StartTime Timestamp Start time of time range available for rollback
    EndTime Timestamp End time of time range available for rollback

    DealInfo

    Order information

    Used by actions: DescribeOrders.

    Name Type Description
    DealName String Order name
    Count Integer Number of items
    FlowId Integer ID of associated flow, which can be used to query the flow execution status
    InstanceIdSet Array of String This field is required only for an order that creates an instance, indicating the ID of the instance created by the order
    OwnerUin String Account
    InstanceChargeType String Instance billing type

    InstanceDBDetail

    Instance database information

    Used by actions: DescribeDBs.

    Name Type Description
    InstanceId String Instance ID
    DBDetails Array of DBDetail Database information list

    MigrateDB

    List of databases to be migrated

    Used by actions: CreateMigration, DescribeMigrationDetail, ModifyMigration.

    Name Type Required Description
    DBName String No Name of migrated database

    MigrateDetail

    Migration progress details

    Used by actions: DescribeMigrations.

    Name Type Description
    StepName String Name of current step
    Progress Integer Progress of current step in %

    MigrateSource

    Source type of migration task

    Used by actions: CreateMigration, DescribeMigrationDetail, ModifyMigration.

    Name Type Required Description
    InstanceId String No Source instance ID in the format of mssql-si2823jyl, which is used when MigrateType is 1 (TencentDB for SQL Server)
    CvmId String No ID of source CVM instance, which is used when MigrateType is 2 (CVM-based self-created SQL Server database)
    VpcId String No VPC ID of source CVM instance in the format of vpc-6ys9ont9, which is used when MigrateType is 2 (CVM-based self-created SQL Server database)
    SubnetId String No VPC subnet ID of source CVM instance in the format of subnet-h9extioi, which is used when MigrateType is 2 (CVM-based self-created SQL Server database)
    UserName String No Username, which is used when MigrateType is 1 or 2
    Password String No Password, which is used when MigrateType is 1 or 2
    Ip String No Private IP of source CVM database, which is used when MigrateType is 2 (CVM-based self-created SQL Server database)
    Port Integer No Port number of source CVM database, which is used when MigrateType is 2 (CVM-based self-created SQL Server database)
    Url Array of String No Source backup address for offline migration, which is used when MigrateType is 4 or 5
    UrlPassword String No Source backup password for offline migration, which is used when MigrateType is 4 or 5

    MigrateTarget

    Target type of migration task

    Used by actions: CreateMigration, DescribeMigrationDetail, ModifyMigration.

    Name Type Required Description
    InstanceId String No ID of target instance in the format of mssql-si2823jyl
    UserName String No Username of migration target instance
    Password String No Password of migration target instance

    MigrateTask

    Migration task type

    Used by actions: DescribeMigrations.

    Name Type Description
    MigrateId Integer Migration task ID
    MigrateName String Migration task name
    AppId Integer User ID of migration task
    Region String Migration task region
    SourceType Integer Migration source type. 1: TencentDB for SQL Server, 2: CVM-based self-created SQL Server database; 3: SQL Server backup restoration, 4: SQL Server backup restoration (in COS mode)
    CreateTime Timestamp Migration task creation time
    StartTime Timestamp Migration task start time
    EndTime Timestamp Migration task end time
    Status Integer Migration task status (1: initializing, 4: migrating, 5: migration failed, 6: migration succeeded, 7: suspended, 8: deleted, 9: suspending, 10: completing, 11: suspension failed, 12: completion failed)
    Message String Information
    CheckFlag Integer Whether migration task has been checked (0: not checked, 1: check succeeded, 2: check failed, 3: checking)
    Progress Integer Migration task progress in %
    MigrateDetail MigrateDetail Migration task progress details

    Migration

    Cold backup migration import

    Used by actions: DescribeBackupMigration, DescribeIncrementalMigration.

    Name Type Description
    MigrationId String Backup import task ID or incremental import task ID
    MigrationName String Backup import task name. For an incremental import task, this field will be left empty.
    Note: this field may return ‘null’, indicating that no valid values can be obtained.
    AppId Integer Application ID
    Region String Region
    InstanceId String ID of migrated target instance
    RecoveryType String Migration task restoration type
    UploadType String Backup user upload type. COS_URL: the backup is stored in user’s Cloud Object Storage, with URL provided. COS_UPLOAD: the backup is stored in the application’s Cloud Object Storage and needs to be uploaded by the user.
    BackupFiles Array of String Backup file list, which is determined by UploadType. If the upload type is COS_URL, URL will be saved. If the upload type is COS_UPLOAD, the backup name will be saved.
    Status Integer Migration task status. Valid values: 2 (Creation completed), 7 (Importing full backups), 8 (Waiting for incremental backups), 9 (Import success), 10 (Import failure), 12 (Importing incremental backups).
    CreateTime String Migration task creation time
    StartTime String Migration task start time
    EndTime String Migration task end time
    Message String More information
    Detail MigrationDetail Migration detail
    Action MigrationAction Operation allowed in the current status
    IsRecovery String Whether this is the final restoration. For a full import task, this field will be left empty.
    Note: this field may return ‘null’, indicating that no valid values can be obtained.

    MigrationAction

    Operation allowed by a cold backup import task

    Used by actions: DescribeBackupMigration, DescribeIncrementalMigration.

    Name Type Description
    AllAction Array of String All the allowed operations. Values include: view (viewing a task), modify (modifying a task), start (starting a task), incremental (creating an incremental task), delete (deleting a task), and upload (obtaining the upload permission).
    AllowedAction Array of String Operation allowed in the current status. If the subset of AllAction is left empty, no operations will be allowed.

    MigrationDetail

    Details of a cold backup import task

    Used by actions: DescribeBackupMigration, DescribeIncrementalMigration.

    Name Type Description
    StepAll Integer Total number of steps
    StepNow Integer Current step
    Progress Integer Overall progress. For example, “30” means 30%.
    StepInfo Array of MigrationStep Step information. ‘null’ means the migration has not started
    Note: this field may return ‘null’, indicating that no valid values can be obtained.

    MigrationStep

    Migration steps of a cold backup import task

    Used by actions: DescribeBackupMigration, DescribeIncrementalMigration.

    Name Type Description
    StepNo Integer Step sequence
    StepName String Step name
    StepId String Step ID in English
    Status Integer Step status: 0 (default value), 1 (succeeded), 2 (failed), 3 (in progress), 4 (not started)

    ParamRecord

    Instance parameter modification record

    Used by actions: DescribeInstanceParamRecords.

    Name Type Description
    InstanceId String Instance ID
    ParamName String Parameter name
    OldValue String Parameter value before modification
    NewValue String Parameter value after modification
    Status Integer Parameter modification status. Valid values: 1 (initializing and waiting for modification), 2 (modification succeed), 3 (modification failed), 4 (modifying)
    ModifyTime String Modification time

    Parameter

    Database instance parameter

    Used by actions: ModifyInstanceParam.

    Name Type Required Description
    Name String No Parameter name
    CurrentValue String No Parameter value

    ParameterDetail

    Instance parameter details

    Used by actions: DescribeInstanceParams.

    Name Type Description
    Name String Parameter name
    ParamType String Data type of the parameter. Valid values: integer, enum
    Default String Default value of the parameter
    Description String Parameter description
    CurrentValue String Current value of the parameter
    NeedReboot Integer Whether the database needs to be restarted for the modified parameter to take effect. Valid values: 0 (no),1 (yes)
    Max Integer Maximum value of the parameter
    Min Integer Minimum value of the parameter
    EnumValue Array of String Enumerated values of the parameter
    Status Integer Parameter status. Valid values: 0 (normal), 1 (modifying)

    RegionInfo

    Region information

    Used by actions: DescribeRegions.

    Name Type Description
    Region String Region ID in the format of ap-guangzhou
    RegionName String Region name
    RegionId Integer Numeric ID of region
    RegionState String Current purchasability of this region. UNAVAILABLE: not purchasable, AVAILABLE: purchasable

    RenameRestoreDatabase

    Used in the RestoreInstance, RollbackInstance, CreateMigration, and CloneDB APIs to specify and rename the database to be restored, rolled back, migrated, or cloned.

    Used by actions: CloneDB, CreateMigration, RestoreInstance, RollbackInstance.

    Name Type Required Description
    OldName String No Database name. If the OldName database does not exist, a failure will be returned.
    It can be left empty in offline migration tasks.
    NewName String No New database name. In offline migration, OldName will be used if NewName is left empty (OldName and NewName cannot be both empty). In database cloning, OldName and NewName must be both specified and cannot have the same value.

    ResourceTag

    The information of tags associated with instances

    Used by actions: CreateDBInstances, DescribeDBInstances.

    Name Type Description
    TagKey String Tag key
    TagValue String Tag value

    SlowlogInfo

    Slow query log file information

    Used by actions: DescribeSlowlogs.

    Name Type Description
    Id Integer Unique ID of slow query log file
    StartTime Timestamp File generation start time
    EndTime Timestamp File generation end time
    Size Integer File size in KB
    Count Integer Number of logs in file
    InternalAddr String Download address for private network
    ExternalAddr String Download address for public network
    Status Integer Status (1: success, 2: failure)
    Note: this field may return null, indicating that no valid values can be obtained.

    SpecInfo

    Information of purchasable specification for an instance

    Used by actions: DescribeProductConfig.

    Name Type Description
    SpecId Integer 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
    MachineType String Model ID
    MachineTypeName String Model name
    Version String 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)
    VersionName String Version name corresponding to the Version field
    Memory Integer Memory size in GB
    CPU Integer Number of CPU cores
    MinStorage Integer Minimum disk size under this specification in GB
    MaxStorage Integer Maximum disk size under this specification in GB
    QPS Integer QPS of this specification
    SuitInfo String Description of this specification
    Pid Integer Pid of this specification
    PostPid Array of Integer Pay-as-you-go Pid list corresponding to this specification
    Note: this field may return null, indicating that no valid values can be obtained.
    PayModeStatus String Billing mode under this specification. POST: pay-as-you-go
    InstanceType String Instance type. Valid values: HA (High-Availability Edition, including dual-server high availability and AlwaysOn cluster), RO (read-only replica), SI (Basic Edition)
    MultiZonesStatus String 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)

    ZoneInfo

    AZ information

    Used by actions: DescribeZones.

    Name Type Description
    Zone String AZ ID in the format of ap-guangzhou-1 (i.e., Guangzhou Zone 1)
    ZoneName String AZ name
    ZoneId Integer Numeric ID of AZ
    SpecId Integer ID of specification purchasable in this AZ, which, together with the returned value of the DescribeProductConfig API, can be used to find out the specifications currently purchasable in the AZ
    Version String Information of database versions purchasable under the current AZ and specification. 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)
    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    Submit a Ticket
    7x24 Phone Support
    tencent
    Copyright © 2013-2022 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy