tencent cloud

$0 14-Day TrialExperience EdgeOne for acceleration and security protection!

Feedback

Data Types

Last updated: 2024-12-04 11:19:39

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 value can be obtained.
AccountName String Account name.
Note: This field may return null, indicating that no valid value can be obtained.
Remark String Account description.
Note: This field may return null, indicating that no valid value can be obtained.
Privilege String Read/write permission policy.
- r: read-only.
- w: write-only.
- rw: read/write.
Note: This field may return null, indicating that no valid value can be obtained.
ReadonlyPolicy Array of String Read-only routing policy.
- master: primary node.
- replication: secondary node.
Note: This field may return null, indicating that no valid value can be obtained.
Status Integer Sub-account status.
- 1: changing.
- 2: valid.
- 4: deleted.
Note: This field may return null, indicating that no valid value can be obtained.
CreateTime String Creation time.Note: This field may return null, indicating that no valid values can be obtained.

AvailableRegion

Available region information.

Used by actions: DescribeGlobalReplicationArea.

Name Type Description
Region String Region

Note: This field may return null, indicating that no valid value can be obtained.
AvailableZones Array of String AZ information.
Note: This field may return null, indicating that no valid value can be obtained.

BackupDownloadInfo

Backup download information

Used by actions: DescribeBackupUrl.

Name Type Description
FileName String Backup file name
FileSize Integer Backup file size in bytes. If the parameter value is 0, the backup file size is unknown.
DownloadUrl String Address (valid for six hours) used to download the backup file over the public network
InnerDownloadUrl String Address (valid for six hours) used to download the backup file over the private network

BackupLimitVpcItem

The VPC that corresponds to the configured download address of the backup file

Used by actions: DescribeBackupDownloadRestriction, DescribeBackupUrl, ModifyBackupDownloadRestriction.

Name Type Required Description
Region String Yes The region of the VPC that corresponds to the download address of the backup file
VpcList Array of String Yes The list of VPCs that correspond to the download addresses of the backup files

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

CDCResource

Details of the dedicated Redis cluster.

Used by actions: DescribeRedisClusters.

Name Type Description
AppId Integer App ID of a user.
RegionId Integer Region ID.
ZoneId Integer AZ ID.
RedisClusterId String ID of the dedicated Redis cluster.
PayMode Integer Billing mode. 1: monthly subscription; 0: pay-as-you-go.
ProjectId Integer Project ID.
AutoRenewFlag Integer Automatic renewal flag. 0: default status (manual renewal); 1: automatic renewal; 2: no automatic renewal.
ClusterName String Dedicated cluster name.
StartTime String Instance creation time
EndTime String Instance expiration time.
Status Integer Cluster status. 1: in process; 2: running; 3: isolated.
BaseBundles Array of ResourceBundle Basic control resource package.
ResourceBundles Array of ResourceBundle Resource package list.
DedicatedClusterId String Local dedicated cluster ID.

CommandTake

Command duration

Used by actions: DescribeInstanceMonitorTopNCmdTook.

Name Type Description
Cmd String Command name.
Took Integer Time consumed. Unit: ms.

DelayDistribution

Delay distribution details

Used by actions: DescribeInstanceMonitorBigKeySizeDist, DescribeInstanceMonitorTookDist.

Name Type Description
Ladder Integer The delay distribution. The mapping between delay range and Ladder value is as follows: - 1: [0ms,1ms]. - 5: [1ms,5ms]. - 10: [5ms,10ms]. - 50: [10ms,50ms]. - 200: [50ms,200ms]. - -1: [200ms,∞].
Size Integer The number of commands with delay falling within the current delay range -
Updatetime Integer Modification time

DescribeInstanceDTSInstanceInfo

Details of instances in the DTS task

Used by actions: DescribeInstanceDTSInfo.

Name Type Description
RegionId Integer Region ID.
Note: This field may return null, indicating that no valid value can be obtained.
InstanceId String Instance ID.
Note: This field may return null, indicating that no valid value can be obtained.
SetId Integer Warehouse ID.
Note: This field may return null, indicating that no valid value can be obtained.
ZoneId Integer AZ ID.
Note: This field may return null, indicating that no valid value can be obtained.
Type Integer Instance type.
Note: This field may return null, indicating that no valid value can be obtained.
InstanceName String Instance name.
Note: This field may return null, indicating that no valid value can be obtained.
Vip String Instance access address.
Note: This field may return null, indicating that no valid value can be obtained.
Status Integer Status.
Note: This field may return null, indicating that no valid value can be obtained.

Groups

Replication group info

Used by actions: DescribeReplicationGroup.

