tencent cloud

Feedback

Data Types

Last updated: 2022-05-12 10:56:37

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: secondary 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 Delay distribution. The mapping between delay range and Ladder value is as follows:
[0ms,1ms]: 1;
[1ms,5ms]: 5;
[5ms,10ms]: 10;
[10ms,50ms]: 50;
[50ms,200ms]: 200;
[200ms,∞]: -1.
Size Integer The number of commands whose delay falls within the current delay range
Updatetime Integer Modification time

Groups

Replication group info

Used by actions: DescribeReplicationGroup.

Name Type Description
AppId Integer User App 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
GroupId String Replication group info
GroupName String Replication group name
Note: This field may return null, indicating that no valid values can be obtained.
Status Integer Replication group status. Valid values: 37 (Associating replication group), 38 (Reconnecting to replication group), 51 (Disassociating the replication group), 52 (Switching primary instance in the replication group), 53 (Modifying roles)
InstanceCount Integer Number of replication groups
Instances Array of Instances Instances in replication group
Note: This field may return null, indicating that no valid values can be obtained.
Remark String Remarks
Note: This field may return null, indicating that no valid values can be obtained.

HotKeyInfo

Hot key details

Used by actions: DescribeInstanceMonitorHotKey.

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

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
Node String Node ID

Instances

Instances in replication group

Used by actions: DescribeReplicationGroup.

Name Type Description
AppId Integer User App ID
InstanceId String Instance ID
InstanceName String Instance name
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)
ZoneId Integer Region ID
RedisReplicasNum Integer Number of replicas
RedisShardNum Integer Number of shards
RedisShardSize Integer Shard size
DiskSize Integer Instance disk size
Note: This field may return null, indicating that no valid values can be obtained.
Engine String Engine: Redis community edition, Tencent Cloud CKV
Role String Instance role. Valid values: rw (read-write), r( read-only)
Vip String Instance VIP
Vip6 String Internal parameter, which can be ignored.
Note: This field may return null, indicating that no valid values can be obtained.
VpcID Integer VPC ID, such as 75101
VPort Integer Instance Port
Status Integer Instance status. 0: to be initialized; 1: in process; 2: running; -2: isolated; -3: to be deleted
GrocerySysId Integer Repository ID
ProductType Integer Instance type. Valid values: 1 (Redis 2.8 memory edition in cluster architecture), 2 (Redis 2.8 memory edition in standard architecture), 3 (CKV 3.2 memory edition in standard architecture), 4 (CKV 3.2 memory edition in cluster architecture), 5 (Redis 2.8 memory edition in standalone architecture), 6 (Redis 4.0 memory edition in standard architecture), 7 (Redis 4.0 memory edition in cluster architecture), 8 (Redis 5.0 memory edition in standard architecture), 9 (Redis 5.0 memory edition in cluster architecture)
CreateTime String Creation time
UpdateTime String Update time

ProductConf

Product information

Used by actions: DescribeProductInfo.

Name Type Description
Type Integer Product type. Valid values: 2 (Redis 2.8 Memory Edition in standard architecture), 3 (CKV 3.2 Memory Edition in standard architecture), 4 (CKV 3.2 Memory Edition in cluster architecture), 5 (Redis 2.8 Memory Edition in standalone architecture), 6 (Redis 4.0 Memory Edition in standard architecture), 7 (Redis 4.0 Memory Edition in cluster architecture), 8 (Redis 5.0 Memory Edition in standard architecture), 9 (Redis 5.0 Memory Edition in cluster architecture), 10 (Redis 4.0 Hybrid Storage Edition (Tendis)).
TypeName String Product name: Redis Master-Replica Edition, CKV Master-Replica Edition, CKV Cluster Edition, Redis Standalone Edition, Redis Cluster Edition, Tendis Hybrid Storage 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

ProxyNodes

Proxy node information

Used by actions: DescribeInstanceNodeInfo.

Name Type Description
NodeId String Node ID
Note: This field may return null, indicating that no valid values can be obtained.

RedisNodes

Redis node information

Used by actions: DescribeInstanceNodeInfo.

Name Type Description
NodeId String Node ID
NodeRole String Node role
ClusterId Integer Shard ID
ZoneId Integer AZ ID

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

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

TendisNodes

Tendis node information

Used by actions: DescribeInstanceNodeInfo.

Name Type Description
NodeId String Node ID
NodeRole String Node role

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
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support