Data Types

Last updated: 2019-12-05 19:11:49

PDF

Account

Sub-account information

Used by actions: DescribeInstanceAccount.

Name Type Description
InstanceId String Instance ID
Note: This field may return null, indicating that no valid values can be obtained.
AccountName String Account name (root for a root account)
Note: This field may return null, indicating that no valid values can be obtained.
Remark String Account description information
Note: This field may return null, indicating that no valid values can be obtained.
Privilege String Read/write policy. r: read-only; w: write-only; rw: read/write
Note: This field may return null, indicating that no valid values can be obtained.
ReadonlyPolicy Array of String Routing policy. master: master node; replication: slave node
Note: This field may return null, indicating that no valid values can be obtained.
Status Integer Sub-account status. 1: account is being changed; 2: account is valid; -4: account has been deleted
Note: This field may return null, indicating that no valid values can be obtained.

BigKeyInfo

Big key details

Used by actions: DescribeInstanceMonitorBigKey.

Name Type Description
DB Integer Database
Key String Big key
Type String Type
Size Integer Size
Updatetime Integer Data timestamp

BigKeyTypeInfo

Big key type distribution details

Used by actions: DescribeInstanceMonitorBigKeyTypeDist.

Name Type Description
Type String Type
Count Integer Count
Size Integer Size
Updatetime Integer Timestamp

CommandTake

Command duration

Used by actions: DescribeInstanceMonitorTopNCmdTook.

Name Type Description
Cmd String Command
Took Integer Duration

DelayDistribution

Delay distribution details

Used by actions: DescribeInstanceMonitorBigKeySizeDist、DescribeInstanceMonitorTookDist.

Name Type Description
Ladder Integer Distribution ladder
Size Integer Size

HotKeyInfo

Hot key details

Used by actions: DescribeInstanceMonitorHotKey.

Name Type Description
Key String Hot key
Type String Type
Count Integer Count

InstanceClusterNode

Instance node type

Used by actions: DescribeInstances.

Name Type Description
Name String Node name
RunId String ID of the runtime node of an instance
Role Integer Cluster role. 0: master; 1: slave
Status Integer Node status. 0: readwrite; 1: read; 2: backup
Connected Integer Service status. 0: down; 1: on
CreateTime String Node creation time
DownTime String Node deactivation time
Slots String Distribution of node slots
Keys Integer Distribution of node keys
Qps Integer Node QPS
QpsSlope Float QPS slope of a node
Storage Integer Node storage
StorageSlope Float Storage slope of a node

InstanceClusterShard

Information list of instance shards

Used by actions: DescribeInstanceShards.

Name Type Description
ShardName String Shard node name
ShardId String Shard node ID
Role Integer Role
Keys Integer Number of keys
Slots String Slot information
Storage Integer Storage capacity
StorageSlope Float Capacity slope
Runid String ID of the runtime node of an instance
Connected Integer Service status. 0: down; 1: on

InstanceEnumParam

Descriptions of enumeration parameters of the instance

Used by actions: DescribeInstanceParams.

Name Type Description
ParamName String Parameter name
ValueType String Parameter type: Enum
NeedRestart String Whether restart is required after a modification is made. Value range: true, false
DefaultValue String Default value of the parameter
CurrentValue String Current value of a parameter
Tips String Parameter description
EnumValue Array of String Value range of a parameter
Status Integer Parameter status. 1: modifying; 2: modified

InstanceIntegerParam

Descriptions of integer parameters of the instance

Used by actions: DescribeInstanceParams.

Name Type Description
ParamName String Parameter name
ValueType String Parameter type: Integer
NeedRestart String Whether restart is required after a modification is made. Value range: true, false
DefaultValue String Default value of the parameter
CurrentValue String Current value of a parameter
Tips String Parameter description
Min String Minimum value of a parameter
Max String Maximum value of a parameter
Status Integer Parameter status. 1: modifying; 2: modified

InstanceMultiParam

Description of an instance parameter in Multi type

Used by actions: DescribeInstanceParams.

Name Type Description
ParamName String Parameter name
ValueType String Parameter type: Multi
NeedRestart String Whether restart is required after a modification is made. Value range: true, false
DefaultValue String Default value of the parameter
CurrentValue String Current value of a parameter
Tips String Parameter description
EnumValue String Parameter description
Status Integer Parameter status. 1: modifying; 2: modified

InstanceNode

Instance node

Used by actions: DescribeInstances.

Name Type Description
Id Integer Id
InstanceClusterNode Array of InstanceClusterNode Node details

InstanceParam

Instance parameter

Used by actions: ModifyInstanceParams.

Name Type Required Description
Key String Yes Sets a parameter name
Value String Yes Sets a parameter value

InstanceParamHistory

History of instance parameter modifications