Name Type Description
AppId Integer User APPID, which is the unique application ID that matches an account. Some Tencent Cloud products use this APPID.
RegionId Integer Region ID.
- 1: Guangzhou.
- 4: Shanghai.
- 5: Hong Kong (China).
- 7: Shanghai Finance.
- 8: Beijing.
- 9: Singapore.
- 11: Shenzhen Finance.
- 15: Western United States (Silicon Valley).
- 16: Chengdu.
- 17: Germany.
- 18: South Korea.
- 19: Chongqing.
- 21: India.
- 22: Eastern United States (Virginia).
- 23: Thailand.
- 25: Japan.
GroupId String Replication group ID in the format of "crs-rpl-deind****"
GroupName String Replication group name
Note: This field may return null, indicating that no valid values can be obtained.
Status Integer Status of replication group
- 37: Associating replication group
- 38: Reconnecting to replication group
- 51: Disassociating replication group
- 52: Switching with master instance in replication group
- 53: Modifying the roles
InstanceCount Integer Number of replication groups
Instances Array of Instances Instance information in replication groups
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 The name of the hot key.
Type String Key type.
Count Integer Number of accesses for the hot key in a specified time period.

Inbound

Security group inbound rule

Used by actions: DescribeDBSecurityGroups, DescribeProjectSecurityGroups.

Name Type Description
Action String Policy. Valid values: ACCEPT, DROP.
AddressModule String All the addresses that the address group ID represents.
CidrIp String Source IP or IP address range, such as 192.168.0.0/16.
Desc String Description.
IpProtocol String Network protocol, such as UDP and TCP.
PortRange String Port.
ServiceModule String All the protocols and ports that the service group ID represents.
Id String All the addresses that the security group ID represents.

InstanceClusterNode

Instance node type

Used by actions: DescribeInstances.

Name Type Description
Name String Node group name.
RunId String ID of the runtime node of an instance
Role Integer Cluster role. Valid values: - 0 (master) - 1 (replica)
Status Integer Node status. Valid values: - 0 (read/write) - 1 (read) - 2 (backup)
Connected Integer Service status. Valid values: 0 (down), 1 (on).
CreateTime String Node creation time
DownTime String Node elimination time
Slots String Node slot distribution range
Keys Integer Distribution of node keys
Qps Integer Node QPS Number of executions per second on sharded nodes Unit: Counts/sec
QpsSlope Float QPS slope of a node
Storage Integer Node storage
StorageSlope Float Node storage slope

InstanceClusterShard

Information list of instance shards

Used by actions: DescribeInstanceShards.

Name Type Description
ShardName String The name of a shard node
ShardId String The serial number of a shard node
Role Integer The role of a shard node
- 0: Master node.
- 1: Replica node.
Keys Integer Number of keys
Slots String Slot information
Storage Integer Used Capacity
StorageSlope Float Capacity slope
Runid String This field is recommended to use the RunId instead due to spelling inconsistency.
Meaning: The node ID during instance runtime.
RunId String The node ID during instance runtime.
Connected Integer Service status
- 0: Down.
- 1: On.

InstanceEnumParam

Description of the instance parameter in Enum type

Used by actions: DescribeInstanceParams.

Name Type Description
ParamName String Parameter name
ValueType String Parameter type, such as Enum.
NeedRestart String Whether to restart the database after modifying the parameters. Valid values: - true (required) - false (not required)
DefaultValue String Default value of the parameter
CurrentValue String Current value
Tips String Description
EnumValue Array of String Acceptable values for the parameter
Status Integer Parameter modification status. Valid values: - 1 (modifying) - 2 (modified)

InstanceIntegerParam

Description of the instance parameter in Integer type

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. Valid values: true, false
DefaultValue String Default value of the parameter
CurrentValue String Current value
Tips String Parameter description
Min String Minimum value of the parameter
Max String Maximum value of the parameter
Status Integer Parameter status. 1: modifying; 2: modified
Unit String Parameter unit
Note: This field may return null, indicating that no valid values can be obtained.

InstanceMultiParam

Description of the instance parameter in Multi type

Used by actions: DescribeInstanceParams.

Name Type Description
ParamName String Parameter name
ValueType String Parameter Type such as MULTI
NeedRestart String Whether to restart the database after modifying the parameter. Valid values: - true (required) - false (not required)
DefaultValue String Default value of the parameter
CurrentValue String Current value
Tips String Description
EnumValue Array of String Parameter enumeration value.
Status Integer Parameter modification status. Valid values: - 1 (modifying) - 2 (modified)

InstanceNode

Instance node

Used by actions: DescribeInstances.

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

InstanceParam

Instance parameter

Used by actions: CreateParamTemplate, ModifyInstanceParams, ModifyParamTemplate.

Name Type Required Description
Key String Yes Parameter name, such as “timeout”. For supported custom parameters, see Setting Instance Parameters
Value String Yes Current parameter value. For example, if you set the current value of “timeout” to 120 (in seconds), the client connections that remain idle longer than 120 seconds will be closed. For more information on parameter values, see Setting Instance Parameters

