tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
TencentDB for MariaDB
    Documentation
    Download PDF

    Data Types

    Last updated: 2024-11-20 12:15:34
    Download PDF

      Account

      TencentDB account information

      Used by actions: ModifyAccountPrivileges.

      Name Type Required Description
      User String Yes Account name
      Host String Yes Host address

      ColumnPrivilege

      Column permission information

      Used by actions: ModifyAccountPrivileges.

      Name Type Required Description
      Database String Yes Database name
      Table String Yes Table name
      Column String Yes Column name
      Privileges Array of String Yes Permission information

      ConstraintRange

      Range of constraint type values

      Used by actions: DescribeDBParameters.

      Name Type Description
      Min String Minimum value when the constraint type is section
      Max String Maximum value when the constraint type is section

      DBAccount

      TencentDB account information

      Used by actions: DescribeAccounts.

      Name Type Description
      UserName String Username
      Host String Host from which a user can log in (corresponding to the host field for a MySQL user; a user is uniquely identified by username and host; this parameter is in IP format and ends with % for IP range; % can be entered; if this parameter is left empty, % will be used by default).
      Description String User remarks
      CreateTime Timestamp Creation time
      UpdateTime Timestamp Last updated time
      ReadOnly Integer Read-only flag. 0: no; 1: for the account's SQL requests, the replica will be used first, and if it is unavailable, the primary will be used; 2: the replica will be used first, and if it is unavailable, the operation will fail.
      DelayThresh Integer This field is meaningful for read-only accounts, indicating that a replica should be selected if its delay from the primary is less than this value.
      Note: This field may return null, indicating that no valid values can be obtained.
      SlaveConst Integer 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.)
      MaxUserConnections Integer Maximum number of connections. 0 indicates no limit.

      DBInstance

      TencentDB instance details.

      Used by actions: DescribeDBInstances.

      Name Type Description
      InstanceId String Instance ID, which uniquely identifies a TDSQL instance
      InstanceName String Customizable instance name
      AppId Integer Application ID of instance
      ProjectId Integer Project ID of instance
      Region String Instance region name, such as ap-shanghai
      Zone String Instance AZ name, such as ap-guangzhou-1
      VpcId Integer VPC ID, which is 0 if the basic network is used
      SubnetId Integer Subnet ID, which is 0 if the basic network is used
      Status Integer Instance status. Valid values: 0 (creating), 1 (running task), 2 (running), 3 (uninitialized), -1 (isolated), 4 (initializing), 5 (eliminating), 6 (restarting), 7 (migrating data)
      Vip String Private IP address
      Vport Integer Private network port
      WanDomain String Domain name for public network access, which can be resolved by the public network
      WanVip String Public IP address, which can be accessed over the public network
      WanPort Integer Public network port
      CreateTime Timestamp Instance creation time in the format of 2006-01-02 15:04:05
      UpdateTime Timestamp Last updated time of instance in the format of 2006-01-02 15:04:05
      AutoRenewFlag Integer Auto-renewal flag. 0: no, 1: yes
      PeriodEndTime Timestamp Instance expiration time in the format of 2006-01-02 15:04:05
      Uin String Instance account
      TdsqlVersion String TDSQL version information
      Memory Integer Instance memory size in GB
      Storage Integer Instance storage capacity in GB
      UniqueVpcId String VPC ID in string type
      UniqueSubnetId String VPC subnet ID in string type
      OriginSerialId String Original ID of instance (this field is obsolete and should not be depended on)
      NodeCount Integer Number of nodes. 2: one master and one slave, 3: one master and two slaves
      IsTmp Integer Whether it is a temp instance. 0: no, non-zero value: yes
      ExclusterId String Dedicated cluster ID. If this parameter is empty, the instance is a general instance
      Id Integer Numeric ID of instance (this field is obsolete and should not be depended on)
      Pid Integer Product type ID
      Qps Integer Maximum QPS value
      Paymode String Billing mode
      Note: this field may return null, indicating that no valid values can be obtained.
      Locker Integer Async task flow ID when an async task is in progress on an instance
      Note: this field may return null, indicating that no valid values can be obtained.
      StatusDesc String Current instance running status description
      Note: this field may return null, indicating that no valid values can be obtained.
      WanStatus Integer Public network access status. 0: not enabled, 1: enabled, 2: disabled, 3: enabling
      IsAuditSupported Integer Whether the instance supports audit. 1: yes, 0: no
      Machine String Model
      IsEncryptSupported Integer Whether data encryption is supported. 1: yes, 0: no
      Cpu Integer Number of CPU cores of instance
      Ipv6Flag Integer Indicates whether the instance uses IPv6
      Note: this field may return null, indicating that no valid values can be obtained.
      Vipv6 String Private network IPv6 address
      Note: this field may return null, indicating that no valid values can be obtained.
      WanVipv6 String Public network IPv6 address
      Note: this field may return null, indicating that no valid values can be obtained.
      WanPortIpv6 Integer Public network IPv6 port
      Note: this field may return null, indicating that no valid values can be obtained.
      WanStatusIpv6 Integer Public network IPv6 status
      Note: this field may return null, indicating that no valid values can be obtained.
      DbEngine String Database engine
      Note: this field may return null, indicating that no valid values can be obtained.
      DbVersion String Database version
      Note: this field may return null, indicating that no valid values can be obtained.
      DcnFlag Integer DCN type. Valid values: 0 (null), 1 (primary instance), 2 (disaster recovery instance)
      Note: this field may return null, indicating that no valid values can be obtained.
      DcnStatus Integer DCN status. Valid values: 0 (null), 1 (creating), 2 (syncing), 3 (disconnected)
      Note: this field may return null, indicating that no valid values can be obtained.
      DcnDstNum Integer The number of DCN disaster recovery instances
      Note: this field may return null, indicating that no valid values can be obtained.
      InstanceType Integer Instance type. Valid values: 1 (dedicated primary instance), 2 (primary instance), 3 (disaster recovery instance), and 4 (dedicated disaster recovery instance).
      Note: this field may return null, indicating that no valid values can be obtained.
      ResourceTags Array of ResourceTag Instance tag information
      Note: this field may return null, indicating that no valid values can be obtained.
      DbVersionId String Database version
      Note: This field may return null, indicating that no valid values can be obtained.

      DBParamValue

      TencentDB parameter information.

      Used by actions: CreateDBInstance, CreateHourDBInstance, ModifyDBParameters.

      Name Type Required Description
      Param String Yes Parameter name
      Value String Yes Parameter value

      DCNReplicaConfig

      DCN configuration

      Used by actions: DescribeDBInstanceDetail, DescribeDcnDetail.

      Name Type Description
      RoReplicationMode String DCN running status. Valid values: START (running), STOP (pause)
      Note: This field may return null, indicating that no valid values can be obtained.
      DelayReplicationType String Delayed replication type. Valid values: DEFAULT (no delay), DUE_TIME (specified replication time)
      Note: This field may return null, indicating that no valid values can be obtained.
      DueTime String Specified time for delayed replication
      Note: This field may return null, indicating that no valid values can be obtained.
      ReplicationDelay Integer The number of seconds to delay the replication
      Note: This field may return null, indicating that no valid values can be obtained.

      DCNReplicaStatus

      DCN status information

      Used by actions: DescribeDBInstanceDetail, DescribeDcnDetail.

      Name Type Description
      Status String DCN running status. Valid values: START (running), STOP (pause).
      Note: This field may return null, indicating that no valid values can be obtained.
      Delay Integer The current delay, which takes the delay value of the replica instance.

      Database

      Database information

      Used by actions: DescribeDatabases.

      Name Type Description
      DbName String Database name

      DatabaseFunction

      Database function information

      Used by actions: DescribeDatabaseObjects.

      Name Type Description
      Func String Function name

      DatabasePrivilege

      Database permission

      Used by actions: ModifyAccountPrivileges.

      Name Type Required Description
      Privileges Array of String Yes Permission information
      Database String Yes Database name

      DatabaseProcedure

      Database stored procedure information

      Used by actions: DescribeDatabaseObjects.

      Name Type Description
      Proc String Stored procedure name

      DatabaseTable

      Database table information

      Used by actions: DescribeDatabaseObjects.

      Name Type Description
      Table String Table name

      DatabaseView

      Database view information

      Used by actions: DescribeDatabaseObjects.

      Name Type Description
      View String View name

      DcnDetailItem

      DCN details

      Used by actions: DescribeDcnDetail.

      Name Type Description
      InstanceId String Instance ID
      InstanceName String Instance name
      Region String Region where the instance resides
      Zone String Availability zone where the instance resides
      Vip String Instance IP address
      Vipv6 String Instance IPv6 address
      Vport Integer Instance port
      Status Integer Instance status
      StatusDesc String Instance status description
      DcnFlag Integer DCN flag. Valid values: 1 (primary), 2 (disaster recovery)
      DcnStatus Integer DCN status. Valid values: 0 (none), 1 (creating), 2 (syncing), 3 (disconnected)
      Cpu Integer Number of CPU cores of the instance
      Memory Integer Instance memory capacity in GB
      Storage Integer Instance storage capacity in GB
      PayMode Integer Billing mode
      CreateTime String Creation time of the instance in the format of 2006-01-02 15:04:05
      PeriodEndTime String Expiration time of the instance in the format of 2006-01-02 15:04:05
      InstanceType Integer Instance type. Valid values: 1 (dedicated primary instance), 2 (non-dedicated primary instance), 3 (non-dedicated disaster recovery instance), 4 (dedicated disaster recovery instance)
      ReplicaConfig DCNReplicaConfig Configuration information of DCN replication. This field is null for a primary instance.
      Note: This field may return null, indicating that no valid values can be obtained.
      ReplicaStatus DCNReplicaStatus DCN replication status. This field is null for the primary instance.
      Note: This field may return null, indicating that no valid values can be obtained.
      EncryptStatus Integer Whether KMS is enabled.

      Deal

      Order information

      Used by actions: DescribeOrders.

      Name Type Description
      DealName String Order number
      OwnerUin String Account
      Count Integer Number of items
      FlowId Integer ID of the associated process, which can be used to query the process execution status.
      InstanceIds Array of String The ID of the created instance, which is required only for the order that creates an instance.
      Note: This field may return null, indicating that no valid values can be obtained.
      PayMode Integer Payment mode. Valid values: 0 (postpaid), 1 (prepaid)

      FunctionPrivilege

      Function permission information

      Used by actions: ModifyAccountPrivileges.

      Name Type Required Description
      Database String Yes Database name
      FunctionName String Yes Function name
      Privileges Array of String Yes Permission information

      InstanceBackupFileItem

      Backup file details of an instance

      Used by actions: DescribeBackupFiles.

      Name Type Description
      InstanceId String Instance ID
      InstanceName String Instance name
      InstanceStatus Integer Instance status
      ShardId String Shard ID
      Note: This field may return null, indicating that no valid values can be obtained.
      FilePath String File path
      FileName String File name
      FileSize Integer File size
      BackupType String Backup type. Valid values: Data (data backup), Binlog (Binlog backup), Errlog (error log), Slowlog (slow log).
      ManualBackup Integer Manual backup. Valid values: 0 (no), 1 (yes).
      StartTime String Backup start time
      EndTime String Backup end time

      LogFileInfo

      Pulled log information

      Used by actions: DescribeDBLogFiles.

      Name Type Description
      Mtime Integer Last modified time of log
      Length Integer File length
      Uri String Uniform resource identifier (URI) used during log download
      FileName String Filename

      NodeInfo

      Instance node information

      Used by actions: DescribeDBInstanceDetail, DescribeInstanceNodeInfo.

      Name Type Description
      NodeId String Node ID
      Role String Node role. Valid values: master, slave

      ParamConstraint

      Parameter constraint

      Used by actions: DescribeDBParameters.

      Name Type Description
      Type String Constraint type, such as enum and section.
      Enum String List of valid values when constraint type is enum
      Range ConstraintRange Range when constraint type is section
      Note: This field may return null, indicating that no valid values can be obtained.
      String String List of valid values when constraint type is string

      ParamDesc

      Database parameter description

      Used by actions: DescribeDBParameters.

      Name Type Description
      Param String Parameter name
      Value String Current parameter value
      SetValue String Previously set value, which is the same as value after the parameter takes effect.
      Note: This field may return null, indicating that no valid values can be obtained.
      Default String Default value
      Constraint ParamConstraint Parameter constraint
      HaveSetValue Boolean Whether a value has been set. false: no, true: yes
      NeedRestart Boolean Whether restart is required. false: no;
      true: yes.

      ParamModifyResult

      Parameter modification result

      Used by actions: ModifyDBParameters.

      Name Type Description
      Param String Renames parameter
      Code Integer Result of parameter modification. 0: success; -1: failure; -2: invalid parameter value.

      ProcedurePrivilege

      Stored procedure permission information

      Used by actions: ModifyAccountPrivileges.

      Name Type Required Description
      Database String Yes Database name
      Procedure String Yes Stored procedure name
      Privileges Array of String Yes Permission information

      ReservedNetResource

      Information of the reserved network resource

      Used by actions: DescribeDBInstanceDetail.

      Name Type Description
      VpcId String VPC
      SubnetId String Subnet
      Vip String Reserved private network IP under VpcId and SubnetId
      Vports Array of Integer Port under Vip
      RecycleTime String Valid hours of VIP

      ResourceTag

      Tag object, including tag key and tag value

      Used by actions: CreateDBInstance, CreateHourDBInstance, DescribeDBInstanceDetail, DescribeDBInstances.

      Name Type Required Description
      TagKey String Yes Tag key
      TagValue String Yes Tag value

      SecurityGroup

      Security group details

      Used by actions: DescribeDBSecurityGroups, DescribeProjectSecurityGroups.

      Name Type Description
      ProjectId Integer Project ID
      CreateTime String Creation time in the format of yyyy-mm-dd hh:mm:ss
      SecurityGroupId String Security group ID
      SecurityGroupName String Security group name
      SecurityGroupRemark String Security group remarks
      Inbound Array of SecurityGroupBound Inbound rule
      Outbound Array of SecurityGroupBound Outbound rule

      SecurityGroupBound

      Security group inbound/outbound rule

      Used by actions: DescribeDBSecurityGroups, DescribeProjectSecurityGroups.

      Name Type Description
      Action String Policy, which can be ACCEPT or DROP
      CidrIp String Source IP or source IP range, such as 192.168.0.0/16
      PortRange String Port
      IpProtocol String Network protocol. UDP and TCP are supported.

      SlowLogData

      Information of a slow query that has been logged

      Used by actions: DescribeDBSlowLogs.

      Name Type Description
      CheckSum String Statement checksum for querying details
      Db String Database name
      FingerPrint String Abstracted SQL statement
      LockTimeAvg String Average lock time
      LockTimeMax String Maximum lock time
      LockTimeMin String Minimum lock time
      LockTimeSum String Total lock time
      QueryCount String Number of queries
      QueryTimeAvg String Average query time
      QueryTimeMax String Maximum query time
      QueryTimeMin String Minimum query time
      QueryTimeSum String Total query time
      RowsExaminedSum String Number of scanned rows
      RowsSentSum String Number of sent rows
      TsMax String Last execution time
      TsMin String First execution time
      User String Account
      ExampleSql String Sample SQL
      Note: This field may return null, indicating that no valid values can be obtained.
      Host String Host address of account

      TableColumn

      Database column information

      Used by actions: DescribeDatabaseTable.

      Name Type Description
      Col String Column name
      Type String Column type

      TablePrivilege

      Table permission

      Used by actions: ModifyAccountPrivileges.

      Name Type Required Description
      Database String Yes Database name
      Table String Yes Table name
      Privileges Array of String Yes Permission information

      TmpInstance

      Temp instance

      Used by actions: DescribeDBTmpInstances.

      Name Type Description
      AppId Integer Application ID
      Note: This field may return null, indicating that no valid values can be obtained.
      CreateTime Timestamp Creation time
      Note: This field may return null, indicating that no valid values can be obtained.
      InstanceRemark String Instance remarks
      Note: This field may return null, indicating that no valid values can be obtained.
      TempType Integer Whether it is a temp instance. Valid values: 0 (non-temp instance), 1 (invalid temp instance), 2 (valid temp rollback instance).
      Note: This field may return null, indicating that no valid values can be obtained.
      Status Integer Instance status. Valid values: 0 (to be initialized), 1 (in process), 2 (running), -1 (isolated), -2 (eliminated).
      Note: This field may return null, indicating that no valid values can be obtained.
      InstanceId String Instance ID in the format of tdsql-ow728lmc
      Note: This field may return null, indicating that no valid values can be obtained.
      Vip String Virtual instance IP
      Note: This field may return null, indicating that no valid values can be obtained.
      Vport Integer Virtual instance port
      Note: This field may return null, indicating that no valid values can be obtained.
      PeriodEndTime Timestamp Validity end time
      Note: This field may return null, indicating that no valid values can be obtained.
      SrcInstanceId String Source instance ID in the format of tdsql-ow728lmc
      Note: This field may return null, indicating that no valid values can be obtained.
      StatusDesc String Instance status description
      Note: This field may return null, indicating that no valid values can be obtained.
      Region String Instance region
      Note: This field may return null, indicating that no valid values can be obtained.
      Zone String AZ of the instance
      Note: This field may return null, indicating that no valid values can be obtained.
      Vipv6 String Virtual IPv6 of the instance
      Note: This field may return null, indicating that no valid values can be obtained.
      Ipv6Flag Integer Instance IPv6 flag
      Note: This field may return null, indicating that no valid values can be obtained.

      ViewPrivileges

      View permission information

      Used by actions: ModifyAccountPrivileges.

      Name Type Required Description
      Database String Yes Database name
      View String Yes View name
      Privileges Array of String Yes Permission information
      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
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy