Data Types

Last updated: 2020-09-17 18:00:13

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

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.

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
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.

DBInstanceNetInfo

Instance network connection information

Used by actions: DescribeDBInstanceAttribute, DescribeDBInstances.

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

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

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.

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

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

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

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, DescribeDBInstanceAttribute, DescribeDBInstances.

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

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help