Used by actions: DescribeInstanceParamRecords.

Name Type Description
ParamName String Parameter name
PreValue String Value before modification
NewValue String Value after modification
Status Integer Status. 1: modifying parameter configuration; 2: parameter configuration modified successfully; 3: failed to modify parameter configuration
ModifyTime String Modification time

InstanceSecurityGroupDetail

Security group information of an instance

Used by actions: DescribeInstanceSecurityGroup.

Name Type Description
InstanceId String Instance ID
SecurityGroupDetails Array of SecurityGroupDetail Security group information

InstanceSet

List of instance details

Used by actions: DescribeInstances.

Name Type Description
InstanceName String Instance name
InstanceId String Instance ID
Appid Integer User's Appid
ProjectId Integer Project ID
RegionId Integer Region ID. 1: Guangzhou; 4: Shanghai; 5: Hong Kong, China; 6: Toronto; 7: Shanghai Finance; 8: Beijing; 9: Singapore; 11: Shenzhen Finance; 15: West US (Silicon Valley); 16: Chengdu; 17: Germany; 18: South Korea; 19: Chongqing; 21: India; 22: East US (Virginia); 23: Thailand; 24: Russia; 25: Japan
ZoneId Integer Region ID
VpcId Integer VPC ID, such as 75101
SubnetId Integer VPC subnet ID, such as 46315
Status Integer Current instance status. 0: to be initialized; 1: instance in process; 2: instance running; -2: instance isolated; -3: instance to be deleted
WanIp String Instance VIP
Port Integer Port number of an instance
Createtime String Instance creation time
Size Float Instance capacity in MB
SizeUsed Float This field has been disused
Type Integer Instance type. 1: Redis 2.8 cluster edition; 2: Redis 2.8 master-slave edition; 3: CKV master-slave edition (Redis 3.2); 4: CKV cluster edition (Redis 3.2); 5: Redis 2.8 standalone edition; 6: Redis 4.0 master-slave edition; 7: Redis 4.0 cluster edition
AutoRenewFlag Integer Whether to set the auto-renewal flag for an instance. 1: auto-renewal set; 0: auto-renewal not set
DeadlineTime String Instance expiration time
Engine String Engine: Redis community edition, Tencent Cloud CKV
ProductType String Product type: Redis 2.8 cluster edition, Redis 2.8 master-slave edition, Redis 3.2 master-slave edition (CKV master-slave edition), Redis 3.2 cluster edition (CKV cluster edition), Redis 2.8 standalone edition, Redis 4.0 cluster edition
UniqVpcId String VPC ID, such as vpc-fk33jsf43kgv
UniqSubnetId String VPC subnet ID, such as subnet-fd3j6l35mm0
BillingMode Integer Billing method. 0: pay-as-you-go; 1: monthly subscription
InstanceTitle String Description of an instance status, such as "instance running"
OfflineTime String Scheduled deactivation time
SubStatus Integer Sub-status returned for an instance in process
Tags Array of String Anti-affinity tag
InstanceNode Array of InstanceNode Instance node information
RedisShardSize Integer Shard size
RedisShardNum Integer Number of shards
RedisReplicasNum Integer Number of replicas
PriceId Integer Billing ID
CloseTime String Isolation time
SlaveReadWeight Integer Read weight of a slave node
InstanceTags Array of InstanceTagInfo Instance tag information
Note: This field may return null, indicating that no valid values can be obtained.
ProjectName String Project name
Note: This field may return null, indicating that no valid values can be obtained.
NoAuth Boolean Whether an instance is password-free. true: yes; false: no
Note: This field may return null, indicating that no valid values can be obtained.

InstanceSlowlogDetail

Slow log details

Used by actions: DescribeSlowLog.

Name Type Description
Duration Integer Slow log duration
Client String Client address
Command String Command
CommandLine String Command line details
ExecuteTime String Execution duration

InstanceTagInfo

Instance tag information

Used by actions: DescribeInstances.

Name Type Description
TagKey String Tag key
TagValue String Tag value

InstanceTextParam

Descriptions of text parameters of the instance

Used by actions: DescribeInstanceParams.

Name Type Description
ParamName String Parameter name
ValueType String Parameter type: Text
NeedRestart String Whether restart is required after a modification is made. Value range: true, false
DefaultValue String Default value of the parameter
CurrentValue String Current value of a parameter
Tips String Parameter description
TextValue Array of String Value range of a parameter
Status Integer Parameter status. 1: modifying; 2: modified

ProductConf

Product information

Used by actions: DescribeProductInfo.

