Data Types

Last updated: 2021-11-16 17:22:44

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

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

DBInstance

Instance details

Used by actions: DescribeDBInstanceAttribute, DescribeDBInstances, DescribeReadOnlyGroups.

Name Type Description
Region String Instance region such as ap-guangzhou, which corresponds to the Region field of RegionSet
Zone String Instance AZ such as ap-guangzhou-3, which corresponds to the Zone field of ZoneSet
ProjectId Integer Project ID
VpcId String VPC ID
SubnetId String SubnetId
DBInstanceId String Instance ID
DBInstanceName String Instance name
DBInstanceStatus String Instance status. Valid values: applying, init (to be initialized), initing (initializing), running, limited run, isolated, recycling, recycled, job running, offline, migrating, expanding, waitSwitch (waiting for switch), switching, readonly, restarting
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
DBInstanceType String Instance type. 1: primary (master instance), 2: readonly (read-only instance), 3: guard (disaster recovery instance), 4: temp (temp instance)
DBInstanceVersion String Instance edition. Currently, only standard edition (dual-server high-availability one-master-one-slave edition) is supported
DBCharset String Instance database character set
DBVersion String PostgreSQL kernel version
CreateTime Timestamp Instance creation time
UpdateTime Timestamp Instance last modified time
ExpireTime Timestamp Instance expiration time
IsolatedTime Timestamp Instance isolation time
PayType String Billing mode. postpaid: pay-as-you-go
AutoRenew Integer Whether to renew automatically. 1: yes, 0: no
DBInstanceNetInfo Array of DBInstanceNetInfo Instance network connection information
Type String Machine type
AppId Integer User AppId
Uid Integer Instance Uid
SupportIpv6 Integer Whether the instance supports IPv6 address access. Valid values: 1 (yes), 0 (no)
TagList Array of Tag The information of tags associated with instances.
Note: this 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: this field may return null, indicating that no valid values can be obtained.
ReadOnlyInstanceNum Integer Number of read-only instances
Note: this field may return null, indicating that no valid values can be obtained.
StatusInReadonlyGroup String The status of a instance in a read-only group
Note: this field may return null, indicating that no valid values can be obtained.
OfflineTime String Elimination time
Note: this field may return null, indicating that no valid values can be obtained.

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

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

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: DescribeDBInstances, DescribeReadOnlyGroups, DescribeServerlessDBInstances.

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

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.

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.

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)
Note: this field may return null, indicating that no valid values can be obtained.
Unit String Value unit of the parameter. If the parameter has no unit, this field will return an empty string.
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.
EnumValue Array of String Value range of the enum parameter
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.
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.

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

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

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.

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.

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

SpecItemInfo

Specification description

Used by actions: DescribeProductConfig.

Name Type Description
SpecCode String Specification ID
Version String PostgreSQL kernel 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 Billing ID for this specification
Type String Machine type

Tag

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

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

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

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. UNAVAILABLE: unavailable, AVAILABLE: available
ZoneSupportIpv6 Integer Whether the AZ supports IPv6 address access