InstanceParamHistory

History of instance parameter modifications

Used by actions: DescribeInstanceParamRecords.

Name Type Description
ParamName String Parameter name
PreValue String The value of the parameter before modification
NewValue String The value of the parameter after modification
Status Integer Parameter configuration status
- 1: The parameter configuration is being modified.
- 2: The parameter configuration has been modified successfully.
- 3: Failed to modify the parameter configuration.
ModifyTime String Modification time

InstanceProxySlowlogDetail

Proxy slow query details

Used by actions: DescribeProxySlowLog.

Name Type Description
Duration Integer Slow query duration in milliseconds
Client String Client address
Command String Slow query command
CommandLine String Detailed command line information of slow query
ExecuteTime String Execution time

InstanceSecurityGroupDetail

Security group information of the instance

Used by actions: DescribeInstanceSecurityGroup.

Name Type Description
InstanceId String Instance ID
SecurityGroupDetails Array of SecurityGroupDetail Security group information, which includes security group ID, name, outbound and inbound rules.

InstanceSet

List of instance details

Used by actions: DescribeInstances.

Name Type Description
InstanceName String Instance name.
InstanceId String Instance ID.
Appid Integer App ID of a user, which is an application ID that uniquely corresponds to the account ID. Some Tencent Cloud products use this app ID.
ProjectId Integer Project ID.
RegionId Integer Region ID.
  • 1: Guangzhou;
  • 4: Shanghai;
  • 5: Hong Kong (China);
  • 7: Shanghai Finance;
  • 8: Beijing;
  • 9: Singapore;
  • 11: Shenzhen Finance;
  • 15: Western United States (Silicon Valley);
  • 16: Chengdu;
  • 17: Frankfurt;
  • 18: Seoul;
  • 19: Chongqing;
  • 21: Mumbai;
  • 22: Eastern United States (Virginia);
  • 23: Bangkok;
  • 25: Tokyo.
ZoneId Integer Zone ID.
VpcId Integer VPC ID, for example, 75101.
SubnetId Integer ID of the subnet under VPC, for example, 46315.
Status Integer Current instance status.
  • 0: to be initialized;
  • 1: in process;
  • 2: running;
  • -2: isolated;
  • -3: to be deleted.
WanIp String Instance VIP.
Port Integer Instance port number.
Createtime String Instance creation time, for example, in the format of 2020-01-15 10:20:00.
Size Float Instance memory capacity. Unit: MB (1 MB = 1024 KB).
SizeUsed Float This parameter has been deprecated. Obtain the memory capacity used by the instance through the TCOP API GetMonitorData.
Type Integer Instance type.
- 2: Redis 2.8 Memory Edition (standard architecture).
- 3: CKV 3.2 Memory Edition (standard architecture).
- 4: CKV 3.2 Memory Edition (cluster architecture).
- 5: Redis 2.8 Memory Edition (stand-alone).
- 6: Redis 4.0 Memory Edition (standard architecture).
- 7: Redis 4.0 Memory Edition (cluster architecture).
- 8: Redis 5.0 Memory Edition (standard architecture).
- 9: Redis 5.0 Memory Edition (cluster architecture).
- 15: Redis 6.2 Memory Edition (standard architecture).
- 16: Redis 6.2 Memory Edition (cluster architecture).
- 17: Redis 7.0 Memory Edition (standard architecture).
- 18: Redis 7.0 Memory Edition (cluster architecture).
AutoRenewFlag Integer Whether the automatic renewal flag is set for an instance.
  • 1: set;
  • 0: not set.
DeadlineTime String Expiration time of a monthly subscription instance.
Engine String Engine. Valid values: Redis Community Edition and Tencent Cloud CKV.
ProductType String Product type.
  • standalone: Standard Edition;
  • cluster: Cluster Edition.
UniqVpcId String VPC ID, for example, vpc-fk33jsf43kgv.
UniqSubnetId String ID of the subnet under VPC, for example, subnet-fd3j6l35mm0.
BillingMode Integer Billing mode. Only pay-as-you-go billing is supported.
InstanceTitle String Description of the instance running status, for example, running.
OfflineTime String Default termination time of isolated instances, for example, in the format of 2020-02-15 10:20:00. By default, a pay-as-you-go instance will be terminated after 2 hours of isolation, and a monthly subscription instance will be terminated after 7 days.
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 Time when an instance starts to be isolated.
SlaveReadWeight Integer Read weight of a secondary node.
InstanceTags Array of InstanceTagInfo Tag information associated with an instance.
Note: This field may return null, indicating that no valid value can be obtained.
ProjectName String Project name

Note: This field may return null, indicating that no valid value can be obtained.
NoAuth Boolean Whether an instance is a password-free instance.
  • true: yes;
  • false: no.

