tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

Data Types

最后更新时间：2024-06-17 14:26:45

    AccountInfo

    Account information

    Used by actions: DescribeAccounts.

    Name Type Description
    DBInstanceId String Instance ID in the format of postgres-lnp6j617
    UserName String Account
    Remark String Account remarks
    Status Integer Account status. 1: creating, 2: normal, 3: modifying, 4: resetting password, -1: deleting
    CreateTime Timestamp Account creation time
    UpdateTime Timestamp Account last modified time

    AnalysisItems

    Detailed analysis of a slow query statement with abstract parameter values, which is returned by the DescribeSlowQueryAnalysis API

    Used by actions: DescribeSlowQueryAnalysis.

    Name Type Description
    DatabaseName String The name of the database queried by the slow query statement
    UserName String The name of the user who executes the slow query statement
    NormalQuery String The slow query statement whose parameter values are abstracted
    ClientAddr String The address of the client that executes the slow query statement
    CallNum Integer The number of executions of the slow query statement during the specified period of time
    CallPercent Float The ratio (in decimal form) of the number of executions of the slow query statement to that of all slow query statements during the specified period of time
    CostTime Float The total execution time of the slow query statement during the specified period of time
    CostPercent Float The ratio (in decimal form) of the total execution time of the slow query statement to that of all slow query statements during the specified period of time
    MinCostTime Float The shortest execution time (in ms) of the slow query statement during the specified period of time
    MaxCostTime Float The longest execution time (in ms) of the slow query statement during the specified period of time
    AvgCostTime Float The average execution time (in ms) of the slow query statement during the specified period of time
    FirstTime String The timestamp when the slow query statement starts to execute for the first time during the specified period of time
    LastTime String The timestamp when the slow query statement starts to execute for the last time during the specified period of time

    BackupDownloadRestriction

    Restriction information for downloading a backup

    Used by actions: DescribeBackupDownloadURL.

    Name Type Required Description
    RestrictionType String No Type of the network restrictions for downloading backup files. Valid values: NONE (backups can be downloaded over both private and public networks), INTRANET (backups can only be downloaded over the private network), CUSTOMIZE (backups can be downloaded over specified VPCs or at specified IPs).
    VpcRestrictionEffect String No Whether VPC is allowed. Valid values: ALLOW (allow), DENY (deny).
    VpcIdSet Array of String No Whether it is allowed to download the VPC ID list of the backup files.
    IpRestrictionEffect String No Whether IP is allowed. Valid values: ALLOW (allow), DENY (deny).
    IpSet Array of String No Whether it is allowed to download IP list of the backup files.

    BackupPlan

    Backup plan

    Used by actions: DescribeBackupPlans.

    Name Type Description
    BackupPeriod String Backup cycle
    BaseBackupRetentionPeriod Integer Data backup retention duration
    MinBackupStartTime String The earliest time to start a backup
    MaxBackupStartTime String The latest time to start a backup

    BackupSummary

    Instance backup statistics

    Used by actions: DescribeBackupSummaries.

    Name Type Description
    DBInstanceId String Instance ID
    LogBackupCount Integer Number of log backups of an instance
    LogBackupSize Integer Size of log backups of an instance
    ManualBaseBackupCount Integer Number of manually created instance data backups.
    ManualBaseBackupSize Integer Size of manually created instance data backups.
    AutoBaseBackupCount Integer Number of automatically created instance data backups.
    AutoBaseBackupSize Integer Size of automatically created instance data backups.
    TotalBackupCount Integer Total number of backups
    TotalBackupSize Integer Total backup size

    BaseBackup

    Database data backup information

    Used by actions: DescribeBaseBackups.

    Name Type Description
    DBInstanceId String Instance ID
    Id String Unique ID of a backup file
    Name String Backup file name.
    BackupMethod String Backup method, including physical and logical.
    BackupMode String Backup mode, including automatic and manual.
    State String Backup task status
    Size Integer Backup set size in bytes
    StartTime String Backup start time
    FinishTime String Backup end time
    ExpireTime String Backup expiration time

    ClassInfo

    Database instance specification

    Used by actions: DescribeClasses.

    Name Type Description
    SpecCode String Specification ID
    CPU Integer Number of CPU cores
    Memory Integer Memory size in MB
    MaxStorage Integer Maximum storage capacity in GB supported by this specification
    MinStorage Integer Minimum storage capacity in GB supported by this specification
    QPS Integer Estimated QPS for this specification

    DBBackup

    Database backup information

    Used by actions: DescribeDBBackups.

    Name Type Description
    Id Integer Unique backup file ID
    StartTime String File generation start time
    EndTime String File generation end time
    Size Integer File size in KB
    Strategy Integer Policy (0: instance backup, 1: multi-database backup)
    Way Integer Type (0: scheduled)
    Type Integer Backup mode (1: full)
    Status Integer Status (1: creating, 2: success, 3: failure)
    DbList Array of String DB list
    InternalAddr String Download address on private network
    ExternalAddr String Download address on public network
    SetId String Backup set ID
    Note: this field may return null, indicating that no valid values can be obtained.

    DBInstance

    Instance details

    Used by actions: DescribeDBInstanceAttribute, DescribeDBInstances, DescribeReadOnlyGroups.

    Name Type Description
    Region String Instance region such as ap-guangzhou, which corresponds to theRegion field in RegionSet.
    Zone String Instance AZ such as ap-guangzhou-3, which corresponds to the Zone field of ZoneSet.
    VpcId String VPC ID in the format of vpc-xxxxxxx, which can be obtained in the console or from the unVpcId field in the return value of the DescribeVpcs API.
    SubnetId String VPC subnet ID in the format of subnet-xxxxxxxx, which can be obtained in the console or from the unSubnetId field in the return value of the DescribeSubnets API.
    DBInstanceId String Instance ID
    DBInstanceName String Instance name
    DBInstanceStatus String Instance status, including: applying (applying), init (to be initialized), initing (initializing), running (running), limited run (restricted operation), isolating (isolating), isolated (isolated), disisolating (de-isolating), recycling (recycling), recycled (recycled), job running (task executing), offline (offline), migrating (migrating), expanding (scaling out), waitSwitch (waiting to switch), switching (switching), readonly (readonly), restarting (restarting), network changing (network modification in progress), upgrading (kernel version upgrading), audit-switching (audit status changing), and primary-switching (primary-secondary switching)
    DBInstanceMemory Integer Assigned instance memory size in GB
    DBInstanceStorage Integer Assigned instance storage capacity in GB
    DBInstanceCpu Integer Number of assigned CPUs
    DBInstanceClass String Purchasable specification ID
    DBMajorVersion String The major PostgreSQL version number, which can be queried by the DescribeDBVersions API. Valid values: 10, 11, 12, 13, 14, 15.
    Note: u200dThis field may return null, indicating that no valid values can be obtained.
    DBVersion String Number of the major PostgreSQL community version and minor version, such as 12.4, which can be queried by the DescribeDBVersions API.
    DBKernelVersion String PostgreSQL kernel version number (like v12.7_r1.8), which can be queried by the DescribeDBVersions API.
    Note: u200dThis field may return null, indicating that no valid values can be obtained.
    DBInstanceType String Instance type, which includes:
  • primary: primary instance
  • readonly: read-only instance
  • guard: disaster recovery instance
  • temp: temporary instance
    		•
    DBInstanceVersion String Instance version. Valid value: standard (dual-server high-availability; one-primary-one-standby).
    DBCharset String Instance character set, which currently supports only:
  • UTF8
  • LATIN1
    		•
    CreateTime Timestamp Instance creation time
    UpdateTime Timestamp Last updated time of the instance attribute
    ExpireTime Timestamp Instance expiration time
    IsolatedTime Timestamp Instance isolation time
    PayType String Billing mode:
  • prepaid: monthly subscription, prepaid
  • postpaid: pay-as-you-go, postpaid
    		•
    AutoRenew Integer Auto-renewal or not:
  • 0: manual renewal
  • 1: auto-renewal

    • Default value: 0
    DBInstanceNetInfo Array of DBInstanceNetInfo Instance network connection information
    Type String Machine type
    AppId Integer User AppId
    Uid Integer Instance Uid
    ProjectId Integer Project ID
    TagList Array of Tag The information of tags associated with instances
    Note: u200dThis field may return null, indicating that no valid values can be obtained.
    MasterDBInstanceId String Primary instance information, which is returned only when the instance is read-only.
    Note: u200dThis field may return null, indicating that no valid values can be obtained.
    ReadOnlyInstanceNum Integer Number of read-only instances
    Note: u200dThis field may return null, indicating that no valid values can be obtained.
    StatusInReadonlyGroup String The status of a read-only instance in a read-only group
    Note: u200dThis field may return null, indicating that no valid values can be obtained.
    OfflineTime String Offline time
    Note: u200dThis field may return null, indicating that no valid values can be obtained.
    DBNodeSet Array of DBNode Instance node information
    Note: u200dThis field may return null, indicating that no valid values can be obtained.
    IsSupportTDE Integer Whether the instance supports TDE data encryption:
  • 0: not supported
  • 1: supported

    • Default value: 0For TDE data encryption, see Overview of Data Transparent Encryption.
    Note: This field may return null, indicating that no valid values can be obtained.
    DBEngine String Database engine, which supports:
  • postgresql: TencentDB for PostgreSQL
  • mssql_compatible: MSSQL compatible - TencentDB for PostgreSQL

    • Default value: postgresql
    Note: This field may return null, indicating that no valid values can be obtained.
    DBEngineConfig String Configuration information for the database engine, and the configuration format is as follows:
    {"$key1":"$value1", "$key2":"$value2"}
    Supported engines include:
    mssql_compatible engine:
  • migrationMode: Database mode, an optional parameter, and its valid values are: single-db (single database schema) and multi-db (multiple database schema). The default value is single-db.
  • defaultLocale: Sorting area rule, an optional parameter, which cannot be modified after initialization, its default value is en_US, and its valid values include:
    "af_ZA", "sq_AL", "ar_DZ", "ar_BH", "ar_EG", "ar_IQ", "ar_JO", "ar_KW", "ar_LB", "ar_LY", "ar_MA", "ar_OM", "ar_QA", "ar_SA", "ar_SY", "ar_TN", "ar_AE", "ar_YE", "hy_AM", "az_Cyrl_AZ", "az_Latn_AZ", "eu_ES", "be_BY", "bg_BG", "ca_ES", "zh_HK", "zh_MO", "zh_CN", "zh_SG", "zh_TW", "hr_HR", "cs_CZ", "da_DK", "nl_BE", "nl_NL", "en_AU", "en_BZ", "en_CA", "en_IE", "en_JM", "en_NZ", "en_PH", "en_ZA", "en_TT", "en_GB", "en_US", "en_ZW", "et_EE", "fo_FO", "fa_IR", "fi_FI", "fr_BE", "fr_CA", "fr_FR", "fr_LU", "fr_MC", "fr_CH", "mk_MK", "ka_GE", "de_AT", "de_DE", "de_LI", "de_LU", "de_CH", "el_GR", "gu_IN", "he_IL", "hi_IN", "hu_HU", "is_IS", "id_ID", "it_IT", "it_CH", "ja_JP", "kn_IN", "kok_IN", "ko_KR", "ky_KG", "lv_LV", "lt_LT", "ms_BN", "ms_MY", "mr_IN", "mn_MN", "nb_NO", "nn_NO", "pl_PL", "pt_BR", "pt_PT", "pa_IN", "ro_RO", "ru_RU", "sa_IN", "sr_Cyrl_RS", "sr_Latn_RS", "sk_SK", "sl_SI", "es_AR", "es_BO", "es_CL", "es_CO", "es_CR", "es_DO", "es_EC", "es_SV", "es_GT", "es_HN", "es_MX", "es_NI", "es_PA", "es_PY","es_PE", "es_PR", "es_ES", "es_TRADITIONAL", "es_UY", "es_VE", "sw_KE", "sv_FI", "sv_SE", "tt_RU", "te_IN", "th_TH", "tr_TR", "uk_UA", "ur_IN", "ur_PK", "uz_Cyrl_UZ", "uz_Latn_UZ", and "vi_VN".
  • serverCollationName: Sorting rule name, an optional parameter, which cannot be modified after initialization, its default value is sql_latin1_general_cp1_ci_as, and its valid values include: "bbf_unicode_general_ci_as", "bbf_unicode_cp1_ci_as", "bbf_unicode_CP1250_ci_as", "bbf_unicode_CP1251_ci_as", "bbf_unicode_cp1253_ci_as", "bbf_unicode_cp1254_ci_as", "bbf_unicode_cp1255_ci_as", "bbf_unicode_cp1256_ci_as", "bbf_unicode_cp1257_ci_as", "bbf_unicode_cp1258_ci_as", "bbf_unicode_cp874_ci_as", "sql_latin1_general_cp1250_ci_as", "sql_latin1_general_cp1251_ci_as", "sql_latin1_general_cp1_ci_as", "sql_latin1_general_cp1253_ci_as", "sql_latin1_general_cp1254_ci_as", "sql_latin1_general_cp1255_ci_as", "sql_latin1_general_cp1256_ci_as", "sql_latin1_general_cp1257_ci_as", "sql_latin1_general_cp1258_ci_as", "chinese_prc_ci_as", "cyrillic_general_ci_as", "finnish_swedish_ci_as", "french_ci_as", "japanese_ci_as", "korean_wansung_ci_as", "latin1_general_ci_as", "modern_spanish_ci_as", "polish_ci_as", "thai_ci_as", "traditional_spanish_ci_as", "turkish_ci_as", "ukrainian_ci_as", and "vietnamese_ci_as".

    • Note: This field may return null, indicating that no valid values can be obtained.
    NetworkAccessList Array of NetworkAccess Network access list of the instance (this field has been deprecated)
    Note: this field may return null, indicating that no valid values can be obtained.
    SupportIpv6 Integer Whether the instance supports IPv6:
  • 0: no
  • 1: yes

    • Default value: 0

    DBInstanceNetInfo

    Instance network connection information

    Used by actions: DescribeDBInstanceAttribute, DescribeDBInstances, DescribeReadOnlyGroups.

    Name Type Description
    Address String DNS domain name
    Ip String Ip
    Port Integer Connection port address
    NetType String Network type. 1: inner (private network address), 2: public (public network address)
    Status String Network connection status. Valid values: initing (never enabled before), opened (enabled), closed (disabled), opening (enabling), closing (disabling)
    VpcId String VPC ID
    Note: this field may return null, indicating that no valid values can be obtained.
    SubnetId String Subnet ID
    Note: this field may return null, indicating that no valid values can be obtained.
    ProtocolType String Database connection protocol type. Valid values: postgresql, mssql (MSSQL-compatible)
    Note: This field may return null, indicating that no valid values can be obtained.

    DBNode

    Instance node information including node type and AZ.

    Used by actions: CloneDBInstance, CreateInstances, DescribeDBInstanceAttribute, DescribeDBInstances, DescribeReadOnlyGroups, ModifyDBInstanceDeployment.

    Name Type Required Description
    Role String Yes Node type. Valid values:
    Primary;
    Standby.
    Zone String Yes AZ where the node resides, such as ap-guangzhou-1.

    Detail

    Details returned by the DescribeSlowQueryAnalysis API

    Used by actions: DescribeSlowQueryAnalysis.

    Name Type Description
    TotalTime Float The total execution time (in ms) of all slow query statements during the specified period of time
    TotalCallNum Integer The total number of all slow query statements during the specified period of time
    AnalysisItems Array of AnalysisItems The statistical analysis list of slow queries
    Note: this field may return null, indicating that no valid values can be obtained.

    DurationAnalysis

    Analyze the execution time of slow query statements by classifying them to different time ranges

    Used by actions: DescribeSlowQueryList.

    Name Type Description
    TimeSegment String Time range
    Count Integer The number of slow query statements whose execution time falls within the time range

    EncryptionKey

    KMS key information

    Used by actions: DescribeEncryptionKeys.

    Name Type Description
    KeyId String Encrypted KeyId of KMS instance
    Note: This field may return null, indicating that no valid value can be obtained.
    KeyAlias String Encryption key alias of KMS instance
    Note: This field may return null, indicating that no valid value can be obtained.
    DEKCipherTextBlob String Instance DEK ciphertext
    Note: This field may return null, indicating that no valid value can be obtained.
    IsEnabled Integer Whether the key is enabled. Valid values: 1 (yes), 0 (no)
    Note: This field may return null, indicating that no valid value can be obtained.
    KeyRegion String Region where KMS key resides
    Note: This field may return null, indicating that no valid value can be obtained.
    CreateTime String DEK key creation time
    Note: This field may return null, indicating that no valid value can be obtained.

    ErrLogDetail

    Error log details

    Used by actions: DescribeDBErrlogs.

    Name Type Description
    UserName String Username
    Database String Database name
    ErrTime String Error occurrence time
    ErrMsg String Error message

    EventInfo

    Parameter modification event information

    Used by actions: DescribeParamsEvent.

    Name Type Description
    ParamName String Parameter name
    Note: this field may return null, indicating that no valid values can be obtained.
    OldValue String Original parameter value
    Note: this field may return null, indicating that no valid values can be obtained.
    NewValue String New parameter value in this modification event
    Note: this field may return null, indicating that no valid values can be obtained.
    ModifyTime String Start time of parameter modification
    Note: this field may return null, indicating that no valid values can be obtained.
    EffectiveTime String Start time when the modified parameter takes effect
    Note: this field may return null, indicating that no valid values can be obtained.
    State String Modification status
    Note: this field may return null, indicating that no valid values can be obtained.
    Operator String Operator (generally, the value is the UIN of a sub-user)
    Note: this field may return null, indicating that no valid values can be obtained.
    EventLog String Event log
    Note: this field may return null, indicating that no valid values can be obtained.

    EventItem

    Modification details of one parameter

    Used by actions: DescribeParamsEvent.

    Name Type Description
    ParamName String Parameter name
    Note: this field may return null, indicating that no valid values can be obtained.
    EventCount Integer The number of modification events
    Note: this field may return null, indicating that no valid values can be obtained.
    EventDetail Array of EventInfo Modification event details
    Note: this field may return null, indicating that no valid values can be obtained.

    Filter

    Key-value pair filter for conditional filtering queries, such as filter ID and name

    • If more than one filter exists, the logical relationship between these filters is AND.
    • If multiple values exist in one filter, the logical relationship between these values is OR.

    Used by actions: DescribeBackupSummaries, DescribeBaseBackups, DescribeDBInstances, DescribeDatabases, DescribeLogBackups, DescribeParameterTemplates, DescribeReadOnlyGroups, DescribeServerlessDBInstances.

    Name Type Required Description
    Name String No Filter name.
    Values Array of String No One or more filter values.

    LogBackup

    Log backup information of a database

    Used by actions: DescribeLogBackups.

    Name Type Description
    DBInstanceId String Instance ID
    Id String Unique ID of a backup file
    Name String Backup file name
    BackupMethod String Backup method, including physical and logical.
    BackupMode String Backup mode, including automatic and manual.
    State String Backup task status
    Size Integer Backup set size in bytes
    StartTime String Backup start time
    FinishTime String Backup end time
    ExpireTime String Backup expiration time

    NetworkAccess

    Network information. (This parameter structure has been deprecated. Please use DBInstanceNetInfo to query network information.)

    Used by actions: DescribeDBInstanceAttribute, DescribeDBInstances, DescribeReadOnlyGroups.

    Name Type Description
    ResourceId String Network resource ID, instance ID, or RO group ID
    Note: this field may return null, indicating that no valid values can be obtained.
    ResourceType Integer Resource type. Valid values: 1 (instance), 2 (RO group)
    Note: this field may return null, indicating that no valid values can be obtained.
    VpcId String VPC ID
    Note: this field may return null, indicating that no valid values can be obtained.
    Vip String IPv4 address
    Note: this field may return null, indicating that no valid values can be obtained.
    Vip6 String IPv6 address
    Note: this field may return null, indicating that no valid values can be obtained.
    Vport Integer Access port
    Note: this field may return null, indicating that no valid values can be obtained.
    SubnetId String Subnet ID
    Note: this field may return null, indicating that no valid values can be obtained.
    VpcStatus Integer Network status. Valid values: 1 (applying), 2 (in use), 3 (deleting), 4 (deleted)
    Note: this field may return null, indicating that no valid values can be obtained.

    NormalQueryItem

    Information of one SlowQuery

    Used by actions: DescribeDBSlowlogs.

    Name Type Description
    UserName String Username
    Calls Integer Number of calls
    CallsGrids Array of Integer Granularity
    CostTime Float Total time consumed
    Rows Integer Number of affected rows
    MinCostTime Float Minimum time consumed
    MaxCostTime Float Maximum time consumed
    FirstTime String Time of the earliest slow SQL statement
    LastTime String Time of the latest slow SQL statement
    SharedReadBlks Integer Shared memory blocks for reads
    SharedWriteBlks Integer Shared memory blocks for writes
    ReadCostTime Integer Total IO read time
    WriteCostTime Integer Total IO write time
    DatabaseName String Database name
    NormalQuery String Slow SQL statement after desensitization

    ParamEntry

    Parameters to be modified in batches

    Used by actions: ModifyDBInstanceParameters, ModifyParameterTemplate.

    Name Type Required Description
    Name String Yes Parameter name
    ExpectedValue String Yes The new value to which the parameter will be modified. When this parameter is used as an input parameter, its value must be a string, such as 0.1 (decimal), 1000 (integer), and replica (enum).

    ParamInfo

    Parameter details

    Used by actions: DescribeDBInstanceParameters, DescribeDefaultParameters, DescribeParameterTemplateAttributes.

    Name Type Description
    ID Integer Parameter ID
    Note: this field may return null, indicating that no valid values can be obtained.
    Name String Parameter name
    Note: this field may return null, indicating that no valid values can be obtained.
    ParamValueType String Value type of the parameter. Valid values: integer, real (floating-point), bool, enum, mutil_enum (this type of parameter can be set to multiple enumerated values).
    For an integer or real parameter, the Min field represents the minimum value and the Max field the maximum value.
    For a bool parameter, the valid values include true and false;
    For an enum or mutil_enum parameter, the EnumValue field represents the valid values.
    Note: this field may return null, indicating that no valid values can be obtained.
    Unit String Unit of the parameter value. If the parameter has no unit, this field will return null.
    Note: This field may return null, indicating that no valid values can be obtained.
    DefaultValue String Default value of the parameter, which is returned as a string
    Note: this field may return null, indicating that no valid values can be obtained.
    CurrentValue String Current value of the parameter, which is returned as a string
    Note: this field may return null, indicating that no valid values can be obtained.
    Max Float The maximum value of the integer or real parameter
    Note: this field may return null, indicating that no valid values can be obtained.
    EnumValue Array of String Value range of the enum parameter
    Note: this field may return null, indicating that no valid values can be obtained.
    Min Float The minimum value of the integer or real parameter
    Note: this field may return null, indicating that no valid values can be obtained.
    ParamDescriptionCH String Parameter description in Chinese
    Note: this field may return null, indicating that no valid values can be obtained.
    ParamDescriptionEN String Parameter description in English
    Note: this field may return null, indicating that no valid values can be obtained.
    NeedReboot Boolean Whether to restart the instance for the modified parameter to take effect. Valid values: true (yes), false (no)
    Note: this field may return null, indicating that no valid values can be obtained.
    ClassificationCN String Parameter category in Chinese
    Note: this field may return null, indicating that no valid values can be obtained.
    ClassificationEN String Parameter category in English
    Note: this field may return null, indicating that no valid values can be obtained.
    SpecRelated Boolean Whether the parameter is related to specifications. Valid values: true (yes), false (no)
    Note: this field may return null, indicating that no valid values can be obtained.
    Advanced Boolean Whether it is a key parameter. Valid values: true (yes, and modifying it may affect instance performance), false (no)
    Note: this field may return null, indicating that no valid values can be obtained.
    LastModifyTime String The last modified time of the parameter
    Note: this field may return null, indicating that no valid values can be obtained.
    StandbyRelated Integer Parameter primary-secondary constraints, 0: No constraint, 1: Standby parameter value must be greater than that of the primary machine, 2: Primary parameter value must be greater than that of the standby machine.
    Note: This field may return null, indicating that no valid values can be obtained.
    VersionRelationSet Array of ParamVersionRelation Parameter version association information, containing detailed parameter information for the respective kernel version
    Note: This field may return null, indicating that no valid values can be obtained.
    SpecRelationSet Array of ParamSpecRelation Parameter specification association information, containing detailed parameter information for the respective specification
    Note: This field may return null, indicating that no valid values can be obtained.

    ParamSpecRelation

    Parameter information for each specification

    Used by actions: DescribeDBInstanceParameters, DescribeDefaultParameters, DescribeParameterTemplateAttributes.

    Name Type Description
    Name String Parameter name
    Note: This field may return null, indicating that no valid values can be obtained.
    Memory String The specification that corresponds to the parameter information
    Note: This field may return null, indicating that no valid values can be obtained.
    Value String The default parameter value under this specification
    Note: This field may return null, indicating that no valid values can be obtained.
    Unit String Unit of the parameter value. If the parameter has no unit, this field will return null.
    Note: This field may return null, indicating that no valid values can be obtained.
    Max Float The maximum value of the integer or real parameter
    Note: This field may return null, indicating that no valid values can be obtained.
    Min Float The minimum value of the integer or real parameter
    Note: This field may return null, indicating that no valid values can be obtained.
    EnumValue Array of String Value range of the enum parameter
    Note: This field may return null, indicating that no valid values can be obtained.

    ParamVersionRelation

    Parameter information for each version

    Used by actions: DescribeDBInstanceParameters, DescribeDefaultParameters, DescribeParameterTemplateAttributes.

    Name Type Description
    Name String Parameter name
    Note: This field may return null, indicating that no valid values can be obtained.
    DBKernelVersion String The kernel version that corresponds to the parameter information
    Note: This field may return null, indicating that no valid values can be obtained.
    Value String Default parameter value under the kernel version and specification of the instance
    Note: This field may return null, indicating that no valid values can be obtained.
    Unit String Unit of the parameter value. If the parameter has no unit, this field will return null.
    Note: This field may return null, indicating that no valid values can be obtained.
    Max Float The maximum value of the integer or real parameter
    Note: This field may return null, indicating that no valid values can be obtained.
    Min Float The minimum value of the integer or real parameter
    Note: This field may return null, indicating that no valid values can be obtained.
    EnumValue Array of String Value range of the enum parameter
    Note: This field may return null, indicating that no valid values can be obtained.

    ParameterTemplate

    Basic information of a parameter template

    Used by actions: DescribeParameterTemplates.

    Name Type Description
    TemplateId String Parameter template ID
    TemplateName String Parameter template name
    DBMajorVersion String Database version applicable to a parameter template
    DBEngine String Database engine applicable to a parameter template
    TemplateDescription String Parameter template description

    PgDeal

    Order details

    Used by actions: DescribeOrders.

    Name Type Description
    DealName String Order name
    OwnerUin String User
    Count Integer Number of instances involved in order
    PayMode Integer Billing mode. 0: pay-as-you-go
    FlowId Integer Async task flow ID
    DBInstanceIdSet Array of String Instance ID array

    PolicyRule

    Rule information for security group

    Used by actions: DescribeDBInstanceSecurityGroups.

    Name Type Description
    Action String Policy, Valid values: ACCEPT, DROP.
    CidrIp String Source or destination IP or IP range, such as 172.16.0.0/12.
    PortRange String Port
    IpProtocol String Network protocol. UDP and TCP are supported.
    Description String The rule description

    RawSlowQuery

    The list of slow query details returned by the DescribeSlowQueryList API

    Used by actions: DescribeSlowQueryList.

    Name Type Description
    RawQuery String Slow query statement
    DatabaseName String The database queried by the slow query statement
    Duration Float The execution time of the slow query statement
    ClientAddr String The client that executes the slow query statement
    UserName String The name of the user who executes the slow query statement
    SessionStartTime String The time when the slow query statement starts to execute

    ReadOnlyGroup

    RO group information

    Used by actions: DescribeReadOnlyGroups.

    Name Type Description
    ReadOnlyGroupId String RO group identifier
    Note: this field may return null, indicating that no valid values can be obtained.
    ReadOnlyGroupName String RO group name
    Note: this field may return null, indicating that no valid values can be obtained.
    ProjectId Integer Project ID
    Note: this field may return null, indicating that no valid values can be obtained.
    MasterDBInstanceId String Primary instance ID
    Note: this field may return null, indicating that no valid values can be obtained.
    MinDelayEliminateReserve Integer The minimum number of read-only replicas that must be retained in an RO group
    Note: this field may return null, indicating that no valid values can be obtained.
    MaxReplayLatency Integer Delayed log size threshold
    ReplayLatencyEliminate Integer Whether to remove a read-only replica from an RO group if the sync log size difference between the read-only replica and the primary instance exceeds the threshold. Valid values: 0 (no), 1 (yes).
    MaxReplayLag Float Delay threshold
    ReplayLagEliminate Integer Whether to remove a read-only replica from an RO group if the delay between the read-only replica and the primary instance exceeds the threshold. Valid values: 0 (no), 1 (yes).
    VpcId String VPC ID
    SubnetId String Subnet ID
    Note: this field may return null, indicating that no valid values can be obtained.
    Region String Region ID
    Zone String Availability zone ID
    Status String Status
    ReadOnlyDBInstanceList Array of DBInstance Instance details
    Rebalance Integer Whether to enable automatic load balancing
    DBInstanceNetInfo Array of DBInstanceNetInfo Network information
    NetworkAccessList Array of NetworkAccess Network access list of the RO group (this field has been deprecated)
    Note: this field may return null, indicating that no valid values can be obtained.

    RegionInfo

    Region information such as number and status

    Used by actions: DescribeRegions.

    Name Type Description
    Region String Region abbreviation
    RegionName String Region name
    RegionId Integer Region number
    RegionState String Availability status. UNAVAILABLE: unavailable, AVAILABLE: available
    SupportInternational Integer Whether the resource can be purchased in this region. Valid values: 0 (no), 1 (yes).
    Note: this field may return null, indicating that no valid values can be obtained.

    SecurityGroup

    Security group information

    Used by actions: DescribeDBInstanceSecurityGroups.

    Name Type Description
    ProjectId Integer Project ID
    CreateTime String Creation time
    Inbound Array of PolicyRule Inbound rule
    Outbound Array of PolicyRule Outbound rule
    SecurityGroupId String Security group ID
    SecurityGroupName String Security group name
    SecurityGroupDescription String Security group remarks

    ServerlessDBAccount

    PostgreSQL for Serverless instance account description

    Used by actions: DescribeServerlessDBInstances.

    Name Type Description
    DBUser String Username
    Note: this field may return null, indicating that no valid values can be obtained.
    DBPassword String Password
    Note: this field may return null, indicating that no valid values can be obtained.
    DBConnLimit Integer The maximum number of connections
    Note: this field may return null, indicating that no valid values can be obtained.

    ServerlessDBInstance

    PostgreSQL for Serverless instance description

    Used by actions: DescribeServerlessDBInstances.

    Name Type Required Description
    DBInstanceId String No Instance ID, which is the unique identifier
    Note: this field may return null, indicating that no valid values can be obtained.
    DBInstanceName String No Instance name
    Note: this field may return null, indicating that no valid values can be obtained.
    DBInstanceStatus String No Instance status
    Note: this field may return null, indicating that no valid values can be obtained.
    Region String No Region
    Note: this field may return null, indicating that no valid values can be obtained.
    Zone String No Availability zone
    Note: this field may return null, indicating that no valid values can be obtained.
    ProjectId Integer No Project ID
    Note: this field may return null, indicating that no valid values can be obtained.
    VpcId String No VPC ID
    Note: this field may return null, indicating that no valid values can be obtained.
    SubnetId String No Subnet ID
    Note: this field may return null, indicating that no valid values can be obtained.
    DBCharset String No Character set
    Note: this field may return null, indicating that no valid values can be obtained.
    DBVersion String No Database version
    Note: this field may return null, indicating that no valid values can be obtained.
    CreateTime String No Creation time
    Note: this field may return null, indicating that no valid values can be obtained.
    DBInstanceNetInfo Array of ServerlessDBInstanceNetInfo No Instance network information
    Note: this field may return null, indicating that no valid values can be obtained.
    DBAccountSet Array of ServerlessDBAccount No Instance account information
    Note: this field may return null, indicating that no valid values can be obtained.
    DBDatabaseList Array of String No Information of the databases in an instance
    Note: this field may return null, indicating that no valid values can be obtained.
    TagList Array of Tag No The array of tags bound to an instance
    Note: this field may return null, indicating that no valid values can be obtained.
    DBKernelVersion String No Database kernel version
    Note: this field may return null, indicating that no valid values can be obtained.
    DBMajorVersion String No Database major version number
    Note: this field may return null, indicating that no valid values can be obtained.

    ServerlessDBInstanceNetInfo

    PostgreSQL for Serverless instance network description

    Used by actions: DescribeServerlessDBInstances.

    Name Type Description
    Address String Address
    Note: this field may return null, indicating that no valid values can be obtained.
    Ip String IP address
    Note: this field may return null, indicating that no valid values can be obtained.
    Port Integer Port number
    Note: this field may return null, indicating that no valid values can be obtained.
    Status String Status
    Note: this field may return null, indicating that no valid values can be obtained.
    NetType String Network type
    Note: this field may return null, indicating that no valid values can be obtained.

    SlowlogDetail

    Slow query details

    Used by actions: DescribeDBSlowlogs.

    Name Type Description
    TotalTime Float Total time consumed
    TotalCalls Integer Total number of calls
    NormalQueries Array of NormalQueryItem List of slow SQL statements after desensitization

    SpecInfo

    Purchasable specification details in an AZ in a region.

    Used by actions: DescribeProductConfig.

    Name Type Description
    Region String Region abbreviation, which corresponds to the Region field of RegionSet
    Zone String AZ abbreviate, which corresponds to the Zone field of ZoneSet
    SpecItemInfoList Array of SpecItemInfo Specification details list
    SupportKMSRegions Array of String Regions where KMS is supported
    Note: This field may return null, indicating that no valid value was found.

    SpecItemInfo

    Specification description

    Used by actions: DescribeProductConfig.

    Name Type Description
    SpecCode String Specification ID
    Version String PostgerSQL version number
    VersionName String Full version name corresponding to kernel number
    Cpu Integer Number of CPU cores
    Memory Integer Memory size in MB
    MaxStorage Integer Maximum storage capacity in GB supported by this specification
    MinStorage Integer Minimum storage capacity in GB supported by this specification
    Qps Integer Estimated QPS for this specification
    Pid Integer (Disused)
    Type String Machine type
    MajorVersion String PostgreSQL major version number
    Note: this field may return null, indicating that no valid values can be obtained.
    KernelVersion String PostgreSQL kernel version number
    Note: this field may return null, indicating that no valid values can be obtained.
    IsSupportTDE Integer Whether TDE data encryption is supported. Valid values: 0 (no), 1 (yes)
    Note: This field may return null, indicating that no valid value was found.

    Tag

    The information of tags associated with instances, including TagKey and TagValue

    Used by actions: CloneDBInstance, CreateDBInstances, CreateInstances, CreateReadOnlyDBInstance, CreateServerlessDBInstance, DescribeDBInstanceAttribute, DescribeDBInstances, DescribeReadOnlyGroups, DescribeServerlessDBInstances.

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

    Version

    Database version information

    Used by actions: DescribeDBVersions.

    Name Type Description
    DBEngine String Database engines. Valid values:
    1. postgresql (TencentDB for PostgreSQL)
    2. mssql_compatible (MSSQL compatible-TencentDB for PostgreSQL)
    DBVersion String Database version, such as 12.4.
    DBMajorVersion String Database major version, such as 12.
    DBKernelVersion String Database kernel version, such as v12.4_r1.3.
    SupportedFeatureNames Array of String List of features supported by the database kernel, such as:
    TDE: Supports data encryption.
    Status String Database version status. Valid values:
    AVAILABLE.
    DEPRECATED.
    AvailableUpgradeTarget Array of String List of versions to which this database version (DBKernelVersion) can be upgraded, including minor and major version numbers available for upgrade (complete kernel version format example: v15.1_v1.6).

    Xlog

    Database Xlog information

    Used by actions: DescribeDBXlogs.

    Name Type Description
    Id Integer Unique backup file ID
    StartTime Timestamp File generation start time
    EndTime Timestamp File generation end time
    InternalAddr String Download address on private network
    ExternalAddr String Download address on public network
    Size Integer Backup file size

    ZoneInfo

    AZ information such as number and status

    Used by actions: DescribeZones.

    Name Type Description
    Zone String AZ abbreviation
    ZoneName String AZ name
    ZoneId Integer AZ number
    ZoneState String Availability status. Valid values:
    UNAVAILABLE.
    AVAILABLE.
    SELLOUT.
    SUPPORTMODIFYONLY (supports configuration adjustment).
    ZoneSupportIpv6 Integer Whether the AZ supports IPv6 address access
    StandbyZoneSet Array of String AZs that can be used as standby when this AZ is primary
    Note: this field may return null, indicating that no valid values can be obtained.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款