Data Types

Last updated: 2021-08-10 16:33:06

    BriefNodeInfo

    Node information of a sharded database

    Used by actions: DescribeDCDBInstanceNodeInfo.

    Name Type Description
    NodeId String Node ID
    Role String Node role. Valid values: master, slave
    ShardId String The ID of the shard where the node resides

    ConstraintRange

    Range of constraint type values

    Used by actions: DescribeDBParameters.

    Name Type Description
    Min String Minimum value when constraint type is section
    Max String Maximum value when 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 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.
    DelayThresh Integer 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.

    DBParamValue

    TencentDB parameter information.

    Used by actions: InitDCDBInstances, ModifyDBParameters.

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

    DCDBInstanceInfo

    TDSQL instance information

    Used by actions: DescribeDCDBInstances.

    Name Type Description
    InstanceId String Instance ID
    InstanceName String Instance name
    AppId Integer Application ID
    ProjectId Integer Project ID
    Region String Region
    Zone String AZ
    VpcId Integer Numeric ID of a VPC
    SubnetId Integer Subnet Digital ID
    StatusDesc String Status description
    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
    Vport Integer Private network port
    CreateTime Timestamp Creation time
    AutoRenewFlag Integer Auto-renewal flag
    Memory Integer Memory size in GB
    Storage Integer Storage capacity in GB
    ShardCount Integer Number of shards
    PeriodEndTime Timestamp Expiration time
    IsolatedTimestamp Timestamp Isolation time
    Uin String Account ID
    ShardDetail Array of ShardInfo Shard details
    NodeCount Integer Number of nodes. 2: one source and one replica; 3: one source and two replicas
    IsTmp Integer Temporary instance flag. 0: non-temporary instance
    ExclusterId String Dedicated cluster ID. If this parameter is empty, the instance is a non-dedicated cluster instance
    UniqueVpcId String VPC ID in string type
    UniqueSubnetId String VPC subnet ID in string type
    Id Integer Numeric ID of instance (this field is obsolete and should not be depended on)
    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
    Pid Integer Product type ID (this field is obsolete and should not be depended on)
    UpdateTime Timestamp Last updated time of an instance in the format of 2006-01-02 15:04:05
    DbEngine String Database engine
    DbVersion String Database engine version
    Paymode String Billing mode
    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.
    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
    Cpu Integer Number of CPU cores
    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.
    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 (standard primary instance), 3 (standard disaster recovery instance), 4 (dedicated disaster recovery instance)
    Note: this field may return null, indicating that no valid values can be obtained.

    DCDBShardInfo

    Information of a TDSQL shard.

    Used by actions: DescribeDCDBShards.

    Name Type Description
    InstanceId String Instance ID
    ShardSerialId String Shard SQL passthrough ID, which is used to pass through SQL statements to the specified shard for execution
    ShardInstanceId String Globally unique shard ID
    Status Integer Status. 0: creating; 1: processing; 2: running; 3: shard not initialized
    StatusDesc String Status description
    CreateTime Timestamp Creation time
    VpcId String VPC ID in string format
    SubnetId String VPC subnet ID in string format
    ProjectId Integer Project ID
    Region String Region
    Zone String AZ
    Memory Integer Memory size in GB
    Storage Integer Storage capacity in GB
    PeriodEndTime Timestamp Expiration time
    NodeCount Integer Number of nodes. 2: one source and one replica; 3: one source and two replicas
    StorageUsage Float Storage utilization in %
    MemoryUsage Float Memory utilization in %
    ShardId Integer Numeric ID of a shard (this field is obsolete and should not be depended on)
    Pid Integer ProductID
    ProxyVersion String Proxy version
    Paymode String Billing mode
    Note: this field may return null, indicating that no valid values can be obtained.
    ShardMasterZone String Master AZ of a shard
    Note: this field may return null, indicating that no valid values can be obtained.
    ShardSlaveZones Array of String List of secondary AZs of a shard
    Note: this field may return null, indicating that no valid values can be obtained.
    Cpu Integer Number of CPU cores
    Range String The value range of shardkey, which includes 64 hash values, such as 0-31, 32-63.

    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

    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), and 4 (dedicated disaster recovery instance).

    LogFileInfo

    Information of a pulled log

    Used by actions: DescribeDBLogFiles.

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

    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

    DB 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. 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.
    Default String Default value
    Constraint ParamConstraint Parameter constraint
    HaveSetValue Boolean Whether a value has been set. false: no, true: yes

    ParamModifyResult

    Parameter modification result

    Used by actions: ModifyDBParameters.

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

    Project

    Project description

    Used by actions: DescribeProjects.

    Name Type Description
    ProjectId Integer Project ID
    OwnerUin Integer The UIN of the resource owner (root account)
    AppId Integer Application ID
    Name String Project name
    CreatorUin Integer Creator UIN
    SrcPlat String Source platform
    SrcAppId Integer Source APPID
    Status Integer Project status. Valid values: 0 (normal), -1 (disabled), 3 (default project).
    CreateTime Timestamp Creation time
    IsDefault Integer Whether it is the default project. Valid values: 1 (yes), 0 (no).
    Info String Description

    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.

    ShardInfo

    Shard information

    Used by actions: DescribeDCDBInstances.

    Name Type Description
    ShardInstanceId String Shard ID
    ShardSerialId String Shard set ID
    Status Integer Status. 0: creating; 1: processing; 2: running; 3: shard not initialized; -2: shard deleted
    Createtime String Creation time
    Memory Integer Memory size in GB
    Storage Integer Storage capacity in GB
    ShardId Integer Numeric ID of a shard
    NodeCount Integer Number of nodes. 2: one source and one replica; 3: one source and two replicas
    Pid Integer Product type ID (this field is obsolete and should not be depended on)
    Cpu Integer Number of CPU cores

    TableColumn

    Database column information

    Used by actions: DescribeDatabaseTable.

    Name Type Description
    Col String Column name
    Type String Column type