Note: This field may return null, indicating that no valid value can be obtained.
ClientLimit Integer Number of client connections.
Note: This field may return null, indicating that no valid value can be obtained.
DtsStatus Integer DTS status (internal parameter, which can be ignored).
Note: This field may return null, indicating that no valid value can be obtained.
NetLimit Integer Upper limit of the shard bandwidth. Unit: MB.
Note: This field may return null, indicating that no valid value can be obtained.
PasswordFree Integer Password-free instance flag (internal parameter, which can be ignored).
Note: This field may return null, indicating that no valid value can be obtained.
Vip6 String Internal parameter, which can be ignored. This parameter is not properly named. It is recommended to use the IPv6 parameter to replace it.
Note: This field may return null, indicating that no valid value can be obtained.
IPv6 String Internal parameter, which can be ignored.
Note: This field may return null, indicating that no valid value can be obtained.
ReadOnly Integer Instance read-only flag (internal parameter, which can be ignored).
Note: This field may return null, indicating that no valid value can be obtained.
RemainBandwidthDuration String Internal parameter, which can be ignored.
Note: This field may return null, indicating that no valid value can be obtained.
DiskSize Integer For Redis instances, ignore this parameter.
Note: This field may return null, indicating that no valid value can be obtained.
MonitorVersion String Monitoring version.
Note: This field may return null, indicating that no valid value can be obtained.
ClientLimitMin Integer Minimum value that can be set for the maximum number of client connections.
Note: This field may return null, indicating that no valid value can be obtained.
ClientLimitMax Integer Maximum value that can be set for the maximum number of client connections.
Note: This field may return null, indicating that no valid value can be obtained.
NodeSet Array of RedisNodeInfo Detailed node information of an instance.
Note: This field may return null, indicating that no valid value can be obtained.
Region String Region information of an instance, for example, ap-guangzhou.
Note: This field may return null, indicating that no valid value can be obtained.
WanAddress String Public network address.
Note: This field may return null, indicating that no valid value can be obtained.
PolarisServer String Polaris service address, which is for internal use.
Note: This field may return null, indicating that no valid value can be obtained.
RedisClusterId String CDC Redis cluster ID.
Note: This field may return null, indicating that no valid value can be obtained.
DedicatedClusterId String CDC cluster ID.
Note: This field may return null, indicating that no valid value can be obtained.
ProductVersion String Product edition.
  • local: local disk;
  • cloud: cloud disk;
  • cdc: CDC cluster.

Note: This field may return null, indicating that no valid value can be obtained.
CurrentProxyVersion String Current Proxy version of an instance.
Note: This field may return null, indicating that no valid value can be obtained.
CurrentRedisVersion String Current Cache minor version of an instance. If the instance joins a global replication group, the kernel version of the global replication group will be displayed.
Note: This field may return null, indicating that no valid value can be obtained.
UpgradeProxyVersion String Upgradable Proxy version of an instance.
Note: This field may return null, indicating that no valid value can be obtained.
UpgradeRedisVersion String Upgradable Cache minor version of an instance.
Note: This field may return null, indicating that no valid value can be obtained.
BackupMode String Backup mode. SecondLevelBackup: second-level backup; NormalLevelBackup: normal backup.
Note: This field may return null, indicating that no valid value 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
Node String Node ID

InstanceTagInfo

Instance tag information

Used by actions: DescribeInstances.

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

InstanceTextParam

Description of instance parameter in Char type

Used by actions: DescribeInstanceParams.

Name Type Description
ParamName String Parameter name
ValueType String Parameter type such as Text.
NeedRestart String Whether to restart the database after modifying the parameter. Valid values: - true (required) - false (not required)
DefaultValue String Default value of the parameter
CurrentValue String Current value
Tips String Description
TextValue Array of String Acceptable values of the parameter
Status Integer Parameter modification status. Valid values: - 1 (modifying) - 2 (modified)

Instances

Instances in replication group

Used by actions: DescribeReplicationGroup.

Name Type Description
AppId Integer User APPID, which is the unique application ID that matches an account. Some Tencent Cloud products use this APPID.
InstanceId String Instance ID
InstanceName String Instance name
RegionId Integer Region ID.
  • 1: Guangzhou;
  • 4: Shanghai;
  • 5: Hong Kong (China);
  • 7: Shanghai Finance;
  • 8: Beijing;
  • 9: Singapore;
  • 11: Shenzhen Finance;
  • 15: Western United States (Silicon Valley).
ZoneId Integer Region ID
RedisReplicasNum Integer Number of replicas
RedisShardNum Integer Number of shards
RedisShardSize Integer Shard memory 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 Read-write permission of the instance.
  • rw: Read/Write.
  • r: Read-only.