Name Type Description
Type Integer Product type. 2: Redis master-slave edition; 3: CKV master-slave edition; 4: CKV cluster edition; 5: Redis standalone edition; 7: Redis cluster edition
TypeName String Product name: Redis master-slave edition, CKV master-slave edition, CKV cluster edition, Redis standalone edition, or Redis cluster edition
MinBuyNum Integer Minimum purchasable quantity
MaxBuyNum Integer Maximum purchasable quantity
Saleout Boolean Whether a product is sold out
Engine String Product engine: Tencent Cloud CKV or Redis community edition
Version String Compatible version: Redis 2.8, Redis 3.2, or Redis 4.0
TotalSize Array of String Total capacity in GB
ShardSize Array of String Shard size in GB
ReplicaNum Array of String Number of replicas
ShardNum Array of String Number of shards
PayMode String Supported billing method. 1: monthly subscription; 0: pay-as-you-go
EnableRepicaReadOnly Boolean Whether to support read-only replicas

RedisBackupSet

Array of instance backups

Used by actions: DescribeInstanceBackups.

Name Type Description
StartTime String Backup start time
BackupId String Backup ID
BackupType String Backup type. manualBackupInstance: manual backup initiated by user; systemBackupInstance: midnight backup initiated by system
Status Integer Backup status. 1: backup is locked by another process; 2: backup is normal and not locked by any process; -1: backup has expired; 3: backup is being exported; 4: backup is exported successfully
Remark String Backup remarks
Locked Integer Whether a backup is locked. 0: no; 1: yes

RegionConf

Region information

Used by actions: DescribeProductInfo.

Name Type Description
RegionId String Region ID
RegionName String Region name
RegionShortName String Region abbreviation
Area String Name of the area where a region is located
ZoneSet Array of ZoneCapacityConf AZ information

SecurityGroupDetail

Security group details

Used by actions: DescribeInstanceSecurityGroup、DescribeProjectSecurityGroup.

Name Type Description
ProjectId Integer Project ID
CreateTime String Creation time
SecurityGroupId String Security group ID
SecurityGroupName String Security group name
SecurityGroupRemark String Security group remarks
InboundRule Array of SecurityGroupsInboundAndOutbound Security group inbound rule
OutboundRule Array of SecurityGroupsInboundAndOutbound Security group outbound rule

SecurityGroupsInboundAndOutbound

Inbound and outbound rules of the security group

Used by actions: DescribeInstanceSecurityGroup、DescribeProjectSecurityGroup.

Name Type Description
Action String Action to be executed
Ip String IP address
Port String Port number
Proto String Protocol type

SourceCommand

Access command

Used by actions: DescribeInstanceMonitorTopNCmd.

Name Type Description
Cmd String Command
Count Integer Number of executions

SourceInfo

Access source information

Used by actions: DescribeInstanceMonitorSIP.

Name Type Description
Ip String Source IP
Conn Integer Number of connections
Cmd Integer Command

TaskInfoDetail

Task details

Used by actions: DescribeTaskList.

Name Type Description
TaskId Integer Task ID
Note: This field may return null, indicating that no valid values can be obtained.
StartTime String Start time
Note: This field may return null, indicating that no valid values can be obtained.
TaskType String Task type
Note: This field may return null, indicating that no valid values can be obtained.
InstanceName String Instance name
Note: This field may return null, indicating that no valid values can be obtained.
InstanceId String Instance ID
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.
Progress Float Task progress
Note: This field may return null, indicating that no valid values can be obtained.
EndTime String End time
Note: This field may return null, indicating that no valid values can be obtained.
Result Integer Task status
Note: This field may return null, indicating that no valid values can be obtained.

TradeDealDetail

Order deal information

Used by actions: DescribeInstanceDealDetail.

Name Type Description
DealId String Order ID, which is used when a TencentCloud API is called
DealName String Long order ID, which is used when an order issue is submitted for assistance
ZoneId Integer AZ ID
GoodsNum Integer Number of instances associated with an order
Creater String Creates a user uin
CreatTime String Order creation time
OverdueTime String Order timeout period
EndTime String Order completion time
Status Integer Order status. 1: unpaid; 2: paid but not delivered; 3: In delivery; 4: successfully delivered; 5: delivery failed; 6: refunded; 7: order closed; 8: order expired; 9: order invalidated; 10: product invalidated; 11: requested payment rejected; 12: paying
Description String Order status description
Price Integer Actual total price of an order in 0.01 CNY
InstanceIds Array of String Instance ID

ZoneCapacityConf

Product information in the availability zone

Used by actions: DescribeProductInfo.

Name Type Description
ZoneId String AZ ID, such as ap-guangzhou-3
ZoneName String AZ name
IsSaleout Boolean Whether a product is sold out in an AZ
IsDefault Boolean Whether it is a default AZ
NetWorkType Array of String Network type. basenet: basic network; vpcnet: VPC
ProductSet Array of ProductConf Information of an AZ, such as product specifications in it
OldZoneId Integer AZ ID, such as 100003