Vip String Instance VIP
Vip6 String Due to the naming irregularity of this parameter, it is recommended to use the parameter IPv6 instead. Internal parameters, which can be ignored by users.
Note: This field may return null, indicating that no valid values can be obtained.
IPv6 String Internal parameters, which can be ignored by users.
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: Uninitialized.
  • 1: In the process.
  • 2: Running.
  • -2: Isolated.
  • -3: To be deleted.
GrocerySysId Integer Repository ID
ProductType Integer Instance type
- 2: Redis 2.8 Memory Edition (Standard Architecture).
- 3: CKV 3.2 Memory Edition (Standard Architecture).
- 4: CKV 3.2 Memory Edition (Cluster Architecture)
- 5: Redis 2.8 Memory Edition (Standalone)
- 6: Redis 4.0 Memory Edition (Standard Architecture).
- 7: Redis 4.0 Memory Edition (Cluster Architecture)
- 8: Redis 5.0 Memory Edition (Standard Architecture).
- 9: Redis 5.0 Memory Edition (Cluster Architecture)
- 15: Redis 6.2 Memory Edition (Standard Architecture).
- 16: Redis 6.2 Memory Edition (Cluster Architecture)
CreateTime String The time when the instance was added to the replication group.
UpdateTime String The time when instances in the replication group were updated.

LogDeliveryInfo

Log shipping information.

Used by actions: DescribeInstanceLogDelivery.

Name Type Required Description
Enabled Boolean No Whether log shipping is enabled. true: enabled; false: disabled.
Note: This field may return null, indicating that no valid value can be obtained.
LogsetId String No Logset ID.
Note: This field may return null, indicating that no valid value can be obtained.
TopicId String No Log topic ID.
Note: This field may return null, indicating that no valid value can be obtained.
LogRegion String No Logset region

Note: This field may return null, indicating that no valid value can be obtained.

Outbound

Security group outbound rule

Used by actions: DescribeDBSecurityGroups, DescribeProjectSecurityGroups.

Name Type Description
Action String Policy. Valid values: ACCEPT, DROP.
AddressModule String All the addresses that the address group ID represents.
CidrIp String Source IP or IP address range, such as 192.168.0.0/16.
Desc String Description.
IpProtocol String Network protocol, such as UDP and TCP.
PortRange String Port.
ServiceModule String All the protocols and ports that the service group ID represents.
Id String All the addresses that the security group ID represents.

ParamTemplateInfo

Parameter template information

Used by actions: DescribeParamTemplates.

Name Type Description
TemplateId String Parameter template ID
Name String Parameter template name
Description String Parameter template description
ProductType Integer Instance type
- 2: Redis 2.8 Memory Edition (Standard Architecture).
- 3: CKV 3.2 Memory Edition (Standard Architecture).
- 4: CKV 3.2 Memory Edition (Cluster Architecture).
- 5: Redis 2.8 Memory Edition (Standalone).
- 6: Redis 4.0 Memory Edition (Standard Architecture).
- 7: Redis 4.0 Memory Edition (Cluster Architecture).
- 8: Redis 5.0 Memory Edition (Standard Architecture).
- 9: Redis 5.0 Memory Edition (Cluster Architecture).
- 15: Redis 6.2 Memory Edition (Standard Architecture).
- 16: Redis 6.2 Memory Edition (Cluster Architecture).

ParameterDetail

Details of the parameters in the parameter template

Used by actions: DescribeParamTemplateInfo.

Name Type Description
Name String Parameter name
ParamType String Parameter Type
Default String Default value of the parameter
Description String Parameter description
CurrentValue String Current value of the parameter
NeedReboot Integer Whether to restart the database for the modified parameters to take effect
- 0: No restart.
- 1: Restart required.
Max String Maximum value of the parameter
Note: This field may return null, indicating that no valid values can be obtained.
Min String Minimum value of the parameter
Note: This field may return null, indicating that no valid values can be obtained.
EnumValue Array of String Enumerated values of the parameter. It is null if the parameter is non-enumerated
Note: This field may return null, indicating that no valid values can be obtained.

ProductConf

Product information

Used by actions: DescribeProductInfo.

Name Type Description
Type Integer Product type
- 2: Redis 2.8 Memory Edition (Standard Architecture).
- 3: CKV 3.2 Memory Edition (Standard Architecture).
- 4: CKV 3.2 Memory Edition (Cluster Architecture).
- 5: Redis 2.8 Memory Edition (Standalone).
- 6: Redis 4.0 Memory Edition (Standard Architecture).
- 7: Redis 4.0 Memory Edition (Cluster Architecture).
- 8: Redis 5.0 Memory Edition (Standard Architecture).
- 9: Redis 5.0 Memory Edition (Cluster Architecture).
- 15: Redis 6.2 Memory Edition (Standard Architecture).
- 16: Redis 6.2 Memory Edition (Cluster Architecture).
TypeName String Product names, including Redis Master-Replica Edition, Redis Standalone Edition, Redis 4.0 Cluster Edition, CKV Master-Replica Edition, and CKV Standalone Edition.
MinBuyNum Integer Minimum purchasable quantity
MaxBuyNum Integer Maximum purchasable quantity
Saleout Boolean Whether a product is sold out
- true: Sold out.
- false: Not sold out.
Engine String Product engine. Valid values: Redis and CKV.
Version String Compatible versions, including Redis 2.8, 3.2, 4.0, 5.0, and 6.2.
TotalSize Array of String Total capacity in GB
ShardSize Array of String Shard size in GB
ReplicaNum Array of String Quantity of replicas
ShardNum Array of String Quantity of shards
PayMode String Supported billing modes
- 1: Monthly subscription.
- 0: Pay-as-you-go.
EnableRepicaReadOnly Boolean Due to spelling inconsistency in this parameter name, it is recommended to use the EnableReplicaReadOnly parameter instead. Its meaning refers to whether the Read-Only Replica is supported.
- true: Supported.
- false: Not supported.
EnableReplicaReadOnly Boolean Whether the Read-Only Replica is supported.
- true: Supported.
- false: Not supported.
Note: This field may return null, indicating that no valid value can be obtained.

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.
ZoneId Integer AZ ID
Note: This field may return null, indicating that no valid values can be obtained.

RedisBackupSet

Array of instance backups

Used by actions: DescribeInstanceBackups.

Name Type Description
StartTime String Backup start time
BackupId String Backup task ID
BackupType String Backup type. Valid values: 1 (Automatic backup in the early morning initiated by the system.) 0: Manual backup initiated by the user.
Status Integer Backup status. Valid values: - 1: The backup is locked by another process. - 2: The backup is normal and not locked by any process. - -1: The backup is expired. - 3: The backup is being exported. - 4: Exported the backup successfully.
Remark String Backup remarks
Locked Integer Whether the backup is locked. Valid values: - 0 (no) - 1 (yes)
BackupSize Integer Internal field, which can be ignored.
Note: This field may return null, indicating that no valid values can be obtained.
FullBackup Integer Internal field, which can be ignored.
Note: This field may return null, indicating that no valid values can be obtained.
InstanceType Integer Internal field, which can be ignored.
Note: This field may return null, indicating that no valid values can be obtained.
InstanceId String Instance ID
InstanceName String Instance name
Region String The region where the local backup resides.
EndTime String Backup end time
FileType String Backup file type
ExpireTime String Backup file expiration time

RedisCommonInstanceList

Instance information

Used by actions: DescribeCommonDBInstances.

Name Type Description
InstanceName String Instance name
InstanceId String Instance ID
AppId Integer User APPID, which is the unique application ID that matches an account. Some Tencent Cloud products use this APPID.
ProjectId Integer Project ID of the instance
Region String Instance region
Zone String Instance AZ
VpcId String Instance VPC ID
SubnetId String VPC subnet ID
Status String Instance status information
- 1: Task running.
- 2: Instance running.
- -2: Instance isolated.
- -3: Instance being eliminated.
- -4: Instance eliminated.
Vips Array of String Private network IP address of an instance
Vport Integer Instance network port
Createtime String Instance creation time
PayMode Integer Billing type
- 0: Pay-as-you-go.
- 1: Monthly subscription.
NetType Integer Network Type
- 0: Classic network.
- 1: VPC.

RedisInstanceEvent

Instance event information.

Used by actions: DescribeInstanceEvents.

Name Type Description
ID Integer Event ID.
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.
InstanceName String Instance name.Note: This field may return null, indicating that no valid values can be obtained.
Type String Event type. Currently, the type can only be related to instance migration, resource movement, and IDC deletion. This parameter can be only set to InstanceMigration.Note: This field may return null, indicating that no valid values can be obtained.
Grade String Event levels are divided into Critical, High, Medium, and Low events according to the severity and urgency.- Critical
- High
- Middle
- Low
Note: This field may return null, indicating that no valid values can be obtained.
ExecutionDate String Scheduled event execution date.Note: This field may return null, indicating that no valid values can be obtained.
StartTime String Scheduled start time of event execution.Note: This field may return null, indicating that no valid values can be obtained.
EndTime String Scheduled end time of event execution.Note: This field may return null, indicating that no valid values can be obtained.
LatestExecutionDate String The latest execution date of the operations event. Event execution must be completed before this date. Otherwise, the business may be affected.Note: This field may return null, indicating that no valid values can be obtained.
Status String Current event status.- Waiting: The event is waiting for execution on the execution date or during the operations period.- Running: The event is being executed during the operations period.- Finished: Execution of the event operations is completed.- Canceled: Execution of the event is canceled.Note: This field may return null, indicating that no valid values can be obtained.
TaskEndTime String Completion time of the event execution task.
Note: This field may return null, indicating that no valid values can be obtained.
EffectInfo String Impact of the event.Note: This field may return null, indicating that no valid values can be obtained.
InitialExecutionDate String Initial scheduled execution date of the event.Note: This field may return null, indicating that no valid values can be obtained.

RedisNode

Running information of Redis nodes

Used by actions: DescribeInstanceZoneInfo.

Name Type Description
Keys Integer Number of keys on Redis nodes
Slot String Slot distribution range for Redis node. Value range: 0-5460.
NodeId String Node sequence ID
Status String Node status
Role String Node role

RedisNodeInfo

Master or replica node information of the TencentDB for Redis instance.

Used by actions: CloneInstances, CreateInstances, DescribeInstances, ModifyInstanceAvailabilityZones, UpgradeInstance.

Name Type Required Description
NodeType Integer Yes Node type.
  • 0: Master node.
  • 1: Replica node.
NodeId Integer No ID of the master or replica node
  • This parameter is optional when the CreateInstances API is used to create a TencentDB for Redis instance, but it is required when the UpgradeInstance API is used to adjust the configuration of an instance by deleting a replica.
  • You can use the DescribeInstances API to get the node ID of integer type.
ZoneId Integer No ID of the AZ of the master or replica node
ZoneName String No Name of the AZ of the master or replica node

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

ReplicaGroup

Information of the instance node group

Used by actions: DescribeInstanceZoneInfo.

Name Type Description
GroupId Integer Node group ID
GroupName String Node group name, which is empty for the master node
ZoneId String Node AZ ID, such as ap-guangzhou-1
Role String Node group type. master: primary node; replica: replica node.
RedisNodes Array of RedisNode List of nodes in the node group

ResourceBundle

Dedicated Redis cluster resource package.

Used by actions: DescribeRedisClusters.

Name Type Required Description
ResourceBundleName String Yes Resource package name.
AvailableMemory Integer Yes Saleable memory. Unit: GB.
Count Integer Yes Number of resource packages.

ResourceTag

Tag bound to the instance purchased via API

Used by actions: CloneInstances, CreateInstances.

Name Type Required Description
TagKey String Yes Tag key
TagValue String Yes The value corresponding to the tag key

SecurityGroup

Security group rules

Used by actions: DescribeDBSecurityGroups, DescribeProjectSecurityGroups.

Name Type Description
CreateTime String Creation time in the format of yyyy-mm-dd hh:mm:ss.
ProjectId Integer Project ID.
SecurityGroupId String Security group ID.
SecurityGroupName String Security group name.
SecurityGroupRemark String Security group remarks.
Outbound Array of Outbound Outbound rule.
Inbound Array of Inbound Inbound rule.

SecurityGroupDetail

Security group details

Used by actions: DescribeInstanceSecurityGroup, DescribeProjectSecurityGroup.

Name Type Description
ProjectId Integer Project ID
CreateTime String Security group creation time
SecurityGroupId String Security group ID
SecurityGroupName String Security group name
SecurityGroupRemark String Security group remarks
InboundRule Array of SecurityGroupsInboundAndOutbound Inbound rules of the security group, which control the access source to the database.
OutboundRule Array of SecurityGroupsInboundAndOutbound Security group outbound rule

SecurityGroupsInboundAndOutbound

Security group inbound/outbound rules

Used by actions: DescribeInstanceSecurityGroup, DescribeProjectSecurityGroup.

Name Type Description
Action String Whether the inbound and outbound IP addresses and ports of the database are allowed.
- ACCEPT: allowed.
- DROP: disallowed.
Ip String IP address for accessing the database
Port String Port number
Proto String Protocol type

SourceCommand

Access command

Used by actions: DescribeInstanceMonitorTopNCmd.

Name Type Description
Cmd String Command name.
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 Task start time
Note: This field may return null, indicating that no valid values can be obtained.
TaskType String Task type.

- FLOW_CREATE: "001" - Create an instance.
- FLOW_RESIZE: "002" - Change the configuration.
- FLOW_CLOSE: "003" - Close an instance.
- FLOW_CLEAN: "004" - Clear an instance.
- FLOW_STARTUP: "005" - Enable an instance.
- FLOW_DELETE: "006" - Delete an instance.
- FLOW_SETPWD: "007" - Reset the password.
- FLOW_EXPORTBACKUP: "009" - Export the backup file.
- FLOW_RESTOREBACKUP: "010" - Restore the backup.
- FLOW_BACKUPINSTANCE: "012" - Back up an instance.
- FLOW_MIGRATEINSTANCE: "013" - Migrate an instance.
- FLOW_DELBACKUP: "014" - Delete the backup.
- FLOW_EXCHANGEINSTANCE: "016" - Switch an instance.
- FLOW_AUTOBACKUP: "017" - Automatically backup an instance.
- FLOW_MIGRATECHECK: "022" - Verify migration parameters.
- FLOW_MIGRATETASK: "023" - Migrating data is in progress.
- FLOW_CLEANDB: "025" - Clear a database.
- FLOW_CLONEBACKUP: "026" - Clone the backup.
- FLOW_CHANGEVIP: "027" - Change the VIP.
- FLOW_EXPORSHR: "028" - Perform scaling.
- FLOW_ADDNODES: "029" - Add or remove a node.
- FLOW_CHANGENET: "031" - Change the network type.
- FLOW_MODIFYINSTACEREADONLY: "033" - Modify the read-only policy.
- FLOW_MODIFYINSTANCEPARAMS: "034" - Modify instance parameters.
- FLOW_MODIFYINSTANCEPASSWORDFREE: "035" - Set password-free access.
- FLOW_SWITCHINSTANCEVIP: "036" - Switch the instance VIP.
- FLOW_MODIFYINSTANCEACCOUNT: "037" - Modify the instance account.
- FLOW_MODIFYINSTANCEBANDWIDTH: "038" - Modify the instance bandwidth.
- FLOW_ENABLEINSTANCE_REPLICATE: "039" - Enable read-only replica.
- FLOW_DISABLEINSTANCE_REPLICATE: "040" - Disable read-only replica.
- FLOW_UpgradeArch: "041" - Upgrade the instance architecture from primary-secondary to cluster.
- FLOW_DowngradeArch: "042" - Downgrade the instance architecture from cluster to primary-secondary.
- FLOW_UpgradeVersion: "043" - Upgrade the version.
- FLOW_MODIFYCONNECTIONCONFIG: "044" - Modify the number of bandwidth connections.
- FLOW_CLEARNETWORK: "045" - Change the network.
- FLOW_REMOVE_BACKUP_FILE: "046" - Delete the backup.
- FLOW_UPGRADE_SUPPORT_MULTI_AZ: "047" - Upgrade an instance to support multiple AZs.
- FLOW_SHUTDOWN_MASTER: "048" - Simulate a fault.
- FLOW_CHANGE_REPLICA_TO_MASTER: "049" - Manually promote the replica node to the primary node.
- FLOW_CODE_ADD_REPLICATION_INSTANCE: "050" - Add a replication group.
- FLOW_OPEN_WAN: "052" - Enable the public network.
- FLOW_CLOSE_WAN: "053" - Disable the public network. - FLOW_UPDATE_WAN: "054" - Update the public network.
- FLOW_CODE_DELETE_REPLICATION_INSTANCE: "055" - Unbind the replication group.
- FLOW_CODE_CHANGE_MASTER_INSTANCE: "056" - Switch to the primary instance in the replication group.
- FLOW_CODE_CHANGE_INSTANCE_ROLE: "057" - Change the roles of instances in the replication group.
- FLOW_MIGRATE_NODE: "058" - Migrate a node.
- FLOW_SWITCH_NODE: "059" - Switch a node.
- FLOW_UPGRADE_SMALL_VERSION: "060" - Upgrade the Redis version.
- FLOW_UPGRADE_PROXY_VERSION: "061" - Upgrade the Proxy version.
- FLOW_MODIFY_INSTANCE_NETWORK: "062" - Modify the instance network.
- FLOW_MIGRATE_PROXY_NODE: "063" - Migrate the Proxy node.
- FLOW_MIGRATION_INSTANCE_ZONE: "066" - Migrate the instance AZ in progress.
- FLOW_UPGRADE_INSTANCE_CACHE_AND_PROXY: "067" - Upgrading the instance version is in progress.
- FLOW_MODIFY_PROXY_NUM: "069" - Add or remove a Proxy node.
- FLOW_MODIFYBACKUPMOD: "070" - Change the instance backup mode.
Note: This field may return null, indicating that no valid value 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 Task end time
Note: This field may return null, indicating that no valid values can be obtained.
Result Integer Task execution status. Valid values: - 0 (initilized) - 1 (executing) - 2 (completed) - 4 (failed)
Note: This field may return null, indicating that no valid values can be obtained.

TendisNodes

Tendis node information

Used by actions: DescribeInstanceNodeInfo.

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

TendisSlowLogDetail

Tendis slow query details

Used by actions: DescribeTendisSlowLog.

Name Type Description
ExecuteTime String Execution time
Duration Integer Duration of the slow query (ms)
Command String Command
CommandLine String Command line details
Node String Node ID

TradeDealDetail

Order transaction 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 the order
Creater String Creator 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 the 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 Availability zone name.
IsSaleout Boolean Whether the AZ is sold out.
IsDefault Boolean Whether the default AZ is used.
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