TencentDB for Redis

TencentDB for Redis
API Documentation
Product Documentation©2013-2022 Tencent Cloud. All rights reserved.

Page 1 of 500

TencentDB for Redis

Copyright Notice©2013-2024 Tencent Cloud. All rights reserved.
Copyright in this document is exclusively owned by Tencent Cloud. You must not reproduce, modify, copy or distributein any way, in whole or in part, the contents of this document without Tencent Cloud's the prior written consent.
Trademark Notice

All trademarks associated with Tencent Cloud and its services are owned by Tencent Cloud Computing (Beijing)
Company Limited and its affiliated companies. Trademarks of third parties referred to in this document are owned bytheir respective proprietors.
Service Statement
This document is intended to provide users with general information about Tencent Cloud's products and services
only and does not form part of Tencent Cloud's terms and conditions. Tencent Cloud's products or services are
subject to change. Specific products and services and the standards applicable to them are exclusively provided for in
Tencent Cloud's applicable terms and conditions.

©2013-2022 Tencent Cloud. All rights reserved.

Page 2 of 500

TencentDB for Redis

Contents
API Documentation
History
Introduction
API Category
Making API Requests
Request Structure
Common Params
Signature v3
Signature
Responses
Instance APIs
AddReplicationInstance
AllocateWanAddress
ChangeInstanceRole
ChangeMasterInstance
CleanUpInstance
ClearInstance
CloseSSL
CreateInstanceAccountCreateReplicationGroup
DeleteInstanceAccountDeleteReplicationInstanceDescribeAutoBackupConfig
DescribeBandwidthRange
DescribeInstanceAccountDescribeInstanceDTSInfo
DescribeInstanceZoneInfo
DescribeInstances
DescribeProxySlowLog
DescribeSlowLog
DescribeTendisSlowLog
DestroyPostpaidInstance
DestroyPrepaidInstance
DisableReplicaReadonly
EnableReplicaReadonly©2013-2022 Tencent Cloud. All rights reserved.

Page 3 of 500

TencentDB for Redis

InquiryPriceCreateInstance
InquiryPriceUpgradeInstance
KillMasterGroup
ModifyAutoBackupConfig
ModifyInstance
ModifyInstanceAccount
ModifyInstanceReadOnly
ModifyMaintenanceWindow
ModifyNetworkConfig
OpenSSL
ReleaseWanAddress
RenewInstanceResetPassword
StartupInstance
SwitchProxy
UpgradeInstanceVersion
UpgradeProxyVersion
UpgradeSmallVersion
UpgradeVersionToMultiAvailabilityZones
DescribeCommonDBInstances
ChangeReplicaToMaster
CloneInstances
CreateInstances
DescribeInstanceDealDetail
DescribeInstanceNodeInfo
DescribeInstanceShards
DescribeMaintenanceWindow
DescribeParamTemplateInfo
DescribeReplicationGroup
DescribeSSLStatus
DescribeTaskInfo
DescribeTaskList
ModfiyInstancePassword
RemoveReplicationInstance
UpgradeInstanceDescribeInstanceEvents
ModifyInstanceAvailabilityZones
ModifyInstanceEvent©2013-2022 Tencent Cloud. All rights reserved.

Page 4 of 500

TencentDB for Redis

SwitchAccessNewInstanceDescribeInstanceSupportFeature
Parameter Management APIs
ApplyParamsTemplate
CreateParamTemplate
DeleteParamTemplate
DescribeInstanceParamRecords
DescribeInstanceParams
DescribeInstanceSecurityGroup
DescribeParamTemplates
DescribeProjectSecurityGroup
ModifyConnectionConfig
ModifyInstanceParams
ModifyParamTemplate
Other APIs
AssociateSecurityGroups
DescribeDBSecurityGroups
DescribeProjectSecurityGroups
DisassociateSecurityGroups
ModifyDBInstanceSecurityGroups
SwitchInstanceVip
Region APIs
DescribeProductInfo
Monitoring and Management APIs
DescribeInstanceMonitorBigKey
DescribeInstanceMonitorBigKeySizeDist
DescribeInstanceMonitorBigKeyTypeDist
DescribeInstanceMonitorHotKey
DescribeInstanceMonitorSIP
DescribeInstanceMonitorTookDist
DescribeInstanceMonitorTopNCmd
DescribeInstanceMonitorTopNCmdTook
Backup and Restoration APIs
DescribeBackupDownloadRestriction
DescribeBackupUrl
DescribeInstanceBackups
ManualBackupInstance
ModifyBackupDownloadRestriction©2013-2022 Tencent Cloud. All rights reserved.

Page 5 of 500

TencentDB for Redis

RestoreInstance
Data Types
Error Codes©2013-2022 Tencent Cloud. All rights reserved.

Page 6 of 500

TencentDB for Redis

API Documentation
History：

Last updated 2024-04-22 11:08:46

Release 41
Release time: 2024-04-22 11:08:41
Release updates:
Improvement to existing documentation.
Modified APIs:
CreateInstances
New input parameters:AlarmPolicyList

Release 40
Release time: 2024-04-15 11:08:35
Release updates:
Improvement to existing documentation.
New APIs:
AddReplicationInstance
CreateReplicationGroup
DeleteReplicationInstanceDescribeInstanceEvents
ModifyConnectionConfig
ModifyInstanceEvent
New data structures:
RedisInstanceEvent
Modified data structures:
Account©2013-2022 Tencent Cloud. All rights reserved.

Page 7 of 500

TencentDB for Redis

New members:CreateTime

Release 39
Release time: 2024-03-08 10:15:20
Release updates:
Improvement to existing documentation.
New APIs:
DescribeInstanceSupportFeature
ModifyInstanceAvailabilityZones
SwitchAccessNewInstance
Modified APIs:
DescribeSlowLog
New output parameters:InstanceSlowLogDetail
Modified data structures:InstanceClusterShard
New members:RunId
InstanceSet
New members:IPv6
Instances
New members:IPv6
ProductConf
New members:EnableReplicaReadOnly

Release 38
Release time: 2023-08-03 17:12:12
Release updates:
Improvement to existing documentation.
Modified APIs:©2013-2022 Tencent Cloud. All rights reserved.

Page 8 of 500

TencentDB for Redis

ChangeMasterInstanceNew input parameters:ForceSwitch

Release 37
Release time: 2023-07-18 10:54:55
Release updates:
Improvement to existing documentation.
Modified APIs:
KillMasterGroup
Modified input parameters: Password

Release 36
Release time: 2023-04-25 10:20:07
Release updates:
Improvement to existing documentation.
New APIs:
DescribeBandwidthRange
RemoveReplicationInstanceRelease 35
Release time: 2023-04-13 11:46:10
Release updates:
Improvement to existing documentation.
New APIs:
CloneInstances

Release 34©2013-2022 Tencent Cloud. All rights reserved.

Page 9 of 500

TencentDB for Redis

Release time: 2023-04-03 10:16:06
Release updates:
Improvement to existing documentation.
New APIs:
DescribeSSLStatus

Release 33
Release time: 2023-03-15 14:33:29
Release updates:
Improvement to existing documentation.
New APIs:
DescribeBackupDownloadRestriction
ModifyBackupDownloadRestriction

Release 32
Release time: 2023-03-07 11:17:25
Release updates:
Improvement to existing documentation.
Modified APIs:
DescribeBackupUrl
New input parameters:LimitType, VpcComparisonSymbol, IpComparisonSymbol, LimitVpc, LimitIp
DescribeInstanceBackups
New input parameters:InstanceName
Modified input parameters: InstanceId
ModifyNetworkConfig
New input parameters:VPort
New output parameters:TaskId
New data structures:©2013-2022 Tencent Cloud. All rights reserved.

Page 10 of 500

TencentDB for Redis

BackupLimitVpcItem
Modified data structures:
RedisBackupSet
New members:InstanceId, InstanceName, Region, EndTime, FileType, ExpireTime

Release 31
Release time: 2022-11-29 16:38:56
Release updates:
Improvement to existing documentation.
Modified APIs:
RenewInstanceNew input parameters:ModifyPayMode
Modified data structures:
ProxyNodes
New members:ZoneId

Release 30
Release time: 2022-11-01 10:31:23
Release updates:
Improvement to existing documentation.
New APIs:
CloseSSL
OpenSSL
Modified APIs:
DescribeInstances
New input parameters:AzMode©2013-2022 Tencent Cloud. All rights reserved.

Page 11 of 500

TencentDB for Redis

Modified data structures:InstanceSet
New members:WanAddress, PolarisServer, CurrentProxyVersion, CurrentRedisVersion, UpgradeProxyVersion,
UpgradeRedisVersion

Release 29
Release time: 2022-10-13 14:21:03
Release updates:
Improvement to existing documentation.
Modified APIs:
DescribeSlowLog
New input parameters:Role

Release 28
Release time: 2022-08-23 15:48:11
Release updates:
Improvement to existing documentation.
New APIs:
SwitchProxy

Release 27
Release time: 2022-08-11 10:58:47
Release updates:
Improvement to existing documentation.
New APIs:
ChangeInstanceRole
ChangeMasterInstance©2013-2022 Tencent Cloud. All rights reserved.

Page 12 of 500

TencentDB for Redis

Modified APIs:
DescribeInstances
New input parameters:InstanceIds

Release 26
Release time: 2022-07-28 14:54:16
Release updates:
Improvement to existing documentation.
Modified APIs:
CreateInstances
New input parameters:ProductVersion, RedisClusterId
InquiryPriceCreateInstanceNew input parameters:ProductVersion

Release 25
Release time: 2022-07-22 10:37:17
Release updates:
Improvement to existing documentation.
Modified APIs:
DescribeInstances
New input parameters:ProductVersions

Release 24
Release time: 2022-07-13 14:10:12
Release updates:
Improvement to existing documentation.
New APIs:©2013-2022 Tencent Cloud. All rights reserved.

Page 13 of 500

TencentDB for Redis

DescribeInstances
New data structures:InstanceClusterNode
InstanceNode
InstanceSet
InstanceTagInfo

Release 23
Release time: 2022-07-13 10:17:15
Release updates:
Improvement to existing documentation.
Deleted APIs:
DescribeInstances
Deleted data structures:InstanceClusterNode
InstanceNode
InstanceSet
InstanceTagInfo

Release 22
Release time: 2022-07-07 11:42:30
Release updates:
Improvement to existing documentation.
New APIs:
DescribeTaskList
KillMasterGroupNew data structures:©2013-2022 Tencent Cloud. All rights reserved.

Page 14 of 500

TencentDB for Redis

TaskInfoDetail

Release 21
Release time: 2022-07-06 11:37:53
Release updates:
Improvement to existing documentation.
Deleted APIs:
DescribeTaskList
KillMasterGroup
Modified APIs:
CreateInstances
New input parameters:DryRun
DescribeAutoBackupConfig
New output parameters:BackupStorageDays, BinlogStorageDays
DescribeDBSecurityGroups
New output parameters:VIP, VPort
DescribeInstances
New input parameters:InstanceTags, TagKeys
ManualBackupInstanceNew input parameters:StorageDays
ModifyAutoBackupConfig
New output parameters:BackupStorageDays
ModifyNetworkConfig
New input parameters:Recycle
UpgradeVersionToMultiAvailabilityZones
New input parameters:UpgradeProxyAndRedisServer
Deleted data structures:
TaskInfoDetail
Modified data structures:
RedisBackupSet©2013-2022 Tencent Cloud. All rights reserved.

Page 15 of 500

TencentDB for Redis

New members:BackupSize, FullBackup, InstanceType

Release 20
Release time: 2022-06-23 15:09:50
Release updates:
Improvement to existing documentation.
New APIs:
ApplyParamsTemplate
AssociateSecurityGroups
CleanUpInstance
ClearInstance
CreateInstanceAccountCreateInstances
CreateParamTemplate
DeleteInstanceAccountDeleteParamTemplate
DescribeAutoBackupConfig
DescribeBackupUrl
DescribeCommonDBInstances
DescribeDBSecurityGroups
DescribeInstanceBackups
DescribeInstanceDTSInfo
DescribeInstanceDealDetail
DescribeInstanceParamRecords
DescribeInstanceParams
DescribeInstanceSecurityGroup
DescribeInstanceShards
DescribeInstanceZoneInfo
DescribeInstances
DescribeParamTemplateInfo
DescribeParamTemplates
DescribeProjectSecurityGroup
DescribeProjectSecurityGroups
DescribeProxySlowLog©2013-2022 Tencent Cloud. All rights reserved.

Page 16 of 500

TencentDB for Redis

DescribeTaskInfo
DescribeTaskList
DescribeTendisSlowLog
DestroyPostpaidInstance
DestroyPrepaidInstance
DisableReplicaReadonly
DisassociateSecurityGroups
EnableReplicaReadonly
KillMasterGroup
ManualBackupInstance
ModifyAutoBackupConfig
ModifyDBInstanceSecurityGroups
ModifyInstance
ModifyInstanceAccount
ModifyInstanceParams
ModifyMaintenanceWindow
ModifyNetworkConfig
ModifyParamTemplate
RenewInstanceResetPassword
RestoreInstanceStartupInstance
SwitchInstanceVip
UpgradeInstance
UpgradeInstanceVersion
UpgradeVersionToMultiAvailabilityZones
New data structures:
BackupDownloadInfo
DescribeInstanceDTSInstanceInfo
InboundInstanceClusterNode
InstanceClusterShard
InstanceEnumParam
InstanceIntegerParam
InstanceMultiParam
InstanceNode©2013-2022 Tencent Cloud. All rights reserved.

Page 17 of 500

TencentDB for Redis

InstanceParam
InstanceParamHistory
InstanceProxySlowlogDetail
InstanceSecurityGroupDetail
InstanceSet
InstanceTagInfo
InstanceTextParam
OutboundParamTemplateInfo
ParameterDetail
RedisBackupSet
RedisCommonInstanceList
RedisNode
RedisNodeInfo
ReplicaGroupResourceTag
SecurityGroup
SecurityGroupDetailSecurityGroupsInboundAndOutbound
TaskInfoDetail
TendisSlowLogDetail
TradeDealDetail

Release 19
Release time: 2022-06-14 16:50:56
Release updates:
Improvement to existing documentation.
New APIs:
UpgradeProxyVersion
UpgradeSmallVersion

Release 18
Release time: 2022-05-25 16:19:17©2013-2022 Tencent Cloud. All rights reserved.

Page 18 of 500

TencentDB for Redis

Release updates:
Improvement to existing documentation.
New APIs:
ModifyInstanceReadOnly

Release 17
Release time: 2022-05-12 10:54:45
Release updates:
Improvement to existing documentation.
New APIs:
AllocateWanAddress
ChangeReplicaToMaster
DescribeInstanceNodeInfo
ReleaseWanAddress
New data structures:
ProxyNodes
RedisNodes
TendisNodes

Release 16
Release time: 2022-04-01 10:32:31
Release updates:
Improvement to existing documentation.
New APIs:
DescribeReplicationGroup
Deleted APIs:
ApplyParamsTemplate©2013-2022 Tencent Cloud. All rights reserved.

Page 19 of 500

TencentDB for Redis

AssociateSecurityGroups
ChangeReplicaToMaster
CleanUpInstance
ClearInstance
CreateInstanceAccountCreateInstances
CreateParamTemplate
DeleteInstanceAccountDeleteParamTemplate
DescribeAutoBackupConfig
DescribeBackupUrl
DescribeCommonDBInstances
DescribeDBSecurityGroups
DescribeInstanceBackups
DescribeInstanceDTSInfo
DescribeInstanceDealDetail
DescribeInstanceNodeInfo
DescribeInstanceParamRecords
DescribeInstanceParams
DescribeInstanceSecurityGroup
DescribeInstanceShards
DescribeInstanceZoneInfo
DescribeInstances
DescribeParamTemplateInfo
DescribeParamTemplates
DescribeProjectSecurityGroup
DescribeProjectSecurityGroups
DescribeProxySlowLog
DescribeTaskInfo
DescribeTaskList
DescribeTendisSlowLog
DestroyPostpaidInstance
DestroyPrepaidInstance
DisableReplicaReadonly
DisassociateSecurityGroups
EnableReplicaReadonly
KillMasterGroup
ManualBackupInstance©2013-2022 Tencent Cloud. All rights reserved.

Page 20 of 500

TencentDB for Redis

ModifyAutoBackupConfig
ModifyDBInstanceSecurityGroups
ModifyInstance
ModifyInstanceAccount
ModifyInstanceParams
ModifyMaintenanceWindow
ModifyNetworkConfig
ModifyParamTemplate
RenewInstanceResetPassword
RestoreInstanceStartupInstance
SwitchInstanceVip
UpgradeInstance
UpgradeInstanceVersion
UpgradeVersionToMultiAvailabilityZones
New data structures:GroupsInstances
Deleted data structures:
BackupDownloadInfo
DescribeInstanceDTSInstanceInfo
InboundInstanceClusterNode
InstanceClusterShard
InstanceEnumParam
InstanceIntegerParam
InstanceMultiParam
InstanceNode
InstanceParam
InstanceParamHistory
InstanceProxySlowlogDetail
InstanceSecurityGroupDetail
InstanceSet
InstanceTagInfo©2013-2022 Tencent Cloud. All rights reserved.

Page 21 of 500

TencentDB for Redis

InstanceTextParam
OutboundParamTemplateInfo
ParameterDetail
ProxyNodes
RedisBackupSet
RedisCommonInstanceList
RedisNode
RedisNodeInfo
RedisNodes
ReplicaGroupResourceTag
SecurityGroup
SecurityGroupDetailSecurityGroupsInboundAndOutbound
TaskInfoDetail
TendisNodes
TendisSlowLogDetail
TradeDealDetail

Release 15
Release time: 2022-01-23 11:17:48
Release updates:
Improvement to existing documentation.
Modified APIs:
KillMasterGroupNew input parameters:ShardIds

Release 14
Release time: 2021-11-18 10:40:01
Release updates:
Improvement to existing documentation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 22 of 500

TencentDB for Redis

Modified APIs:
DisableReplicaReadonly
New output parameters:TaskId
Deleted output parameters: Status
EnableReplicaReadonly
New output parameters:TaskId

Release 13
Release time: 2021-08-19 17:33:33
Release updates:
Improvement to existing documentation.
New APIs:
ApplyParamsTemplate
CreateParamTemplate
DeleteParamTemplate
DescribeParamTemplateInfo
DescribeParamTemplates
DescribeTendisSlowLog
InquiryPriceCreateInstance
InquiryPriceUpgradeInstance
ModifyParamTemplate
Modified APIs:
CreateInstances
New input parameters:ZoneName, TemplateId
Modified input parameters: ZoneId
DescribeBackupUrl
New output parameters:Filenames, BackupInfos
New data structures:
BackupDownloadInfo
ParamTemplateInfo
ParameterDetail©2013-2022 Tencent Cloud. All rights reserved.

Page 23 of 500

TencentDB for Redis

TendisSlowLogDetail
Modified data structures:
RedisNodeInfo
New members:ZoneName
Modified members: ZoneId

Release 12
Release time: 2021-07-28 16:06:09
Release updates:
Improvement to existing documentation.
New APIs:
KillMasterGroup

Release 11
Release time: 2021-07-02 15:29:17
Release updates:
Improvement to existing documentation.
New APIs:
ChangeReplicaToMaster
Modified data structures:
RedisNode
New members:Role
RedisNodes
New members:ZoneId

Release 10
Release time: 2021-04-30 10:48:47©2013-2022 Tencent Cloud. All rights reserved.

Page 24 of 500

TencentDB for Redis

Release updates:
Improvement to existing documentation.
New APIs:
UpgradeVersionToMultiAvailabilityZones

Release 9
Release time: 2021-03-19 16:49:48
Release updates:
Improvement to existing documentation.
Modified data structures:InstanceIntegerParam
New members:Unit
InstanceSlowlogDetail
New members:NodeRelease 8
Release time: 2021-03-01 16:36:57
Release updates:
Improvement to existing documentation.
Modified data structures:InstanceSet
New members:ClientLimitMin, ClientLimitMax, NodeSet, Region

Release 7
Release time: 2021-01-22 10:19:59
Release updates:
Improvement to existing documentation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 25 of 500

TencentDB for Redis

Modified APIs:
UpgradeInstanceNew input parameters:NodeSet

Release 6
Release time: 2020-12-21 16:33:16
Release updates:
Improvement to existing documentation.
New APIs:
DescribeInstanceZoneInfo
Modified APIs:
CreateInstances
New input parameters:ResourceTags
New data structures:
RedisNode
ReplicaGroupResourceTag

Release 5
Release time: 2020-11-24 17:34:33
Release updates:
Improvement to existing documentation.
New APIs:
DescribeCommonDBInstances
Modified APIs:
CreateInstances
New input parameters:NodeSet©2013-2022 Tencent Cloud. All rights reserved.

Page 26 of 500

TencentDB for Redis

New data structures:
RedisCommonInstanceList
RedisNodeInfo

Release 4
Release time: 2020-10-30 09:56:16
Release updates:
Improvement to existing documentation.
New APIs:
DescribeInstanceNodeInfo
DescribeProxySlowLog
New data structures:InstanceProxySlowlogDetail
ProxyNodes
RedisNodes
TendisNodes

Release 3
Release time: 2020-09-10 17:15:27
Release updates:
Improvement to existing documentation.
Modified APIs:
DescribeInstances
New input parameters:MonitorVersion
Modified data structures:InstanceSet
New members:DiskSize, MonitorVersion©2013-2022 Tencent Cloud. All rights reserved.

Page 27 of 500

TencentDB for Redis

Release 2
Release time: 2020-08-06 19:41:00
Release updates:
Improvement to existing documentation.
New APIs:
DescribeMaintenanceWindow
ModifyMaintenanceWindow
UpgradeInstanceVersion

Existing Release
Release time: 2020-07-30 20:13:04
Existing APIs/data structures are as follows:
Improvement to existing documentation.
Existing APIs:
AssociateSecurityGroups
CleanUpInstance
ClearInstance
CreateInstanceAccountCreateInstances
DeleteInstanceAccountDescribeAutoBackupConfig
DescribeBackupUrl
DescribeDBSecurityGroups
DescribeInstanceAccountDescribeInstanceBackups
DescribeInstanceDTSInfo
DescribeInstanceDealDetail
DescribeInstanceMonitorBigKey
DescribeInstanceMonitorBigKeySizeDist
DescribeInstanceMonitorBigKeyTypeDist
DescribeInstanceMonitorHotKey
DescribeInstanceMonitorSIP©2013-2022 Tencent Cloud. All rights reserved.

Page 28 of 500

TencentDB for Redis

DescribeInstanceMonitorTookDist
DescribeInstanceMonitorTopNCmd
DescribeInstanceMonitorTopNCmdTook
DescribeInstanceParamRecords
DescribeInstanceParams
DescribeInstanceSecurityGroup
DescribeInstanceShards
DescribeInstances
DescribeProductInfo
DescribeProjectSecurityGroup
DescribeProjectSecurityGroups
DescribeSlowLog
DescribeTaskInfo
DescribeTaskList
DestroyPostpaidInstance
DestroyPrepaidInstance
DisableReplicaReadonly
DisassociateSecurityGroups
EnableReplicaReadonly
ManualBackupInstance
ModfiyInstancePassword
ModifyAutoBackupConfig
ModifyDBInstanceSecurityGroups
ModifyInstance
ModifyInstanceAccount
ModifyInstanceParams
ModifyNetworkConfig
RenewInstanceResetPassword
RestoreInstanceStartupInstance
SwitchInstanceVip
UpgradeInstance
Existing data structures:
Account
BigKeyInfo©2013-2022 Tencent Cloud. All rights reserved.

Page 29 of 500

TencentDB for Redis

BigKeyTypeInfo
CommandTake
DelayDistribution
DescribeInstanceDTSInstanceInfo
HotKeyInfo
InboundInstanceClusterNode
InstanceClusterShard
InstanceEnumParam
InstanceIntegerParam
InstanceMultiParam
InstanceNode
InstanceParam
InstanceParamHistory
InstanceSecurityGroupDetail
InstanceSet
InstanceSlowlogDetail
InstanceTagInfo
InstanceTextParam
Outbound
ProductConf
RedisBackupSet
RegionConf
SecurityGroup
SecurityGroupDetailSecurityGroupsInboundAndOutboundSourceCommand
SourceInfo
TaskInfoDetail
TradeDealDetail
ZoneCapacityConf©2013-2022 Tencent Cloud. All rights reserved.

Page 30 of 500

TencentDB for Redis

Introduction：

Last updated 2024-04-18 16:30:56
Tencent Cloud Redis is a high-availability and highly reliable Redis service platform built upon Tencent's years oftechnological accumulation in the distributed caching field.
Tencent Cloud Redis offers two storage engines: the Community Edition Redis and its self-developed CKV Edition.
Tencent Cloud Redis supports flexible deployment architectures: Master-replica edition and cluster edition, capable ofcatering to diverse business scenarios.
The master-replica edition supports a maximum specification of up to 384 GB, while the cluster edition supports up to
128 shards with specifications exceeding 4 TB.

Note:
All APIs of this section for TencentDB for Redis are the latest version, API 3.0, and all new features related
to TencentDB for Redis will be updated here in this section. We strongly recommend you to use the latest
API 3.0.

©2013-2022 Tencent Cloud. All rights reserved.

Page 31 of 500

TencentDB for Redis

API Category：

Last updated 2024-04-15 11:08:53

Instance APIs
Frequency Limit
API Name

Feature(maximum requests
per second)

AddReplicationInstance

Adds replication group members

20

AllocateWanAddress

Enables public network API

20

ChangeInstanceRole

Modifies the role of an instance in a
replication group20

ChangeMasterInstance

Switches with master instance in a
replication group20

CleanUpInstance

Eliminates instance in recycle bin
immediately

20

ClearInstance

Clears Redis instance20

CloseSSL

Disables SSL

20

CreateInstanceAccountCreates instance sub-account20

CreateReplicationGroup

Creates a replication group

20

DeleteInstanceAccountDeletes instance sub-account

20

DeleteReplicationInstanceDeletes replication group members

20

DescribeAutoBackupConfig

Gets automatic backup configuration

20

DescribeBandwidthRange

Queries the information of instancebandwidth20

DescribeInstanceAccountViews instance sub-account information

20

DescribeInstanceDTSInfo

Queries the DTS task details of
instance

20

DescribeInstanceZoneInfo

Queries Redis node details

20©2013-2022 Tencent Cloud. All rights reserved.

Page 32 of 500

TencentDB for Redis

DescribeInstances

Queries the list of Redis instances

50

DescribeProxySlowLog

Queries the slow queries of proxy20

DescribeSlowLog

Queries the slow log

20

DescribeTendisSlowLog

Queries the slow queries of Tendis
instance

20

DestroyPostpaidInstanceTerminates pay-as-you-go instance20

DestroyPrepaidInstance

Returns monthly subscribed instance20

DisableReplicaReadonly

Disables read/write separation

20

EnableReplicaReadonly

Enables read/write separation

20

InquiryPriceCreateInstanceQueries the price for purchasing an
instance

20

InquiryPriceUpgradeInstanceQueries the price for scaling an
instance

20

KillMasterGroup

Performs failure simulation

20

ModifyAutoBackupConfig

Configures automatic backup

20

ModifyInstance

Modifies instance information

50

ModifyInstanceAccount

Modifies instance sub-account20

ModifyInstanceReadOnly

Sets instance input mode

20

ModifyMaintenanceWindow

Modifies instance maintenance time

20

ModifyNetworkConfig

Modifies the network configuration of
instance

20

OpenSSL

Enables SSL

20

ReleaseWanAddress

Disables public network API

20

RenewInstanceRenews instance20

ResetPassword

Resets password

20

StartupInstance

Deisolates instance20

SwitchProxy

Simulates the failure of a proxy node20

©2013-2022 Tencent Cloud. All rights reserved.

Page 33 of 500

TencentDB for Redis

UpgradeInstanceVersion

Upgrades the instance architecture

20

UpgradeProxyVersion

Upgrades instance proxy version

20

UpgradeSmallVersion

Upgrades instance minor version

20

UpgradeVersionToMultiAvailabilityZones

Upgrades instance to support multi-AZ
deployment

20

DescribeCommonDBInstances

Queries the list of Redis instanceinformation (disused)

20

ChangeReplicaToMaster

Promotes a replica node group tomaster node group20

CloneInstances

Clones an instance20

CreateInstances

Creates Redis instance20

DescribeInstanceDealDetail

Queries order information

20

DescribeInstanceNodeInfo

Queries instance node information

20

DescribeInstanceShards

Gets the information of Cluster Edition
instance shards

20

DescribeMaintenanceWindow

Queries instance maintenance window

20

DescribeParamTemplateInfo

Queries parameter template details

20

DescribeReplicationGroup

Queries the global replication group20

DescribeSSLStatus

Queries SSL status

20

DescribeTaskInfo

Queries Redis task result

20

DescribeTaskList

Queries the list of tasks

100

ModfiyInstancePassword

Modifies the Redis password (Please
use the latest ModifyInstancePassword
API)

20

RemoveReplicationInstance

Removes a member from a replication
group

20

UpgradeInstance

Modifies the instance configuration

20

DescribeInstanceEvents

Queries instance event information

20©2013-2022 Tencent Cloud. All rights reserved.

Page 34 of 500

TencentDB for Redis

ModifyInstanceAvailabilityZones

Modifies the availability zone of theinstance

20

ModifyInstanceEvent

Modifies the operations event execution
schedule of an instance20

SwitchAccessNewInstance

Switches operation immediately

20

DescribeInstanceSupportFeature

Queries the supported features of theinstance

20

Parameter Management APIs
API Name

FeatureFrequency Limit (maximum
requests per second)

ApplyParamsTemplate

Applies parameter template

20

CreateParamTemplate

Creates parameter template

20

DeleteParamTemplate

Deletes parameter template

20

DescribeInstanceParamRecords

Queries the list of parameter
modifications

20

DescribeInstanceParams

Queries the list of instanceparameters

20

DescribeInstanceSecurityGroup

Queries the security group
information of instance20

DescribeParamTemplates

Queries the list of parameter
templates

20

DescribeProjectSecurityGroup

ModifyConnectionConfig

Queries the security group
information of project
Modifies instance connection
configuration

20

20

ModifyInstanceParams

Modifies instance parameters

20

ModifyParamTemplate

Modifies parameter template20©2013-2022 Tencent Cloud. All rights reserved.

Page 35 of 500

TencentDB for Redis

Other APIs
API Name

FeatureFrequency Limit (maximum
requests per second)

AssociateSecurityGroups

Binds security group20

DescribeDBSecurityGroups

Queries security group details

100

DescribeProjectSecurityGroups

Queries the security group detailsof project20

DisassociateSecurityGroups

Unbinds security group frominstances in batches

20

ModifyDBInstanceSecurityGroups

Modifies security groups bound to
instance

20

SwitchInstanceVip

Swaps the VIPs of instances

20

Backup and Restoration APIs
API Name

FeatureFrequency Limit (maximum
requests per second)

DescribeBackupDownloadRestriction

Queries the restrictions fordownloading a backup file20

DescribeBackupUrl

Queries the download address of
backup RDB

20

DescribeInstanceBackups

Queries the list of Redis instancebackups

20

ManualBackupInstance

Manually backs up Redis instance

20

ModifyBackupDownloadRestriction

Modifies the restrictions fordownloading a backup file20

RestoreInstance

Restores Redis instance20

Region APIs

©2013-2022 Tencent Cloud. All rights reserved.

Page 36 of 500

TencentDB for Redis

API Name

FeatureFrequency Limit (maximum requests per
second)DescribeProductInfo

Queries the purchasable productspecifications

20

Monitoring and Management APIs
API Name

FeatureFrequency Limit (maximum
requests per second)

DescribeInstanceMonitorBigKey

Queries the instance big key(disused)20

DescribeInstanceMonitorBigKeySizeDist

Queries the big key size
distribution of an instance(disused)20

Queries the big key type
DescribeInstanceMonitorBigKeyTypeDist

distribution of an instance(disused)20

DescribeInstanceMonitorHotKey

Queries the hot key of an instance20

DescribeInstanceMonitorSIP

Queries the access source
information of an instance20

DescribeInstanceMonitorTookDist

Queries the distribution of
instance access time20

DescribeInstanceMonitorTopNCmd

Queries an instance accesscommand20

DescribeInstanceMonitorTopNCmdTook

Queries the instance CPU time20

©2013-2022 Tencent Cloud. All rights reserved.

Page 37 of 500

TencentDB for Redis

Making API Requests
Request Structure：

Last updated 2024-04-03 11:32:31

1. Service Address
The API supports access from either a nearby region (at redis.tencentcloudapi.com) or a specified region (at redis.apguangzhou.tencentcloudapi.com for Guangzhou, for example).
We recommend using the domain name to access the nearest server. When you call an API, the request is
automatically resolved to a server in the region nearest to the location where the API is initiated. For example, when
you initiate an API request in Guangzhou, this domain name is automatically resolved to a Guangzhou server, theresult is the same as that of specifying the region in the domain like "redis.ap-guangzhou.tencentcloudapi.com".
Note: For latency-sensitive businesses, we recommend that you specify the region in the domain name.
Tencent Cloud currently supports the following regions:
Hosted region
Local access region (recommended, only for non-financial availability
zones)South China (Guangzhou)

Domain nameredis.tencentcloudapi.com
redis.apguangzhou.tencentcloudapi.com

East China (Shanghai)

redis.apshanghai.tencentcloudapi.com

North China (Beijing)redis.ap-beijing.tencentcloudapi.com

Southwest China (Chengdu)

redis.apchengdu.tencentcloudapi.com

Southwest China (Chongqing)

redis.apchongqing.tencentcloudapi.com

Hong Kong, Macao, Taiwan (Hong Kong, China)

redis.aphongkong.tencentcloudapi.com

Southeast Asia (Singapore)redis.apsingapore.tencentcloudapi.com©2013-2022 Tencent Cloud. All rights reserved.

Page 38 of 500

TencentDB for Redis

Southeast Asia (Bangkok)

redis.apbangkok.tencentcloudapi.com

South Asia (Mumbai)

redis.ap-mumbai.tencentcloudapi.com

Northeast Asia (Seoul)

redis.ap-seoul.tencentcloudapi.com

Northeast Asia (Tokyo)

redis.ap-tokyo.tencentcloudapi.com

U.S. East Coast (Virginia)

redis.na-ashburn.tencentcloudapi.com

U.S. West Coast (Silicon Valley)

redis.nasiliconvalley.tencentcloudapi.com

North America (Toronto)

redis.na-toronto.tencentcloudapi.com

Europe (Frankfurt)

redis.eu-frankfurt.tencentcloudapi.com

2. Communications Protocol
All the Tencent Cloud APIs communicate via HTTPS, providing highly secure communication tunnels.

3. Request Methods
Supported HTTP request methods:
POST (recommended)GETThe Content-Type types supported by POST requests:
application/json (recommended). The TC3-HMAC-SHA256 signature algorithm must be used.
application/x-www-form-urlencoded. The HmacSHA1 or HmacSHA256 signature algorithm must be used.
multipart/form-data (only supported by certain APIs). You must use TC3-HMAC-SHA256 to calculate the signature.
The size of a GET request packet is up to 32 KB. The size of a POST request is up to 1 MB when the HmacSHA1 or
HmacSHA256 signature algorithm is used, and up to 10 MB when TC3-HMAC-SHA256 is used.

4. Character Encoding©2013-2022 Tencent Cloud. All rights reserved.

Page 39 of 500

TencentDB for Redis

Only UTF-8 encoding is used.

©2013-2022 Tencent Cloud. All rights reserved.

Page 40 of 500

TencentDB for Redis

Common Params：

Last updated 2024-04-03 11:32:32
Common parameters are used for all APIs authenticating requestors. Common parameters must be included in all API
requests, and they will not be described in individual API documents.
The exact contents of the common parameters will vary depending on the version of the signature method you use.

Common parameters for Signature Algorithm v3
When the TC3-HMAC-SHA256 algorithm is used, the common parameters should be uniformly placed in the HTTP
request header, as shown below:
Parameter
Name

Type

Required

Description
The name of the API for the desired operation. For the specific value, see

X-TC-Action

X-TCRegion

X-TCTimestamp

StringStringYes

Yes

description of common parameter Action in the input parameters in r
documentation. For example, the API for querying the CVM instance list is
DescribeInstances .
Region parameter, which is used to identify the region to which the data ywork with belongs. For values supported for an API, see the description oparameter Region in the input parameters in related API documentati
parameter is not required for some APIs (which will be indicated in related
documentation), and will not take effect even it is passed.

Integer

X-TCVersion

StringAuthorization

StringYes

Yes

The current UNIX timestamp that records the time when the API request w
for example, 1529223702. Note: If the difference between the UNIX times
server time is greater than 5 minutes, a signature expiration error may occ
API version of the action. For the valid values, see the description of the cparameter Version in the API documentation. For example, the versi
2017-03-12.

Yes

The HTTP authentication request header, for example:
TC3-HMAC-SHA256 Credential=AKIDEXAMPLE/Date/service/tc3_requ
SignedHeaders=content-type;host,Signature=fe5f80f77d5fa3beca038a248ff027d0445342fe2855ddc96317
Here:- TC3-HMAC-SHA256: Signature method, currently fixed as this value;- Credential: Signature credential; AKIDEXAMPLE is the SecretId; Date is
UTC time, and this value must match the value of X-TC-Timestamp (a co©2013-2022 Tencent Cloud. All rights reserved.

Page 41 of 500

TencentDB for Redis

parameter) in UTC time format; service is the name of the product/service
generally a domain name prefix. For example, a domain name cvm.tencen
refers to the CVM product and the value would be cvm;
- SignedHeaders: The headers that contains the authentication informatio
type and host are the required headers;- Signature: Signature digest.

X-TC-Token

String

No

The token used for a temporary certificate. It must be used with a tempora
can obtain the temporary key and token by calling a CAM API. No token ia long-term key.

Assuming you want to query the list of Cloud Virtual Machine instances in the Guangzhou region, the request structurein the form of request URL, request header and request body may be as follows:
Example of an HTTP GET request structure:https://cvm.tencentcloudapi.com/?Limit=10&Offset=0
Authorization: TC3-HMAC-SHA256 Credential=AKIDz8krbsJ5yKBZQpn74WFkmLPx3EXAMPLE/20
18-10-09/cvm/tc3_request, SignedHeaders=content-type;host, Signature=5da7a33f6993
f0614b047e5df4582db9e9bf4672ba50567dba16c6ccf174c474
Content-Type: application/x-www-form-urlencoded
Host: cvm.tencentcloudapi.com
X-TC-Action: DescribeInstances
X-TC-Version: 2017-03-12
X-TC-Timestamp: 1539084154
X-TC-Region: ap-guangzhou
The following example shows you how to structure an HTTP POST (application/json) request:
https://cvm.tencentcloudapi.com/
Authorization: TC3-HMAC-SHA256 Credential=AKIDEXAMPLE/2018-05-30/cvm/tc3_request,
SignedHeaders=content-type;host, Signature=582c400e06b5924a6f2b5d7d672d79c15b1316
2d9279b0855cfba6789a8edb4c
Content-Type: application/json
Host: cvm.tencentcloudapi.com
X-TC-Action: DescribeInstances
X-TC-Version: 2017-03-12
X-TC-Timestamp: 1527672334
X-TC-Region: ap-guangzhou{"Offset":0,"Limit":10}
Example of an HTTP POST (multipart/form-data) request structure (only supported by specific APIs):©2013-2022 Tencent Cloud. All rights reserved.

Page 42 of 500

TencentDB for Redis

https://cvm.tencentcloudapi.com/
Authorization: TC3-HMAC-SHA256 Credential=AKIDEXAMPLE/2018-05-30/cvm/tc3_request,
SignedHeaders=content-type;host, Signature=582c400e06b5924a6f2b5d7d672d79c15b1316
2d9279b0855cfba6789a8edb4c
Content-Type: multipart/form-data; boundary=58731222010402
Host: cvm.tencentcloudapi.com
X-TC-Action: DescribeInstances
X-TC-Version: 2017-03-12
X-TC-Timestamp: 1527672334
X-TC-Region: ap-guangzhou--58731222010402
Content-Disposition: form-data; name="Offset"
0--58731222010402
Content-Disposition: form-data; name="Limit"
10--58731222010402--

Common parameters for Signature Algorithm v1
To adopt the HmacSHA1 and HmacSHA256 signature methods, common parameters must be put into the request
string, as shown below:
Parameter NameType

Required

Description
The name of the API for the desired operation. For the specificvalue, see the description of common parameter Action in the

ActionStringYes

input parameters in related API documentation. For example, theAPI for querying the CVM instance list is
DescribeInstances .
Region parameter, which is used to identify the region to which
the data you want to work with belongs. For values supported for
an API, see the description of common parameter Region in

RegionStringYes

the input parameters in related API documentation. Note: Thisparameter is not required for some APIs (which will be indicated inrelated API documentation), and will not take effect even if it ispassed.

©2013-2022 Tencent Cloud. All rights reserved.

Page 43 of 500

TencentDB for Redis

Timestamp

IntegerYes

The current UNIX timestamp that records the time when the API
request was initiated, for example, 1529223702. If the difference
between the value and the current system time is too large, asignature expiration error may occur.
A random positive integer used along with Timestamp to

Nonce

Integer

Yes

SecretId

StringYes

The identifying SecretId obtained on the Cloud API Key page. A
SecretId corresponds to a unique SecretKey which is used togenerate the request signature (Signature).

Yes

Request signature used to verify the validity of this request. This iscalculated based on the actual input parameters. For more
information about how this is calculated, see the API
authentication documentation.

Signature

VersionStringStringYes

prevent replay attacks.

API version of the action. For the valid values, see the descriptionof the common input parameter Version in the API
documentation. For example, the version of CVM is 2017-03-12.

SignatureMethod

StringNo

Signature method. Currently, only HmacSHA256 and HmacSHA1
are supported. The HmacSHA256 algorithm is used to verify thesignature only when this parameter is specified as HmacSHA256.
In other cases, the signature is verified with HmacSHA1.

Token

String

No

The token used for a temporary certificate. It must be used with atemporary key. You can obtain the temporary key and token bycalling a CAM API. No token is required for a long-term key.

Assuming you want to query the list of Cloud Virtual Machine instances in the Guangzhou region, the request structurein the form of request URL, request header and request body may be as follows:
Example of an HTTP GET request structure:https://cvm.tencentcloudapi.com/?Action=DescribeInstances&Version=2017-03-12&Sign
atureMethod=HmacSHA256&Timestamp=1527672334&Signature=37ac2f4fde00b0ac9bd9eadeb45
9b1bbee224158d66e7ae5fcadb70b2d181d02&Region=ap-guangzhou&Nonce=23823223&SecretId=AKIDEXAMPLE
Host: cvm.tencentcloudapi.com
Content-Type: application/x-www-form-urlencoded
Example of an HTTP POST request structure:©2013-2022 Tencent Cloud. All rights reserved.

Page 44 of 500

TencentDB for Redis

https://cvm.tencentcloudapi.com/
Host: cvm.tencentcloudapi.com
Content-Type: application/x-www-form-urlencoded
Action=DescribeInstances&Version=2017-03-12&SignatureMethod=HmacSHA256&Timestamp=
1527672334&Signature=37ac2f4fde00b0ac9bd9eadeb459b1bbee224158d66e7ae5fcadb70b2d18
1d02&Region=ap-guangzhou&Nonce=23823223&SecretId=AKIDEXAMPLE©2013-2022 Tencent Cloud. All rights reserved.

Page 45 of 500

TencentDB for Redis

Signature v3：

Last updated 2024-04-03 11:32:34
TencentCloud API authenticates every single request, i.e., the request must be signed using the security credentials inthe designated steps. Each request has to contain the signature information (Signature) in the common request
parameters and be sent in the specified way and format.

Applying for Security Credentials
The security credential used in this document is a key, which includes a SecretId and a SecretKey. Each user canhave up to two pairs of keys.
SecretId: Used to identify the API caller, which is just like a username.
SecretKey: Used to authenticate the API caller, which is just like a password.
You must keep your security credentials private and avoid disclosure; otherwise, your assets may becompromised. If they are disclosed, please disable them as soon as possible.
You can apply for the security credentials through the following steps:
1. Log in to the Tencent Cloud Console.
2. Go to the TencentCloud API Key console page.
3. On the TencentCloud API Key page, click Create to create a SecretId/SecretKey pair.

Using the Resources for Developers
TencentCloud API comes with SDKs for seven commonly used programming languages, including Python, Java,
PHP, Go, NodeJS and .NET. In addition, it provides API Explorer which enables online call, signature verification, andSDK code generation. If you have any troubles calculating a signature, consult these resources.

TC3-HMAC-SHA256 Signature Algorithm
Compatible with the previous HmacSHA1 and HmacSHA256 signature algorithms, the TC3-HMAC-SHA256
signature algorithm is more secure and supports larger requests and JSON format with better performance. We
recommend using TC3-HMAC-SHA256 to calculate the signature.
TencentCloud API supports both GET and POST requests. For the GET method, only the Content-Type:application/x-www-form-urlencoded protocol format is supported. For the POST method, two protocol formats,©2013-2022 Tencent Cloud. All rights reserved.

Page 46 of 500

TencentDB for Redis

Content-Type: application/json and Content-Type: multipart/form-data, are supported. The JSON format is supported
by default for all business APIs, and the multipart format is supported only for specific business APIs. In this case, theAPI cannot be called in JSON format. See the specific business API documentation for more information. The POST
method is recommended, as there is no difference in the results of both the methods, but the GET method only
supports request packets up to 32 KB.
The following uses querying the list of CVM instances in the Guangzhou region as an example to describe the steps ofsignature splicing. We chose this API because:
1. CVM is activated by default, and this API is often used;
2. It is read-only and does not change the status of existing resources;
3. It covers many types of parameters, which allows it to be used to demonstrate how to use arrays containing data
structures.
In the example, we try to choose common parameters and API parameters that are prone to mistakes. When you
actually call an API, please use parameters based on the actual conditions. The parameters vary by API. Do not copy
the parameters and values in this example.
Assuming that your SecretId and SecretKey are AKIDz8krbsJ5yKBZQpn74WFkmLPx3******* andGu5t9xGARNpq86cd98joQYCN3******* , respectively, if you want to view the status of the instance in the
Guangzhou region whose CVM instance name is "unnamed" and have only one data entry returned, then the request
may be:curl -X POST https://cvm.tencentcloudapi.com \-H "Authorization: TC3-HMAC-SHA256 Credential=AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******/2019-02-25/cvm/tc3_request, SignedHeaders=content-type;host, Signature=c492e8e4
1437e97a620b728c301bb8d17e7dc0c17eeabce80c20cd70fc3a78ff" \-H "Content-Type: application/json; charset=utf-8" \-H "Host: cvm.tencentcloudapi.com" \-H "X-TC-Action: DescribeInstances" \-H "X-TC-Timestamp: 1551113065" \-H "X-TC-Version: 2017-03-12" \-H "X-TC-Region: ap-guangzhou" \-d '{"Limit": 1, "Filters": [{"Values": ["unnamed"], "Name": "instance-name"}]}'The signature calculation process is explained in detail below.

1. Concatenating the CanonicalRequest String
Concatenate the canonical request string (CanonicalRequest) in the following pseudocode format:
CanonicalRequest =HTTPRequestMethod + '\n' +CanonicalURI + '\n' +©2013-2022 Tencent Cloud. All rights reserved.

Page 47 of 500

TencentDB for Redis

CanonicalQueryString + '\n' +CanonicalHeaders + '\n' +SignedHeaders + '\n' +HashedRequestPayload
Field Name

Explanation

HTTPRequestMethod

HTTP request method (GET or POST). This example uses POST .

CanonicalURI

URI parameter. Slash ("/") is used for API 3.0.
The query string in the URL of the originating HTTP request. This is always an empty st“” for POST requests, and is the string after the question mark (?) for GET requests. Fo

CanonicalQueryString。

example: Limit=10&Offset=0
Note: CanonicalQueryString must be URL-encoded, referencing RFC3986, theUTF8 character set. We recommend using the programming language library. All specia
characters must be encoded and capitalized.
Header information for signature calculation, including at least two headers of host
content-type . Custom headers can be added to participate in the signature proce
improve the uniqueness and security of the request.
Concatenation rules:
1. Both the key and value of the header should be converted to lowercase with the lead

CanonicalHeaders

and trailing spaces removed, so they are concatenated in the format of key:value\nformat;2. If there are multiple headers, they should be sorted in ASCII ascending order by theheader keys (lowercase).
The calculation result in this example is content-type:application/json;
charset=utf-8\nhost:cvm.tencentcloudapi.com\n .
Note: content-type must match the actually sent content. In some programming
languages, a charset value would be added even if it is not specified. In this case, therequest sent is different from the one signed, and the sever will return an error indicating
signature verification failed.
Header information for signature calculation, indicating which headers of the request
participate in the signature process (they must each individually correspond to the headin CanonicalHeaders). Content-type and host are required headers.

SignedHeaders

Concatenation rules:
1. Both the key and value of the header should be converted to lowercase;
2. If there are multiple headers, they should be sorted in ASCII ascending order by theheader keys (lowercase) and separated by semicolons (;).
The value in this example is content-type;hostHashedRequestPayload

Hash value of the request payload (i.e., the body, such as {"Limit": 1, "Filter©2013-2022 Tencent Cloud. All rights reserved.

Page 48 of 500

TencentDB for Redis[{"Values": ["unnamed"], "Name": "instance-name"}]} in this example
The pseudocode for calculation is
Lowercase(HexEncode(Hash.SHA256(RequestPayload))) by SHA256 hashing the payof the HTTP request, performing hexadecimal encoding, and finally converting the enco
string to lowercase letters. For GET requests, RequestPayload is always an empt
string. The calculation result in this example is
99d58dfbc6745f6747f36bfca17dee5e6881dc0428a0a36f96199342bc5b49

According to the rules above, the CanonicalRequest string obtained in the example is as follows:

POST/
content-type:application/json; charset=utf-8
host:cvm.tencentcloudapi.com
content-type;host
99d58dfbc6745f6747f36bfca17dee5e6881dc0428a0a36f96199342bc5b4907

2. Concatenating the String to Be Signed
The string to sign is concatenated as follows:
StringToSign =Algorithm + \n +RequestTimestamp + \n +CredentialScope + \n +HashedCanonicalRequest
Field Name

Explanation

Algorithm

Signature algorithm, which is currently always TC3-HMAC-SHA256 .
Request timestamp, i.e., the value of the common parameter X-TC-Timestamp in

RequestTimestamp

request header, which is the UNIX timestamp of the current time in seconds, such as1551113065 in this example.
Scope of the credential in the format of Date/service/tc3_request , including
date, requested service and termination string (tc3_request). Date is a date in UT

CredentialScopetime, whose value should match the UTC date converted by the common
parameter X-TC-Timestamp ; service is the product name, which should mthe domain name of the product called. The calculation result in this example is 201
25/cvm/tc3_request .

©2013-2022 Tencent Cloud. All rights reserved.

Page 49 of 500

TencentDB for Redis

HashedCanonicalRequest

Hash value of the CanonicalRequest string concatenated in the steps above. The
pseudocode for calculation is Lowercase(HexEncode(Hash.SHA256(CanonicalRequ
The calculation result in this example is2815843035062fffda5fd6f2a44ea8a34818b0dc46f024b8b3786976a3ad

Note:

1. Date has to be calculated from the timestamp "X-TC-Timestamp" and the time zone is UTC+0. If you add
the system's local time zone information (such as UTC+8), calls can succeed both day and night but willdefinitely fail at 00:00. For example, if the timestamp is 1551113065 and the time in UTC+8 is 2019-02-26
00:44:25, the UTC+0 date in the calculated Date value should be 2019-02-25 instead of 2019-02-26.
2. Timestamp must be the same as your current system time, and your system time and standard time must be
synced; if the difference between Timestamp and your current system time is larger than five minutes, therequest will fail. If your system time is out of sync with the standard time for a while, the request will fail andreturn a signature expiration error.

According to the preceding rules, the string to be signed obtained in the example is as follows:
TC3-HMAC-SHA256
1551113065
2019-02-25/cvm/tc3_request
2815843035062fffda5fd6f2a44ea8a34818b0dc46f024b8b3786976a3adda7a

3. Calculating the Signature
1. Calculate the derived signature key with the following pseudocode:

SecretKey = "Gu5t9xGARNpq86cd98joQYCN3*******"
SecretDate = HMAC_SHA256("TC3" + SecretKey, Date)
SecretService = HMAC_SHA256(SecretDate, Service)
SecretSigning = HMAC_SHA256(SecretService, "tc3_request")
Field Name

Explanation

SecretKey

The original SecretKey, i.e., Gu5t9xGARNpq86cd98joQYCN3******* .

Date

The Date field information in Credential , such as 2019-02-25 in this example.

©2013-2022 Tencent Cloud. All rights reserved.

Page 50 of 500

TencentDB for Redis

Service

Value in the Service field in Credential , such as cvm in this example.

2. Calculate the signature with the following pseudocode:

Signature = HexEncode(HMAC_SHA256(SecretSigning, StringToSign))

4. Concatenating the Authorization
The Authorization is concatenated as follows:

Authorization =Algorithm + ' ' +'Credential=' + SecretId + '/' + CredentialScope + ', ' +'SignedHeaders=' + SignedHeaders + ', ' +'Signature=' + Signature
Field Name

Explanation

Algorithm

Signature algorithm, which is always TC3-HMAC-SHA256 .

SecretId

The SecretId in the key pair, i.e., AKIDz8krbsJ5yKBZQpn74WFkmLPx3******* .

CredentialScope

SignedHeadersSignature

Credential scope (see above). The calculation result in this example is 2019-0225/cvm/tc3_request .
Header information for signature calculation (see above), such as content-type;hostin this example.
Signature value. The calculation result in this example isc492e8e41437e97a620b728c301bb8d17e7dc0c17eeabce80c20cd70fc3a78ff .

According to the rules above, the value obtained in the example is:TC3-HMAC-SHA256 Credential=AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******/2019-02-25/cvm/tc
3_request, SignedHeaders=content-type;host, Signature=c492e8e41437e97a620b728c301
bb8d17e7dc0c17eeabce80c20cd70fc3a78ff
The following example shows a finished authorization header:
POST https://cvm.tencentcloudapi.com/
Authorization: TC3-HMAC-SHA256 Credential=AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******/20
19-02-25/cvm/tc3_request, SignedHeaders=content-type;host, Signature=c492e8e41437
e97a620b728c301bb8d17e7dc0c17eeabce80c20cd70fc3a78ff©2013-2022 Tencent Cloud. All rights reserved.

Page 51 of 500

TencentDB for Redis

Content-Type: application/json; charset=utf-8
Host: cvm.tencentcloudapi.com
X-TC-Action: DescribeInstances
X-TC-Version: 2017-03-12
X-TC-Timestamp: 1551113065
X-TC-Region: ap-guangzhou{"Limit": 1, "Filters": [{"Values": ["unnamed"], "Name": "instance-name"}]}5. Signature Demo
When calling API 3.0, you are recommended to use the corresponding Tencent Cloud SDK 3.0 which encapsulates
the signature process, enabling you to focus on only the specific APIs provided by the product when developing. See
SDK Center for more information. Currently, the following programming languages are supported:
PythonJava
PHP
Go
NodeJS.NET
To further explain the signing process, we will use a programming language to implement the process describedabove. The request domain name, API and parameter values in the sample are used here. This goal of this example isonly to provide additional clarification for the signature process, please see the SDK for actual usage.
The final output URL might be: https://cvm.tencentcloudapi.com/?Action=DescribeInstances&InstanceIds.0=ins09dx96dg&Limit=20&Nonce=11886&Offset=0&Region=apguangzhou&SecretId=AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******&Signature=EliP9YW3pW28FpsEdkXt%2F%2B
WcGeI%3D&Timestamp=1465185768&Version=2017-03-12.
Note: The key in the example is fictitious, and the timestamp is not the current time of the system, so if this URL is
opened in the browser or called using commands such as curl, an authentication error will be returned: Signature
expired. In order to get a URL that can work properly, you need to replace the SecretId and SecretKey in the example
with your real credentials and use the current time of the system as the Timestamp.
Note: In the example below, even if you use the same programming language, the order of the parameters in the URL
may be different for each execution. However, the order does not matter, as long as all the parameters are included in
the URL and the signature is calculated correctly.
Note: The following code is only applicable to API 3.0. It cannot be directly used in other signature processes. Even
with an older API, signature calculation errors may occur due to the differences in details. Please refer to thecorresponding documentation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 52 of 500

TencentDB for Redis

Java
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.security.MessageDigest;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.TimeZone;
import java.util.TreeMap;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import javax.xml.bind.DatatypeConverter;
public class TencentCloudAPITC3Demo {private final static Charset UTF8 = StandardCharsets.UTF_8;
private final static String SECRET_ID = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******";
private final static String SECRET_KEY = "Gu5t9xGARNpq86cd98joQYCN3*******";
private final static String CT_JSON = "application/json; charset=utf-8";
public static byte[] hmac256(byte[] key, String msg) throws Exception {Mac mac = Mac.getInstance("HmacSHA256");
SecretKeySpec secretKeySpec = new SecretKeySpec(key, mac.getAlgorithm());
mac.init(secretKeySpec);
return mac.doFinal(msg.getBytes(UTF8));}
public static String sha256Hex(String s) throws Exception {MessageDigest md = MessageDigest.getInstance("SHA-256");
byte[] d = md.digest(s.getBytes(UTF8));
return DatatypeConverter.printHexBinary(d).toLowerCase();}public static void main(String[] args) throws Exception {String service = "cvm";
String host = "cvm.tencentcloudapi.com";
String region = "ap-guangzhou";String action = "DescribeInstances";
String version = "2017-03-12";
String algorithm = "TC3-HMAC-SHA256";
String timestamp = "1551113065";//String timestamp = String.valueOf(System.currentTimeMillis() / 1000);
SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd");// Pay attention to the time zone; otherwise, errors may occur
sdf.setTimeZone(TimeZone.getTimeZone("UTC"));
String date = sdf.format(new Date(Long.valueOf(timestamp + "000")));// ************* Step 1: Concatenate the CanonicalRequest string *************©2013-2022 Tencent Cloud. All rights reserved.

Page 53 of 500

TencentDB for Redis

String httpRequestMethod = "POST";
String canonicalUri = "/";
String canonicalQueryString = "";String canonicalHeaders = "content-type:application/json; charset=utf-8\n" + "host:" + host + "\n";String signedHeaders = "content-type;host";
String payload = "{\"Limit\": 1, \"Filters\": [{\"Values\": [\"unnamed\"], \"Name\": \"instance-name\"}]}";
String hashedRequestPayload = sha256Hex(payload);
String canonicalRequest = httpRequestMethod + "\n" + canonicalUri + "\n" + canoni
calQueryString + "\n"+ canonicalHeaders + "\n" + signedHeaders + "\n" + hashedRequestPayload;
System.out.println(canonicalRequest);// ************* Step 2: Concatenate the string to sign *************
String credentialScope = date + "/" + service + "/" + "tc3_request";
String hashedCanonicalRequest = sha256Hex(canonicalRequest);
String stringToSign = algorithm + "\n" + timestamp + "\n" + credentialScope +"\n" + hashedCanonicalRequest;
System.out.println(stringToSign);// ************* Step 3: Calculate the signature *************
byte[] secretDate = hmac256(("TC3" + SECRET_KEY).getBytes(UTF8), date);byte[] secretService = hmac256(secretDate, service);byte[] secretSigning = hmac256(secretService, "tc3_request");String signature = DatatypeConverter.printHexBinary(hmac256(secretSigning, string
ToSign)).toLowerCase();
System.out.println(signature);// ************* Step 4: Concatenate the Authorization *************
String authorization = algorithm + " " + "Credential=" + SECRET_ID + "/" + creden
tialScope + ", "+ "SignedHeaders=" + signedHeaders + ", " + "Signature=" + signature;
System.out.println(authorization);
TreeMap<String, String> headers = new TreeMap<String, String>();headers.put("Authorization", authorization);headers.put("Content-Type", CT_JSON);headers.put("Host", host);
headers.put("X-TC-Action", action);headers.put("X-TC-Timestamp", timestamp);
headers.put("X-TC-Version", version);headers.put("X-TC-Region", region);
StringBuilder sb = new StringBuilder();sb.append("curl -X POST https://").append(host)©2013-2022 Tencent Cloud. All rights reserved.

Page 54 of 500

TencentDB for Redis.append(" -H \"Authorization: ").append(authorization).append("\"").append(" -H \"Content-Type: application/json; charset=utf-8\"").append(" -H \"Host: ").append(host).append("\"").append(" -H \"X-TC-Action: ").append(action).append("\"").append(" -H \"X-TC-Timestamp: ").append(timestamp).append("\"").append(" -H \"X-TC-Version: ").append(version).append("\"").append(" -H \"X-TC-Region: ").append(region).append("\"").append(" -d '").append(payload).append("'");
System.out.println(sb.toString());}}

Python# -*- coding: utf-8 -*import hashlib, hmac, json, os, sys, timefrom datetime import datetime# Key Parameters
secret_id = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"
secret_key = "Gu5t9xGARNpq86cd98joQYCN3*******"
service = "cvm"host = "cvm.tencentcloudapi.com"
endpoint = "https://" + hostregion = "ap-guangzhou"
action = "DescribeInstances"version = "2017-03-12"
algorithm = "TC3-HMAC-SHA256"#timestamp = int(time.time())
timestamp = 1551113065
date = datetime.utcfromtimestamp(timestamp).strftime("%Y-%m-%d")params = {"Limit": 1, "Filters": [{"Name": "instance-name", "Values": ["unnamed"]}]}# ************* Step 1: Concatenate the CanonicalRequest string *************
http_request_method = "POST"
canonical_uri = "/"canonical_querystring = ""ct = "application/json; charset=utf-8"
payload = json.dumps(params)
canonical_headers = "content-type:%s\nhost:%s\n" % (ct, host)signed_headers = "content-type;host"hashed_request_payload = hashlib.sha256(payload.encode("utf-8")).hexdigest()
canonical_request = (http_request_method + "\n" +canonical_uri + "\n" +©2013-2022 Tencent Cloud. All rights reserved.

Page 55 of 500

TencentDB for Redis

canonical_querystring + "\n" +canonical_headers + "\n" +signed_headers + "\n" +hashed_request_payload)
print(canonical_request)# ************* Step 2: Concatenate the string to sign *************
credential_scope = date + "/" + service + "/" + "tc3_request"
hashed_canonical_request = hashlib.sha256(canonical_request.encode("utf-8")).hexd
igest()
string_to_sign = (algorithm + "\n" +str(timestamp) + "\n" +credential_scope + "\n" +hashed_canonical_request)
print(string_to_sign)# ************* Step 3: Calculate the Signature *************# Function for computing signature digest
def sign(key, msg):
return hmac.new(key, msg.encode("utf-8"), hashlib.sha256).digest()
secret_date = sign(("TC3" + secret_key).encode("utf-8"), date)secret_service = sign(secret_date, service)secret_signing = sign(secret_service, "tc3_request")
signature = hmac.new(secret_signing, string_to_sign.encode("utf-8"), hashlib.sha256).hexdigest()
print(signature)# ************* Step 4: Concatenate the Authorization *************
authorization = (algorithm + " " +"Credential=" + secret_id + "/" + credential_scope + ", " +"SignedHeaders=" + signed_headers + ", " +"Signature=" + signature)
print(authorization)
print('curl -X POST ' + endpoint+ ' -H "Authorization: ' + authorization + '"'+ ' -H "Content-Type: application/json; charset=utf-8"'+ ' -H "Host: ' + host + '"'+ ' -H "X-TC-Action: ' + action + '"'+ ' -H "X-TC-Timestamp: ' + str(timestamp) + '"'+ ' -H "X-TC-Version: ' + version + '"'+ ' -H "X-TC-Region: ' + region + '"'+ " -d '" + payload + "'")

Golang©2013-2022 Tencent Cloud. All rights reserved.

Page 56 of 500

TencentDB for Redispackage main
import ("crypto/hmac""crypto/sha256""encoding/hex""fmt""time")
func sha256hex(s string) string {b := sha256.Sum256([]byte(s))
return hex.EncodeToString(b[:])}func hmacsha256(s, key string) string {hashed := hmac.New(sha256.New, []byte(key))hashed.Write([]byte(s))
return string(hashed.Sum(nil))}func main() {secretId := "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"
secretKey := "Gu5t9xGARNpq86cd98joQYCN3*******"
host := "cvm.tencentcloudapi.com"
algorithm := "TC3-HMAC-SHA256"
service := "cvm"version := "2017-03-12"
action := "DescribeInstances"
region := "ap-guangzhou"//var timestamp int64 = time.Now().Unix()
var timestamp int64 = 1551113065// step 1: build canonical request string
httpRequestMethod := "POST"
canonicalURI := "/"canonicalQueryString := ""canonicalHeaders := "content-type:application/json; charset=utf-8\n" + "host:" +host + "\n"signedHeaders := "content-type;host"
payload := `{"Limit": 1, "Filters": [{"Values": ["unnamed"], "Name": "instance-name"}]}`
hashedRequestPayload := sha256hex(payload)
canonicalRequest := fmt.Sprintf("%s\n%s\n%s\n%s\n%s\n%s",
httpRequestMethod,
canonicalURI,©2013-2022 Tencent Cloud. All rights reserved.

Page 57 of 500

TencentDB for Redis

canonicalQueryString,canonicalHeaders,signedHeaders,hashedRequestPayload)
fmt.Println(canonicalRequest)// step 2: build string to sign
date := time.Unix(timestamp, 0).UTC().Format("2006-01-02")
credentialScope := fmt.Sprintf("%s/%s/tc3_request", date, service)hashedCanonicalRequest := sha256hex(canonicalRequest)
string2sign := fmt.Sprintf("%s\n%d\n%s\n%s",
algorithm,
timestamp,
credentialScope,
hashedCanonicalRequest)
fmt.Println(string2sign)// step 3: sign string
secretDate := hmacsha256(date, "TC3"+secretKey)
secretService := hmacsha256(service, secretDate)secretSigning := hmacsha256("tc3_request", secretService)signature := hex.EncodeToString([]byte(hmacsha256(string2sign, secretSigning)))
fmt.Println(signature)// step 4: build authorization
authorization := fmt.Sprintf("%s Credential=%s/%s, SignedHeaders=%s, Signature=%s",algorithm,
secretId,
credentialScope,
signedHeaders,signature)
fmt.Println(authorization)
curl := fmt.Sprintf(`curl -X POST https://%s\-H "Authorization: %s"\
-H "Content-Type: application/json; charset=utf-8"\-H "Host: %s" -H "X-TC-Action: %s"\
-H "X-TC-Timestamp: %d"\
-H "X-TC-Version: %s"\
-H "X-TC-Region: %s"\-d '%s'`, host, authorization, host, action, timestamp, version, region, payload)
fmt.Println(curl)}

PHP©2013-2022 Tencent Cloud. All rights reserved.

Page 58 of 500

TencentDB for Redis<?php$secretId = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******";$secretKey = "Gu5t9xGARNpq86cd98joQYCN3*******";$host = "cvm.tencentcloudapi.com";$service = "cvm";$version = "2017-03-12";$action = "DescribeInstances";$region = "ap-guangzhou";// $timestamp = time();$timestamp = 1551113065;$algorithm = "TC3-HMAC-SHA256";// step 1: build canonical request string$httpRequestMethod = "POST";$canonicalUri = "/";
$canonicalQueryString = "";$canonicalHeaders = "content-type:application/json; charset=utf-8\n"."host:".$host."\n";$signedHeaders = "content-type;host";$payload = '{"Limit": 1, "Filters": [{"Values": ["unnamed"], "Name": "instance-name"}]}';$hashedRequestPayload = hash("SHA256", $payload);$canonicalRequest = $httpRequestMethod."\n".$canonicalUri."\n".$canonicalQueryString."\n".$canonicalHeaders."\n".$signedHeaders."\n".$hashedRequestPayload;
echo $canonicalRequest.PHP_EOL;// step 2: build string to sign
$date = gmdate("Y-m-d", $timestamp);$credentialScope = $date."/".$service."/tc3_request";$hashedCanonicalRequest = hash("SHA256", $canonicalRequest);$stringToSign = $algorithm."\n".$timestamp."\n".$credentialScope."\n".$hashedCanonicalRequest;
echo $stringToSign.PHP_EOL;// step 3: sign string$secretDate = hash_hmac("SHA256", $date, "TC3".$secretKey, true);$secretService = hash_hmac("SHA256", $service, $secretDate, true);$secretSigning = hash_hmac("SHA256", "tc3_request", $secretService, true);$signature = hash_hmac("SHA256", $stringToSign, $secretSigning);
echo $signature.PHP_EOL;©2013-2022 Tencent Cloud. All rights reserved.

Page 59 of 500

TencentDB for Redis// step 4: build authorization$authorization = $algorithm." Credential=".$secretId."/".$credentialScope.", SignedHeaders=content-type;host, Signature=".$signature;echo $authorization.PHP_EOL;$curl = "curl -X POST https://".$host.' -H "Authorization: '.$authorization.'"'.' -H "Content-Type: application/json; charset=utf-8"'.' -H "Host: '.$host.'"'.' -H "X-TC-Action: '.$action.'"'.' -H "X-TC-Timestamp: '.$timestamp.'"'.' -H "X-TC-Version: '.$version.'"'.' -H "X-TC-Region: '.$region.'"'." -d '".$payload."'";
echo $curl.PHP_EOL;

Ruby# -*- coding: UTF-8 -*# require ruby>=2.3.0
require 'digest'
require 'json'
require 'time'require 'openssl'# Key Parameters
secret_id = 'AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******'
secret_key = 'Gu5t9xGARNpq86cd98joQYCN3*******'
service = 'cvm'
host = 'cvm.tencentcloudapi.com'
endpoint = 'https://' + hostregion = 'ap-guangzhou'
action = 'DescribeInstances'version = '2017-03-12'
algorithm = 'TC3-HMAC-SHA256'# timestamp = Time.now.to_i
timestamp = 1551113065
date = Time.at(timestamp).utc.strftime('%Y-%m-%d')# ************* Step 1: Concatenate the CanonicalRequest string *************
http_request_method = 'POST'
canonical_uri = '/'canonical_querystring = ''©2013-2022 Tencent Cloud. All rights reserved.

Page 60 of 500

TencentDB for Redis

canonical_headers = "content-type:application/json; charset=utf-8\nhost:#{host}\n"signed_headers = 'content-type;host'# params = { 'Limit' => 1, 'Filters' => [{ 'Name' => 'instance-name', 'Values' =>['unnamed'] }] }# payload = JSON.generate(params, { 'ascii_only' => true, 'space' => ' ' })# json will generate in random order, to get specified result in example, we hard-code it here.
payload = '{"Limit": 1, "Filters": [{"Values": ["unnamed"], "Name": "instance-name"}]}'
hashed_request_payload = Digest::SHA256.hexdigest(payload)
canonical_request = [http_request_method,
canonical_uri,canonical_querystring,canonical_headers,signed_headers,hashed_request_payload,].join("\n")puts canonical_request# ************* Step 2: Concatenate the string to sign *************
credential_scope = date + '/' + service + '/' + 'tc3_request'
hashed_request_payload = Digest::SHA256.hexdigest(canonical_request)
string_to_sign = [algorithm,
timestamp.to_s,
credential_scope,
hashed_request_payload,].join("\n")puts string_to_sign# ************* Step 3: Calculate the Signature *************
digest = OpenSSL::Digest.new('sha256')secret_date = OpenSSL::HMAC.digest(digest, 'TC3' + secret_key, date)secret_service = OpenSSL::HMAC.digest(digest, secret_date, service)secret_signing = OpenSSL::HMAC.digest(digest, secret_service, 'tc3_request')
signature = OpenSSL::HMAC.hexdigest(digest, secret_signing, string_to_sign)
puts signature# ************* Step 4: Concatenate the Authorization *************
authorization = "#{algorithm} Credential=#{secret_id}/#{credential_scope}, Signed
Headers=#{signed_headers}, Signature=#{signature}"puts authorization
puts 'curl -X POST ' + endpoint \©2013-2022 Tencent Cloud. All rights reserved.

Page 61 of 500

TencentDB for Redis+ ' -H "Authorization: ' + authorization + '"' \+ ' -H "Content-Type: application/json; charset=utf-8"' \+ ' -H "Host: ' + host + '"' \+ ' -H "X-TC-Action: ' + action + '"' \+ ' -H "X-TC-Timestamp: ' + timestamp.to_s + '"' \+ ' -H "X-TC-Version: ' + version + '"' \+ ' -H "X-TC-Region: ' + region + '"' \+ " -d '" + payload + "'"DotNetusing System;
using System.Collections.Generic;using System.Security.Cryptography;
using System.Text;
public class Application{
public static string SHA256Hex(string s){
using (SHA256 algo = SHA256.Create()){
byte[] hashbytes = algo.ComputeHash(Encoding.UTF8.GetBytes(s));
StringBuilder builder = new StringBuilder();for (int i = 0; i < hashbytes.Length; ++i){
builder.Append(hashbytes[i].ToString("x2"));}
return builder.ToString();}}
public static byte[] HmacSHA256(byte[] key, byte[] msg){
using (HMACSHA256 mac = new HMACSHA256(key)){
return mac.ComputeHash(msg);}}
public static Dictionary<String, String> BuildHeaders(string secretid,
string secretkey, string service, string endpoint, string region,
string action, string version, DateTime date, string requestPayload){
string datestr = date.ToString("yyyy-MM-dd");
DateTime startTime = new DateTime(1970, 1, 1, 0, 0, 0, 0, DateTimeKind.Utc);
long requestTimestamp = (long)Math.Round((date - startTime).TotalMilliseconds, Mi©2013-2022 Tencent Cloud. All rights reserved.

Page 62 of 500

TencentDB for Redis

dpointRounding.AwayFromZero) / 1000;// ************* Step 1: Concatenate the CanonicalRequest string *************
string algorithm = "TC3-HMAC-SHA256";
string httpRequestMethod = "POST";
string canonicalUri = "/";
string canonicalQueryString = "";string contentType = "application/json";string canonicalHeaders = "content-type:" + contentType + "; charset=utf-8\n" +"host:" + endpoint + "\n";string signedHeaders = "content-type;host";
string hashedRequestPayload = SHA256Hex(requestPayload);string canonicalRequest = httpRequestMethod + "\n"+ canonicalUri + "\n"+ canonicalQueryString + "\n"+ canonicalHeaders + "\n"+ signedHeaders + "\n"+ hashedRequestPayload;
Console.WriteLine(canonicalRequest);
Console.WriteLine("----------------------------------");// ************ Step 2: Concatenate the string to sign *************
string credentialScope = datestr + "/" + service + "/" + "tc3_request";
string hashedCanonicalRequest = SHA256Hex(canonicalRequest);
string stringToSign = algorithm + "\n" + requestTimestamp.ToString() + "\n" + cre
dentialScope + "\n" + hashedCanonicalRequest;
Console.WriteLine(stringToSign);
Console.WriteLine("----------------------------------");// ************* Step 3: Calculate the signature *************
byte[] tc3SecretKey = Encoding.UTF8.GetBytes("TC3" + secretkey);byte[] secretDate = HmacSHA256(tc3SecretKey, Encoding.UTF8.GetBytes(datestr));byte[] secretService = HmacSHA256(secretDate, Encoding.UTF8.GetBytes(service));byte[] secretSigning = HmacSHA256(secretService, Encoding.UTF8.GetBytes("tc3_request"));
byte[] signatureBytes = HmacSHA256(secretSigning, Encoding.UTF8.GetBytes(stringTo
Sign));
string signature = BitConverter.ToString(signatureBytes).Replace("-", "").ToLower();
Console.WriteLine(signature);
Console.WriteLine("----------------------------------");// ************* Step 4: Concatenate the Authorization *************
string authorization = algorithm + " "+ "Credential=" + secretid + "/" + credentialScope + ", "+ "SignedHeaders=" + signedHeaders + ", "+ "Signature=" + signature;
Console.WriteLine(authorization);©2013-2022 Tencent Cloud. All rights reserved.

Page 63 of 500

TencentDB for Redis

Console.WriteLine("----------------------------------");
Dictionary<string, string> headers = new Dictionary<string, string>();headers.Add("Authorization", authorization);headers.Add("Host", endpoint);
headers.Add("Content-Type", contentType + "; charset=utf-8");
headers.Add("X-TC-Timestamp", requestTimestamp.ToString());
headers.Add("X-TC-Version", version);headers.Add("X-TC-Action", action);headers.Add("X-TC-Region", region);
return headers;}public static void Main(string[] args){// SecretID and SecretKey
string SECRET_ID = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******";
string SECRET_KEY = "Gu5t9xGARNpq86cd98joQYCN3*******";
string service = "cvm";
string endpoint = "cvm.tencentcloudapi.com";string region = "ap-guangzhou";string action = "DescribeInstances";
string version = "2017-03-12";// The timestamp `2019-02-26 00:44:25` used here is only for reference. In a proj
ect, use the following parameter:// DateTime date = DateTime.UtcNow;// Enter the correct time zone. We recommend using UTC timestamp to avoid errors.
DateTime date = new DateTime(1970, 1, 1, 0, 0, 0, 0, DateTimeKind.Utc).AddSeconds(1551113065);
string requestPayload = "{\"Limit\": 1, \"Filters\": [{\"Values\": [\"\\u672a\\u5
47d\\u540d\"], \"Name\": \"instance-name\"}]}";
Dictionary<string, string> headers = BuildHeaders(SECRET_ID, SECRET_KEY, service, endpoint, region, action, version, date, requestPayload);
Console.WriteLine("POST https://cvm.tencentcloudapi.com");foreach (KeyValuePair<string, string> kv in headers){Console.WriteLine(kv.Key + ": " + kv.Value);}
Console.WriteLine();Console.WriteLine(requestPayload);}}©2013-2022 Tencent Cloud. All rights reserved.

Page 64 of 500

TencentDB for Redis

NodeJS
const crypto = require('crypto');function sha256(message, secret = '', encoding) {const hmac = crypto.createHmac('sha256', secret)return hmac.update(message).digest(encoding)}
function getHash(message, encoding = 'hex') {const hash = crypto.createHash('sha256')
return hash.update(message).digest(encoding)}
function getDate(timestamp) {const date = new Date(timestamp * 1000)
const year = date.getUTCFullYear()const month = ('0' + (date.getUTCMonth() + 1)).slice(-2)
const day = ('0' + date.getUTCDate()).slice(-2)
return `${year}-${month}-${day}`}function main(){const SECRET_ID = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"
const SECRET_KEY = "Gu5t9xGARNpq86cd98joQYCN3*******"
const endpoint = "cvm.tencentcloudapi.com"
const service = "cvm"
const region = "ap-guangzhou"
const action = "DescribeInstances"
const version = "2017-03-12"//const timestamp = getTime()
const timestamp = 1551113065
const date = getDate(timestamp)// ************* Step 1: Concatenate the CanonicalRequest string *************
const signedHeaders = "content-type;host"const payload = "{\"Limit\": 1, \"Filters\": [{\"Values\": [\"unnamed\"], \"Name\": \"instance-name\"}]}"
const hashedRequestPayload = getHash(payload);
const httpRequestMethod = "POST"
const canonicalUri = "/"const canonicalQueryString = ""const canonicalHeaders = "content-type:application/json; charset=utf-8\n" + "host:" + endpoint + "\n"const canonicalRequest = httpRequestMethod + "\n"©2013-2022 Tencent Cloud. All rights reserved.

Page 65 of 500

TencentDB for Redis+ canonicalUri + "\n"+ canonicalQueryString + "\n"+ canonicalHeaders + "\n"+ signedHeaders + "\n"+ hashedRequestPayload
console.log(canonicalRequest)
console.log("----------------------------")// ************* Step 2: Concatenate the string to sign *************
const algorithm = "TC3-HMAC-SHA256"
const hashedCanonicalRequest = getHash(canonicalRequest);
const credentialScope = date + "/" + service + "/" + "tc3_request"
const stringToSign = algorithm + "\n" +timestamp + "\n" +credentialScope + "\n" +hashedCanonicalRequest
console.log(stringToSign)
console.log("----------------------------")// ************* Step 3: Calculate the signature *************
const kDate = sha256(date, 'TC3' + SECRET_KEY)
const kService = sha256(service, kDate)
const kSigning = sha256('tc3_request', kService)
const signature = sha256(stringToSign, kSigning, 'hex')
console.log(signature)
console.log("----------------------------")// ************* Step 4: Concatenate the Authorization *************
const authorization = algorithm + " " +"Credential=" + SECRET_ID + "/" + credentialScope + ", " +"SignedHeaders=" + signedHeaders + ", " +"Signature=" + signature
console.log(authorization)
console.log("----------------------------")
const Call_Information = 'curl -X POST ' + "https://" + endpoint+ ' -H "Authorization: ' + authorization + '"'+ ' -H "Content-Type: application/json; charset=utf-8"'+ ' -H "Host: ' + endpoint + '"'+ ' -H "X-TC-Action: ' + action + '"'+ ' -H "X-TC-Timestamp: ' + timestamp.toString() + '"'+ ' -H "X-TC-Version: ' + version + '"'+ ' -H "X-TC-Region: ' + region + '"'+ " -d '" + payload + "'"console.log(Call_Information)}main()©2013-2022 Tencent Cloud. All rights reserved.

Page 66 of 500

TencentDB for RedisC++#include <iostream>#include <iomanip>#include <sstream>#include <string>#include <stdio.h>#include <time.h>#include <openssl/sha.h>#include <openssl/hmac.h>using namespace std;
string get_data(int64_t &timestamp){
string utcDate;char buff[20] = {0};// time_t timenow;
struct tm sttime;
sttime = *gmtime(&timestamp);
strftime(buff, sizeof(buff), "%Y-%m-%d", &sttime);
utcDate = string(buff);
return utcDate;}string int2str(int64_t n){
std::stringstream ss;
ss << n;return ss.str();}string sha256Hex(const string &str){
char buf[3];unsigned char hash[SHA256_DIGEST_LENGTH];
SHA256_CTX sha256;
SHA256_Init(&sha256);
SHA256_Update(&sha256, str.c_str(), str.size());
SHA256_Final(hash, &sha256);
std::string NewString = "";for(int i = 0; i < SHA256_DIGEST_LENGTH; i++){snprintf(buf, sizeof(buf), "%02x", hash[i]);NewString = NewString + buf;}
return NewString;©2013-2022 Tencent Cloud. All rights reserved.

Page 67 of 500

TencentDB for Redis}
string HmacSha256(const string &key, const string &input){
unsigned char hash[32];
HMAC_CTX *h;#if OPENSSL_VERSION_NUMBER < 0x10100000L
HMAC_CTX hmac;
HMAC_CTX_init(&hmac);h = &hmac;#else
h = HMAC_CTX_new();#endif
HMAC_Init_ex(h, &key[0], key.length(), EVP_sha256(), NULL);
HMAC_Update(h, ( unsigned char* )&input[0], input.length());
unsigned int len = 32;
HMAC_Final(h, hash, &len);#if OPENSSL_VERSION_NUMBER < 0x10100000L
HMAC_CTX_cleanup(h);#else
HMAC_CTX_free(h);#endif
std::stringstream ss;
ss << std::setfill('0');for (int i = 0; i < len; i++){ss << hash[i];}return (ss.str());}
string HexEncode(const string &input){
static const char* const lut = "0123456789abcdef";
size_t len = input.length();string output;
output.reserve(2 * len);for (size_t i = 0; i < len; ++i){
const unsigned char c = input[i];output.push_back(lut[c >> 4]);
output.push_back(lut[c & 15]);}©2013-2022 Tencent Cloud. All rights reserved.

Page 68 of 500

TencentDB for Redis

return output;}
int main(){string SECRET_ID = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******";
string SECRET_KEY = "Gu5t9xGARNpq86cd98joQYCN3*******";
string service = "cvm";
string host = "cvm.tencentcloudapi.com";string region = "ap-guangzhou";string action = "DescribeInstances";
string version = "2017-03-12";
int64_t timestamp = 1551113065;
string date = get_data(timestamp);// ************* Step 1: Concatenate the CanonicalRequest string *************
string httpRequestMethod = "POST";
string canonicalUri = "/";
string canonicalQueryString = "";string canonicalHeaders = "content-type:application/json; charset=utf-8\nhost:" +host + "\n";string signedHeaders = "content-type;host";
string payload = "{\"Limit\": 1, \"Filters\": [{\"Values\": [\"unnamed\"], \"Name\": \"instance-name\"}]}";
string hashedRequestPayload = sha256Hex(payload);string canonicalRequest = httpRequestMethod + "\n" + canonicalUri + "\n" + canoni
calQueryString + "\n"+ canonicalHeaders + "\n" + signedHeaders + "\n" + hashedRequestPayload;cout << canonicalRequest << endl;
cout << "-----------------------" << endl;// ************* Step 2: Concatenate the string to sign *************
string algorithm = "TC3-HMAC-SHA256";
string RequestTimestamp = int2str(timestamp);
string credentialScope = date + "/" + service + "/" + "tc3_request";
string hashedCanonicalRequest = sha256Hex(canonicalRequest);
string stringToSign = algorithm + "\n" + RequestTimestamp + "\n" + credentialScop
e + "\n" + hashedCanonicalRequest;
cout << stringToSign << endl;
cout << "-----------------------" << endl;// ************* Step 3: Calculate the signature ***************
string kKey = "TC3" + SECRET_KEY;
string kDate = HmacSha256(kKey, date);
string kService = HmacSha256(kDate, service);
string kSigning = HmacSha256(kService, "tc3_request");©2013-2022 Tencent Cloud. All rights reserved.

Page 69 of 500

TencentDB for Redis

string signature = HexEncode(HmacSha256(kSigning, stringToSign));cout << signature << endl;
cout << "-----------------------" << endl;// ************* Step 4: Concatenate the Authorization *************
string authorization = algorithm + " " + "Credential=" + SECRET_ID + "/" + creden
tialScope + ", "+ "SignedHeaders=" + signedHeaders + ", " + "Signature=" + signature;cout << authorization << endl;
cout << "------------------------" << endl;
string headers = "curl -X POST https://" + host + "\n"+ " -H \"Authorization: " + authorization + "\n"+ " -H \"Content-Type: application/json; charset=utf-8\"" + "\n"+ " -H \"Host: " + host + "\n"+ " -H \"X-TC-Action: " + action + "\n"+ " -H \"X-TC-Timestamp: " + RequestTimestamp + "\n"+ " -H \"X-TC-Version: " + version + "\n"+ " -H \"X-TC-Region: " + region + "\n"+ " -d '" + payload;cout << headers << endl;
return 0;};

Signature Failure
The following situational error codes for signature failure may occur. Please resolve the errors accordingly.
Error CodeDescription

AuthFailure.SignatureExpire

Signature expired. Timestamp and server time cannot differ by more than fiveminutes.

AuthFailure.SecretIdNotFoundThe key does not exist. Please go to the console to check whether it isdisabled or you copied fewer or more characters.

AuthFailure.SignatureFailure

Signature error. It is possible that the signature was calculated incorrectly, thesignature does not match the content actually sent, or the SecretKey isincorrect.

AuthFailure.TokenFailure

Temporary certificate token error.

AuthFailure.InvalidSecretId

Invalid key (not a TencentCloud API key type).

©2013-2022 Tencent Cloud. All rights reserved.

Page 70 of 500

TencentDB for Redis

Signature：

Last updated 2024-04-03 11:32:35
Tencent Cloud API authenticates each access request, i.e. each request needs to include authentication information(Signature) in the common parameters to verify the identity of the requester.
The Signature is generated by the security credentials which include SecretId and SecretKey. If you don't have thesecurity credentials yet, go to the TencentCloud API Key page to apply for them; otherwise, you cannot invoke theTencentCloud API.

1. Applying for Security Credentials
Before using the TencentCloud API for the first time, go to the TencentCloud API Key page to apply for security
credentials.
Security credentials consist of SecretId and SecretKey:
SecretId is used to identify the API requester.
SecretKey is used to encrypt the signature string and verify it on the server.
You must keep your security credentials private and avoid disclosure.
You can apply for the security credentials through the following steps:
1. Log in to the Tencent Cloud Console.
2. Go to the TencentCloud API Key page.
3. On the API Key Management page, click Create Key to create a SecretId/SecretKey pair.
Note: Each account can have up to two pairs of SecretId/SecretKey.

2. Generating a SignatureWith the SecretId and SecretKey, a signature can be generated. The following describes how to generate a signature:
Assume that the SecretId and SecretKey are:SecretId: AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******
SecretKey: Gu5t9xGARNpq86cd98joQYCN3*******
Note: This is just an example. For actual operations, please use your own SecretId and SecretKey.

©2013-2022 Tencent Cloud. All rights reserved.

Page 71 of 500

TencentDB for RedisTake the Cloud Virtual Machine's request to view the instance list (DescribeInstances) as an example. When you
invoke this API, the request parameters may be as follows:
Parameter
nameDescription

Parameter value

Action

Method name

DescribeInstances

SecretId

Key ID

AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******

Timestamp

Current timestamp

1465185768

Nonce

Random positive integer

11886

RegionRegion where the instance islocatedap-guangzhou

InstanceIds.0

ID of the instance to query

ins-09dx96dg

OffsetOffset0

Limit

Allowed maximum output

20

VersionAPI version number

2017-03-12

2.1. Sorting Parameters
First, sort all the request parameters in an ascending lexicographical order (ASCII code) by their names. Notes: (1)Parameters are sorted by their names instead of their values; (2) The parameters are sorted based on ASCII code, notin an alphabetical order or by values. For example, InstanceIds.2 should be arranged after InstanceIds.12. You cancomplete the sorting process using a sorting function in a programming language, such as the ksort function in PHP.
The parameters in the example are sorted as follows:{'Action' : 'DescribeInstances','InstanceIds.0' : 'ins-09dx96dg','Limit' : 20,'Nonce' : 11886,'Offset' : 0,
'Region' : 'ap-guangzhou','SecretId' : 'AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******','Timestamp' : 1465185768,'Version': '2017-03-12',}©2013-2022 Tencent Cloud. All rights reserved.

Page 72 of 500

TencentDB for Redis

When developing in another programming language, you can sort these sample parameters and it will work as long as
you obtain the same results.

2.2. Concatenating a Request String
This step generates a request string.
Format the request parameters sorted in the previous step into the form of "parameter name"="parameter value". For
example, for the Action parameter, its parameter name is "Action" and its parameter value is "DescribeInstances", so it
will become Action=DescribeInstances after formatted.
Note: The "parameter value" is the original value but not the value after URL encoding.
Then, concatenate the formatted parameters with "&". The resulting request string is as follows:

Action=DescribeInstances&InstanceIds.0=ins-09dx96dg&Limit=20&Nonce=11886&Offset=0&Region=ap-guangzhou&SecretId=AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******&Timestamp=1465
185768&Version=2017-03-12

2.3. Concatenating the Signature Original String
This step generates a signature original string.
The signature original string consists of the following parameters:
1. HTTP method: POST and GET modes are supported, and GET is used here for the request. Please note that themethod name should be in all capital letters.
2. Request server: the domain name of the request to view the list of instances (DescribeInstances) is
cvm.tencentcloudapi.com. The actual request domain name varies by the module to which the API belongs. For
more information, see the instructions of the specific API.
3. Request path: The request path in the current version of TencentCloud API is fixed to /.
4. Request string: the request string generated in the previous step.
The concatenation rule of the signature original string is: Request method + request host + request path + ? + request
string
The concatenation result of the example is:

GETcvm.tencentcloudapi.com/?Action=DescribeInstances&InstanceIds.0=ins-09dx96dg&L
imit=20&Nonce=11886&Offset=0&Region=ap-guangzhou&SecretId=AKIDz8krbsJ5yKBZQpn74WF
kmLPx3*******&Timestamp=1465185768&Version=2017-03-12

2.4. Generating a Signature String
This step generates a signature string.
First, use the HMAC-SHA1 algorithm to sign the signature original string obtained in the previous step, and then©2013-2022 Tencent Cloud. All rights reserved.

Page 73 of 500

TencentDB for Redis

encode the generated signature using Base64 to obtain the final signature.
The specific code is as follows with the PHP language being used as an example:$secretKey = 'Gu5t9xGARNpq86cd98joQYCN3*******';$srcStr = 'GETcvm.tencentcloudapi.com/?Action=DescribeInstances&InstanceIds.0=ins-09dx96dg&Limit=20&Nonce=11886&Offset=0&Region=ap-guangzhou&SecretId=AKIDz8krbsJ5
yKBZQpn74WFkmLPx3*******&Timestamp=1465185768&Version=2017-03-12';$signStr = base64_encode(hash_hmac('sha1', $srcStr, $secretKey, true));echo $signStr;
The final signature is:zmmjn35mikh6pM3V7sUEuX4wyYM=
When developing in another programming language, you can sign and verify the original in the example above and it
works as long as you get the same results.

3. Encoding a Signature String
The generated signature string cannot be directly used as a request parameter and must be URL encoded.
For example, if the signature string generated in the previous step is zmmjn35mikh6pM3V7sUEuX4wyYM=, the final
signature string request parameter (Signature) is zmmjn35mikh6pM3V7sUEuX4wyYM%3D, which will be used togenerate the final request URL.
Note: If your request method is GET, or the request method is POST and the Content-Type isapplication/x-www-form-urlencoded, then all the request parameter values need to be URL encoded(except the parameter key and the symbol of =) when sending the request. Non-ASCII characters need to
be encoded with UTF-8 before URL encoding.
Note: The network libraries of some programming languages automatically URL encode all parameters, inwhich case there is no need to URL encode the signature string; otherwise, two rounds of URL encoding
will cause the signature to fail.
Note: Other parameter values also need to be encoded using RFC 3986. Use %XY in percent-encoding forspecial characters such as Chinese characters, where "X" and "Y" are hexadecimal characters (0-9 anduppercase A-F), and using lowercase will cause an error.

4. Signature Failure©2013-2022 Tencent Cloud. All rights reserved.

Page 74 of 500

TencentDB for Redis

The following situational error codes for signature failure may occur. Please resolve the errors accordingly.
Error code

Error description

AuthFailure.SignatureExpire

The signature is expired

AuthFailure.SecretIdNotFoundThe key does not exist

AuthFailure.SignatureFailure

Signature error

AuthFailure.TokenFailure

Token error

AuthFailure.InvalidSecretId

Invalid key (not a TencentCloud API key type)

5. Signature Demo
When calling API 3.0, you are recommended to use the corresponding Tencent Cloud SDK 3.0 which encapsulates
the signature process, enabling you to focus on only the specific APIs provided by the product when developing. See
SDK Center for more information. Currently, the following programming languages are supported:
PythonJava
PHP
Go
NodeJS.NET
To further explain the signing process, we will use a programming language to implement the process describedabove. The request domain name, API and parameter values in the sample are used here. This goal of this example isonly to provide additional clarification for the signature process, please see the SDK for actual usage.
The final output URL might be: https://cvm.tencentcloudapi.com/?
Action=DescribeInstances&InstanceIds.0=ins09dx96dg&Limit=20&Nonce=11886&Offset=0&Region=apguangzhou&SecretId=AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******&Signature=zmmjn35mikh6pM3V7s
UEuX4wyYM%3D&Timestamp=1465185768&Version=2017-03-12 .
Note: The key in the example is fictitious, and the timestamp is not the current time of the system, so if this URL is
opened in the browser or called using commands such as curl, an authentication error will be returned: Signature
expired. In order to get a URL that can work properly, you need to replace the SecretId and SecretKey in the example
with your real credentials and use the current time of the system as the Timestamp.

©2013-2022 Tencent Cloud. All rights reserved.

Page 75 of 500

TencentDB for Redis

Note: In the example below, even if you use the same programming language, the order of the parameters in the URL
may be different for each execution. However, the order does not matter, as long as all the parameters are included in
the URL and the signature is calculated correctly.
Note: The following code is only applicable to API 3.0. It cannot be directly used in other signature processes. Even
with an older API, signature calculation errors may occur due to the differences in details. Please refer to thecorresponding documentation.

Java
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;import java.util.Random;
import java.util.TreeMap;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import javax.xml.bind.DatatypeConverter;
public class TencentCloudAPIDemo {private final static String CHARSET = "UTF-8";
public static String sign(String s, String key, String method) throws Exception {Mac mac = Mac.getInstance(method);
SecretKeySpec secretKeySpec = new SecretKeySpec(key.getBytes(CHARSET), mac.getAlg
orithm());
mac.init(secretKeySpec);
byte[] hash = mac.doFinal(s.getBytes(CHARSET));
return DatatypeConverter.printBase64Binary(hash);}public static String getStringToSign(TreeMap<String, Object> params) {StringBuilder s2s = new StringBuilder("GETcvm.tencentcloudapi.com/?");// When signing, the parameters need to be sorted in lexicographical order. TreeM
ap is used here to guarantee the correct order.
for (String k : params.keySet()) {s2s.append(k).append("=").append(params.get(k).toString()).append("&");}
return s2s.toString().substring(0, s2s.length() - 1);}
public static String getUrl(TreeMap<String, Object> params) throws UnsupportedEnc
odingException {StringBuilder url = new StringBuilder("https://cvm.tencentcloudapi.com/?");// There is no requirement for the order of the parameters in the actual request
URL.
for (String k : params.keySet()) {©2013-2022 Tencent Cloud. All rights reserved.

Page 76 of 500

TencentDB for Redis// The request string needs to be URL encoded. As the Key is all in English letters, only the value is URL encoded here.
url.append(k).append("=").append(URLEncoder.encode(params.get(k).toString(), CHAR
SET)).append("&");}
return url.toString().substring(0, url.length() - 1);}
public static void main(String[] args) throws Exception {TreeMap<String, Object> params = new TreeMap<String, Object>(); // TreeMap enable
s automatic sorting// A random number should be used when actually calling, for example: params.put("Nonce", new Random().nextInt(java.lang.Integer.MAX_VALUE));params.put("Nonce", 11886); // Common parameter// The current time of the system should be used when actually calling, for examp
le: params.put("Timestamp", System.currentTimeMillis() / 1000);params.put("Timestamp", 1465185768); // Common parameterparams.put("SecretId", "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"); // Common parameterparams.put("Action", "DescribeInstances"); // Common parameterparams.put("Version", "2017-03-12"); // Common parameterparams.put("Region", "ap-guangzhou"); // Common parameterparams.put("Limit", 20); // Business parameterparams.put("Offset", 0); // Business parameterparams.put("InstanceIds.0", "ins-09dx96dg"); // Business parameterparams.put("Signature", sign(getStringToSign(params), "Gu5t9xGARNpq86cd98joQYCN3*******", "HmacSHA1")); // Common parameter
System.out.println(getUrl(params));}}

PythonNote: If running in a Python 2 environment, the following requests dependency package must be installed first: pip
install requests .

# -*- coding: utf8 -*import base64
import hashlib
import hmac
import time
import requests
secret_id = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"
secret_key = "Gu5t9xGARNpq86cd98joQYCN3*******"©2013-2022 Tencent Cloud. All rights reserved.

Page 77 of 500

TencentDB for Redis

def get_string_to_sign(method, endpoint, params):
s = method + endpoint + "/?"
query_str = "&".join("%s=%s" % (k, params[k]) for k in sorted(params))
return s + query_str
def sign_str(key, s, method):
hmac_str = hmac.new(key.encode("utf8"), s.encode("utf8"), method).digest()
return base64.b64encode(hmac_str)
if __name__ == '__main__':endpoint = "cvm.tencentcloudapi.com"
data = {'Action' : 'DescribeInstances','InstanceIds.0' : 'ins-09dx96dg','Limit' : 20,'Nonce' : 11886,'Offset' : 0,
'Region' : 'ap-guangzhou','SecretId' : secret_id,'Timestamp' : 1465185768, # int(time.time())'Version': '2017-03-12'}
s = get_string_to_sign("GET", endpoint, data)
data["Signature"] = sign_str(secret_key, s, hashlib.sha1)
print(data["Signature"])# An actual invocation would occur here, which may incur fees after success# resp = requests.get("https://" + endpoint, params=data)# print(resp.url)

Golangpackage main
import ("bytes""crypto/hmac""crypto/sha1""encoding/base64""fmt""sort")
func main() {secretId := "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"
secretKey := "Gu5t9xGARNpq86cd98joQYCN3*******"©2013-2022 Tencent Cloud. All rights reserved.

Page 78 of 500

TencentDB for Redis

params := map[string]string{"Nonce": "11886","Timestamp": "1465185768","Region": "ap-guangzhou","SecretId": secretId,"Version": "2017-03-12","Action": "DescribeInstances","InstanceIds.0": "ins-09dx96dg","Limit": "20","Offset": "0",}var buf bytes.Buffer
buf.WriteString("GET")
buf.WriteString("cvm.tencentcloudapi.com")buf.WriteString("/")
buf.WriteString("?")// sort keys by ascii asc orderkeys := make([]string, 0, len(params))
for k, _ := range params {keys = append(keys, k)}sort.Strings(keys)
for i := range keys {k := keys[i]buf.WriteString(k)buf.WriteString("=")
buf.WriteString(params[k])buf.WriteString("&")}
buf.Truncate(buf.Len() - 1)hashed := hmac.New(sha1.New, []byte(secretKey))hashed.Write(buf.Bytes())
fmt.Println(base64.StdEncoding.EncodeToString(hashed.Sum(nil)))
}

PHP
<?php
$secretId = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******";$secretKey = "Gu5t9xGARNpq86cd98joQYCN3*******";$param["Nonce"] = 11886;//rand();©2013-2022 Tencent Cloud. All rights reserved.

Page 79 of 500

TencentDB for Redis$param["Timestamp"] = 1465185768;//time();$param["Region"] = "ap-guangzhou";$param["SecretId"] = $secretId;$param["Version"] = "2017-03-12";$param["Action"] = "DescribeInstances";$param["InstanceIds.0"] = "ins-09dx96dg";$param["Limit"] = 20;$param["Offset"] = 0;
ksort($param);$signStr = "GETcvm.tencentcloudapi.com/?";foreach ( $param as $key => $value ) {$signStr = $signStr . $key . "=" . $value . "&";}
$signStr = substr($signStr, 0, -1);
$signature = base64_encode(hash_hmac("sha1", $signStr, $secretKey, true));echo $signature.PHP_EOL;// need to install and enable curl extension in php.ini// $param["Signature"] = $signature;// $url = "https://cvm.tencentcloudapi.com/?".http_build_query($param);// echo $url.PHP_EOL;// $ch = curl_init();// curl_setopt($ch, CURLOPT_URL, $url);// $output = curl_exec($ch);// curl_close($ch);// echo json_decode($output);Ruby# -*- coding: UTF-8 -*# require ruby>=2.3.0
require 'time'require 'openssl'
require 'base64'
secret_id = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"
secret_key = "Gu5t9xGARNpq86cd98joQYCN3*******"
method = 'GET'
endpoint = 'cvm.tencentcloudapi.com'
data = {'Action' => 'DescribeInstances','InstanceIds.0' => 'ins-09dx96dg','Limit' => 20,©2013-2022 Tencent Cloud. All rights reserved.

Page 80 of 500

TencentDB for Redis'Nonce' => 11886,'Offset' => 0,'Region' => 'ap-guangzhou','SecretId' => secret_id,'Timestamp' => 1465185768, # Time.now.to_i'Version' => '2017-03-12',}
sign = method + endpoint + '/?'
params = []data.sort.each do |item|
params << "#{item[0]}=#{item[1]}"endsign += params.join('&')
digest = OpenSSL::Digest.new('sha1')
data['Signature'] = Base64.encode64(OpenSSL::HMAC.digest(digest, secret_key, sign))puts data['Signature']# require 'net/http'# uri = URI('https://' + endpoint)# uri.query = URI.encode_www_form(data)# p uri# res = Net::HTTP.get_response(uri)# puts res.body

DotNetusing System;
using System.Collections.Generic;using System.Net;
using System.Security.Cryptography;
using System.Text;
public class Application {public static string Sign(string signKey, string secret){string signRet = string.Empty;
using (HMACSHA1 mac = new HMACSHA1(Encoding.UTF8.GetBytes(signKey))){byte[] hash = mac.ComputeHash(Encoding.UTF8.GetBytes(secret));signRet = Convert.ToBase64String(hash);}return signRet;}
public static string MakeSignPlainText(SortedDictionary<string, string> requestParams, string requestMethod, string requestHost, string requestPath)©2013-2022 Tencent Cloud. All rights reserved.

Page 81 of 500

TencentDB for Redis{
string retStr = "";retStr += requestMethod;
retStr += requestHost;
retStr += requestPath;
retStr += "?";
string v = "";foreach (string key in requestParams.Keys){v += string.Format("{0}={1}&", key, requestParams[key]);}
retStr += v.TrimEnd('&');
return retStr;}
public static void Main(string[] args){
string SECRET_ID = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******";
string SECRET_KEY = "Gu5t9xGARNpq86cd98joQYCN3*******";
string endpoint = "cvm.tencentcloudapi.com";string region = "ap-guangzhou";string action = "DescribeInstances";
string version = "2017-03-12";
double RequestTimestamp = 1465185768;// long timestamp = ToTimestamp() / 1000;// string requestTimestamp = timestamp.ToString();
Dictionary<string, string> param = new Dictionary<string, string>();param.Add("Limit", "20");param.Add("Offset", "0");param.Add("InstanceIds.0", "ins-09dx96dg");
param.Add("Action", action);param.Add("Nonce", "11886");// param.Add("Nonce", Math.Abs(new Random().Next()).ToString());
param.Add("Timestamp", RequestTimestamp.ToString());
param.Add("Version", version);param.Add("SecretId", SECRET_ID);
param.Add("Region", region);
SortedDictionary<string, string> headers = new SortedDictionary<string, string>(param, StringComparer.Ordinal);
string sigInParam = MakeSignPlainText(headers, "GET", endpoint, "/");
Console.WriteLine(sigInParam);
string sigOutParam = Sign(SECRET_KEY, sigInParam);©2013-2022 Tencent Cloud. All rights reserved.

Page 82 of 500

TencentDB for Redis

Console.WriteLine("GET https://cvm.tencentcloudapi.com");foreach (KeyValuePair<string, string> kv in headers){Console.WriteLine(kv.Key + ": " + kv.Value);}
Console.WriteLine("Signature" + ": " + WebUtility.UrlEncode(sigOutParam));
Console.WriteLine();string result = "https://cvm.tencentcloudapi.com/?";foreach (KeyValuePair<string, string> kv in headers){
result += WebUtility.UrlEncode(kv.Key) + "=" + WebUtility.UrlEncode(kv.Value) +"&";}result += WebUtility.UrlEncode("Signature") + "=" + WebUtility.UrlEncode(sigOutPa
ram);
Console.WriteLine("GET " + result);}}

NodeJS
const crypto = require('crypto');function get_req_url(params, endpoint){
params['Signature'] = escape(params['Signature']);const url_strParam = sort_params(params)
return "https://" + endpoint + "/?" + url_strParam.slice(1);}function formatSignString(reqMethod, endpoint, path, strParam){
let strSign = reqMethod + endpoint + path + "?" + strParam.slice(1);return strSign;}function sha1(secretKey, strsign){
let signMethodMap = {'HmacSHA1': "sha1"};
let hmac = crypto.createHmac(signMethodMap['HmacSHA1'], secretKey || "");
return hmac.update(Buffer.from(strsign, 'utf8')).digest('base64')}function sort_params(params){
let strParam = "";let keys = Object.keys(params);
keys.sort();for (let k in keys) {//k = k.replace(/_/g, '.');©2013-2022 Tencent Cloud. All rights reserved.

Page 83 of 500

TencentDB for Redis

strParam += ("&" + keys[k] + "=" + params[keys[k]]);}return strParam}function main(){const SECRET_ID = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"
const SECRET_KEY = "Gu5t9xGARNpq86cd98joQYCN3*******"
const endpoint = "cvm.tencentcloudapi.com"
const Region = "ap-guangzhou"
const Version = "2017-03-12"
const Action = "DescribeInstances"
const Timestamp = 1465185768// const Timestamp = Math.round(Date.now() / 1000)
const Nonce = 11886//const nonce = Math.round(Math.random() * 65535)
let params = {};params['Action'] = Action;
params['InstanceIds.0'] = 'ins-09dx96dg';
params['Limit'] = 20;
params['Offset'] = 0;params['Nonce'] = Nonce;params['Region'] = Region;
params['SecretId'] = SECRET_ID;
params['Timestamp'] = Timestamp;
params['Version'] = Version;
strParam = sort_params(params)
const reqMethod = "GET";
const path = "/";
strSign = formatSignString(reqMethod, endpoint, path, strParam)
console.log(strSign)
console.log("-----------------------")
params['Signature'] = sha1(SECRET_KEY, strSign)
console.log(params['Signature'])console.log("-----------------------")
const req_url = get_req_url(params, endpoint)
console.log(params['Signature'])console.log("-----------------------")
console.log(req_url)}
main()©2013-2022 Tencent Cloud. All rights reserved.

Page 84 of 500

TencentDB for Redis©2013-2022 Tencent Cloud. All rights reserved.

Page 85 of 500

TencentDB for Redis

Responses：

Last updated 2024-04-03 11:32:36

Response for Successful Requests
For example, when calling CAM API (version: 2017-03-12) to view the status of instances (DescribeInstancesStatus),
if the request has succeeded, you may see the response as shown below:{"Response": {"TotalCount": 0,"InstanceStatusSet": [],"RequestId": "b5b41468-520d-4192-b42f-595cc34b6c1c"}}
The API will return Response , which contains RequestId , as long as it processes the request. It does notmatter if the request is successful or not.
RequestId is the unique ID of an API request. Contact us with this ID when an exception occurs.
Except for the fixed fields, all fields are action-specified. For the definitions of action-specified fields, see thecorresponding API documentation. In this example, TotalCount and InstanceStatusSet are the fields
specified by the API DescribeInstancesStatus . 0 TotalCount means that the requester owns 0 CVM
instance so the InstanceStatusSet is empty.

Response for Failed Requests
If the request has failed, you may see the response as shown below:{"Response": {"Error": {"Code": "AuthFailure.SignatureFailure","Message": "The provided credentials could not be validated. Please ensure your signature is correct."},"RequestId": "ed93f3cb-f35e-473f-b9f3-0d451b8b79c6"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 86 of 500

TencentDB for Redis

The presence of the Error field indicates that the request has failed. A response for a failed request will include
Error , Code and Message fields.
Code is the code of the error that helps you identify the cause and solution. There are two types of error codes
so you may find the code in either common error codes or API-specified error codes.
Message explains the cause of the error. Note that the returned messages are subject to service updates. The
information the messages provide may not be up-to-date and should not be the only source of reference.
RequestId is the unique ID of an API request. Contact us with this ID when an exception occurs.

Common Error Codes
If there is an Error field in the response, it means that the API call failed. The Code field in Error indicates the error
code. The following table lists the common error codes that all actions can return.
Error CodeDescription

AuthFailure.InvalidSecretId

Invalid key (not a TencentCloud API key type).

AuthFailure.MFAFailure

MFA failed.

AuthFailure.SecretIdNotFoundThe key does not exist.

AuthFailure.SignatureExpire

Signature expired.

AuthFailure.SignatureFailure

Signature error.

AuthFailure.TokenFailure

Token error.

AuthFailure.UnauthorizedOperation

The request does not have CAM authorization.

DryRunOperation

DryRun Operation. It means that the request would have succeeded, but
the DryRun parameter was used.

FailedOperation

Operation failed.

InternalError

Internal error.

InvalidAction

The API does not exist.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Invalid parameter value.

LimitExceeded

Quota limit exceeded.

MissingParameter

A parameter is missing.

©2013-2022 Tencent Cloud. All rights reserved.

Page 87 of 500

TencentDB for Redis

NoSuchVersion

The API version does not exist.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

Resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceUnavailable

Resource is unavailable.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

UnsupportedProtocol

HTTPS request method error. Only GET and POST requests aresupported.

UnsupportedRegion

API does not support the requested region.

©2013-2022 Tencent Cloud. All rights reserved.

Page 88 of 500

TencentDB for Redis

Instance APIs
AddReplicationInstance：

Last updated 2024-04-15 11:09:00

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to add replication group members.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
AddReplicationInstance.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

GroupId

Yes

StringReplication group ID.

InstanceId

Yes

String

Instance ID.

InstanceRole

Yes

String©2013-2022 Tencent Cloud. All rights reserved.

Assigns roles to instances added to the replication group.
rw: read-write;
r: read-only.

Page 89 of 500

TencentDB for Redis

3. Output Parameters
Parameter
Name

Type

Description

TaskIdInteger

Asynchronous process ID.

String

The unique request ID, generated by the server, will be returned for every request (ifthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

RequestId

4. Example
Example1 Request Sample
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddReplicationInstance<Common request parameters>{"InstanceId": "crs-sa5dsfs","InstanceRole": "rw","GroupId": "crs-rpl-sa5dsfs"}

Output Example{"Response": {"RequestId": "c4ed5948-d156-4931-b9c3-10133a0bb6c9","TaskId": 10856}}

5. Developer Resources©2013-2022 Tencent Cloud. All rights reserved.

Page 90 of 500

TencentDB for Redis

SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

FailedOperation.UnSupportError

The instance does not support this API.

InternalError.DbOperationFailed

Internal system error with the database operation, which
may be update, insert, select, etc.

InvalidParameterValue.CheckNotPass

Business verification failed

InvalidParameterValue.InstanceNameRuleError

A renaming rule error occurred.

InvalidParameterValue.NotRepeatBind

The instance has already been bound.

InvalidParameterValue.ReplicationGroupNotExists

The global replication group doesn’t exist.

InvalidParameterValue.SpecNotExist

The instance specification doesn’t exist.

InvalidParameterValue.UnSupportedType

The instance type is not supported.

LimitExceeded.ExceedUpperLimit

The number of bound instances exceeds the upper limit.

©2013-2022 Tencent Cloud. All rights reserved.

Page 91 of 500

TencentDB for Redis

LimitExceeded.InstanceNotEmpty

The bound instance must not be specified.

LimitExceeded.ReplicationGroupLocked

Replication group locked

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

ResourceUnavailable.InstanceStatusError

Operation unsupported: the instance is exceptional.

UnsupportedOperation.LimitProxyVersion

The instance version is too low.

©2013-2022 Tencent Cloud. All rights reserved.

Page 92 of 500

TencentDB for Redis

AllocateWanAddress：

Last updated 2024-04-03 11:33:33

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to enable public network access.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
AllocateWanAddress.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID.

3. Output Parameters
Parameter
Name

Type

Description

FlowIdInteger

Async task ID©2013-2022 Tencent Cloud. All rights reserved.

Page 93 of 500

TencentDB for Redis

WanStatus

StringStatus of enabling public network access
The unique request ID, generated by the server, will be returned for every request (ifRequestId

Stringthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Enabling public network instance
Input Example
https://redis.tencentcloudapi.com/?Action=AllocateWanAddress&InstanceId=crs-5qlrlhux&<Common request parameters>

Output Example{"Response": {"FlowId": 327,
"WanStatus": “Enabling public network access”,"RequestId": "e546784b-709c-401d-aba6-73037eb4e522"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++©2013-2022 Tencent Cloud. All rights reserved.

Page 94 of 500

TencentDB for Redis

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

FailedOperation.UnSupportError

The instance does not support this API.

FailedOperation.Unknown

Invalid data is entered for weekday.

InvalidParameter.IsNotVpcInstance

The instance is not in a VPC.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

ResourceUnavailable.InstanceUnLockedError

The instance has been locked by another process.

©2013-2022 Tencent Cloud. All rights reserved.

Page 95 of 500

TencentDB for Redis

ChangeInstanceRole：

Last updated 2024-04-03 11:33:32

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to modify the role of an instance in a replication group.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

GroupId

Yes

StringReplication group ID

InstanceId

Yes

String

Instance ID

InstanceRole

Yes

String

Instance role. Valid values: rw (read-write), r ( read-only).

Description
Common Params. The value used for this API:
ChangeInstanceRole.

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 96 of 500

TencentDB for Redis

Parameter

Type

Description

TaskIdInteger

Async task ID

RequestId

StringName

The unique request ID, generated by the server, will be returned for every request (ifthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Modifying the role of instance in a replication group
Input Example
https://redis.tencentcloudapi.com/?Action=ChangeInstanceRole&GroupId=crs-rpl-267khx71&InstanceId=crs-5qlrlhux&InstanceRole=rw&<Common request parameters>

Output Example{"Response": {"TaskId": 327,
"RequestId": "e546784b-709c-401d-aba6-73037eb4e522"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go©2013-2022 Tencent Cloud. All rights reserved.

Page 97 of 500

TencentDB for Redis

Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

FailedOperation.UnSupportError

The instance does not support this API.

InternalError.DbOperationFailed

Internal system error with the database operation, which
may be update, insert, select, etc.

InvalidParameterValue.CheckNotPass

Business verification failed

InvalidParameterValue.ReplicationGroupNotExists

The global replication group doesn’t exist.

LimitExceeded.ReplicationGroupLocked

Replication group locked

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

ResourceUnavailable.InstanceStatusError

Operation unsupported: the instance is exceptional.

UnsupportedOperation.Inspection

Inspecting replication group

UnsupportedOperation.InstanceNotOperation

Unsupported operation©2013-2022 Tencent Cloud. All rights reserved.

Page 98 of 500

TencentDB for Redis

ChangeMasterInstance：

Last updated 2024-04-03 11:33:31

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to set a read-only instance in a replication group as a master instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

Description
Common Params. The value used for this API:
ChangeMasterInstance.

Replication group ID, such as crs-rpl-m3zt**** . It is theGroupId

Yes

String

InstanceId

Yes

StringForceSwitch

No

Boolean©2013-2022 Tencent Cloud. All rights reserved.

unique identifier automatically assigned by the system when creatinga replication group. Log in to the TencentDB for Redis console, andget it in the global replication list.
ID of the read-only instance to be promoted to the master instance,such as crs-xjhsdj**** . Log in to the the TencentDB for Redis
console, and copy it in the instance list.

Whether to promote the read-only instance to the master instance

Page 99 of 500

TencentDB for Redis

forcibly. Valid values:- true : Yes- false : No

3. Output Parameters
Parameter
Name
TaskIdType

Description

Integer

Async task ID
The unique request ID, generated by the server, will be returned for every request (ifRequestId

Stringthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
This example shows you how to set a read-only instance in a replication group as a master instance.
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChangeMasterInstance<Common request parameters>{"InstanceId": "crs-sa5****","GroupId": "crs-rpl-sa5****","ForceSwitch": false}

Output Example{"Response": {"TaskId": 327,
"RequestId": "e546784b-709c-401d-aba6-73037eb4e522"©2013-2022 Tencent Cloud. All rights reserved.

Page 100 of 500

TencentDB for Redis}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

FailedOperation.UnSupportError

The instance does not support this API.

InternalError.DbOperationFailed

Internal system error with the database operation, which
may be update, insert, select, etc.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

InvalidParameterValue.CheckNotPass

Business verification failed

InvalidParameterValue.ReplicationGroupNotExists

The global replication group doesn’t exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 101 of 500

TencentDB for Redis

LimitExceeded.ReplicationGroupLocked

Replication group locked

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

ResourceUnavailable.InstanceStatusError

Operation unsupported: the instance is exceptional.

UnsupportedOperation.Inspection

Inspecting replication group

UnsupportedOperation.InstanceNotOperation

Unsupported operation©2013-2022 Tencent Cloud. All rights reserved.

Page 102 of 500

TencentDB for Redis

CleanUpInstance：

Last updated 2024-04-03 11:33:30

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to eliminate an instance in the recycle bin immediately.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: CleanUpInstance.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID

3. Output Parameters
Parameter

Type

Description

TaskIdInteger

Task ID

RequestId

String

The unique request ID, generated by the server, will be returned for every request (ifName©2013-2022 Tencent Cloud. All rights reserved.

Page 103 of 500

TencentDB for Redisthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
Input Example
https://redis.tencentcloudapi.com/?Action=CleanUpInstance&InstanceId=crs-5a4py64p&<Common request parameters>

Output Example{"Response": {"RequestId": "c4ed5948-d156-4931-b9c3-10133a0bb6c9","TaskId": 10856}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0©2013-2022 Tencent Cloud. All rights reserved.

Page 104 of 500

TencentDB for Redis

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InternalError.InternalError

Internal error.

InvalidParameter.EmptyParam

The parameter is empty.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

ResourceUnavailable.InstanceStatusAbnormal

The Redis status is exceptional, and the corresponding
process cannot be executed.

©2013-2022 Tencent Cloud. All rights reserved.

Page 105 of 500

TencentDB for Redis

ClearInstance：

Last updated 2024-04-03 11:33:29

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to clear the data of a Redis instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: ClearInstance.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID

Password

No

StringName

Redis instance password (this parameter is required for passwordenabled instances but not for password-free instances)

3. Output Parameters
Parameter
Name

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 106 of 500

TencentDB for Redis

TaskIdInteger

Task ID
The unique request ID, generated by the server, will be returned for every request (ifRequestId

Stringthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
Input Example
https://redis.tencentcloudapi.com/?Action=ClearInstance&InstanceId=crs-5a4py64p&Password=zy456987&<Common request parameters>

Output Example{"Response": {"TaskId": 16658,"RequestId": "d893c0ac-db57-4e5c-8335-e787b77403b2"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++©2013-2022 Tencent Cloud. All rights reserved.

Page 107 of 500

TencentDB for Redis

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InvalidParameter.InvalidParameter

Invalid service parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

InvalidParameterValue.PasswordEmpty

The password is empty.

InvalidParameterValue.PasswordError

Password verification error due to incorrect password.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

©2013-2022 Tencent Cloud. All rights reserved.

Page 108 of 500

TencentDB for Redis

CloseSSL：

Last updated 2024-04-03 11:33:28

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to disable SSL.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: CloseSSL.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID

3. Output Parameters
Parameter

Type

Description

TaskIdInteger

Task ID

RequestId

String

The unique request ID, generated by the server, will be returned for every request (ifName©2013-2022 Tencent Cloud. All rights reserved.

Page 109 of 500

TencentDB for Redisthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Disabling SSL request
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CloseSSL<Common request parameters>{"InstanceId": "crs-2btr****"}

Output Example{"Response": {"TaskId": 329,
"RequestId": "e546784b-709c-401d-aba6-73037eb4e522"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js©2013-2022 Tencent Cloud. All rights reserved.

Page 110 of 500

TencentDB for Redis

Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

InvalidParameterValue.UnSupportedType

The instance type is not supported.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

ResourceUnavailable.InstanceStatusError

Operation unsupported: the instance is exceptional.

UnsupportedOperation.InstanceNotOperation

Unsupported operation

UnsupportedOperation.LimitProxyVersion

The instance version is too low.

©2013-2022 Tencent Cloud. All rights reserved.

Page 111 of 500

TencentDB for Redis

CreateInstanceAccount：

Last updated 2024-04-03 11:33:27

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to customize the account for accessing the instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID.

StringCustom the name of the database to access.
- Contains only letters, digits, underscores, and hyphens.

AccountName

Yes

Description
Common Params. The value used for this API:
CreateInstanceAccount.

- The length cannot exceed 32 characters.
AccountPassword

Yes

StringSet a password for the customized account. The password
complexity requirements are as follows:- Value range: [8, 32].
- Contains at least two types of characters from the following
categories: lowercase letters, uppercase letters, digits, andcharacters ()`~!@#$%^&*-+=_|{}[]:;<>,.? /.- Cannot start with "/".

©2013-2022 Tencent Cloud. All rights reserved.

Page 112 of 500

TencentDB for Redis

Array
ReadonlyPolicy.N

Yesof
String

The read requests for the designated account are routed to either
the master node or replica nodes. If the Read-Only Replica is notenabled, the selection of replica nodes is not supported.
- master: Master node.- replication: Replica node.
The read/write permission of the account supports the selection ofPrivilege

Yes

Stringread-only and read/write permissions.
- r: read-only- rw: Read/Write permission.

RemarkNo

StringSub-account description information, with a length of [0, 64] bytes,
supports Chinese characters.

3. Output Parameters
Parameter

Type

Description

TaskIdInteger

Task ID

RequestId

StringName

The unique request ID, generated by the server, will be returned for every request (ifthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample Request
Input Example
https://redis.tencentcloudapi.com/?Action=CreateInstanceAccount&InstanceId=crs-evst****&AccountName=redis_dev&AccountPassword=c1evuh****&ReadonlyPolicy.0=master&Privilege=rw&Remark="Development account"&<Common request parameters>

Output Example©2013-2022 Tencent Cloud. All rights reserved.

Page 113 of 500

TencentDB for Redis{"Response": {"TaskId": 123456,"RequestId": "0e728fa9-c2e5-4bf8-8d6b-c1c4fab7b6db"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

FailedOperation.UnSupportError

The instance does not support this API.

InternalError.InternalError

Internal error.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

©2013-2022 Tencent Cloud. All rights reserved.

Page 114 of 500

TencentDB for Redis

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

UnauthorizedOperation.UserNotInWhiteList

The user is not in the allowlist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 115 of 500

TencentDB for Redis

CreateReplicationGroup：

Last updated 2024-04-15 11:08:59

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to create a replication group.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: CreateReplicationGroup.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

StringSpecifies the ID of the primary instance in the replication group.

StringReplication group name. It supports only Chinese characters, letters,
digits, underscores (_), and hyphens (-), with a length of 2-64

GroupName

No

characters.
RemarkNo

StringRemark information.

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 116 of 500

TencentDB for Redis

Parameter
Name

Type

Description

TaskIdInteger

Asynchronous process ID.

String

The unique request ID, generated by the server, will be returned for every request (ifthe request fails to reach the server for other reasons, the request will not obtain a

RequestId

RequestId). RequestId is required for locating a problem.

4. Example
Example1 Request Sample
This example shows you how to create a replication group.
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateReplicationGroup<Common request parameters>{"InstanceId": "crs-5qlr****","GroupName": "name"}Output Example{"Response": {"TaskId": 327,
"RequestId": "e546784b-709c-401d-aba6-73037eb4e522"}}

5. Developer Resources
SDK©2013-2022 Tencent Cloud. All rights reserved.

Page 117 of 500

TencentDB for Redis

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

FailedOperation.UnSupportError

The instance does not support this API.

InternalError.DbOperationFailed

Internal system error with the database operation, which
may be update, insert, select, etc.

InvalidParameterValue.CheckNotPass

Business verification failed

InvalidParameterValue.InstanceNameRuleError

A renaming rule error occurred.

InvalidParameterValue.NotRepeatBind

The instance has already been bound.

InvalidParameterValue.ReplicationGroupNotExists

The global replication group doesn’t exist.

InvalidParameterValue.SpecNotExist

The instance specification doesn’t exist.

InvalidParameterValue.UnSupportedType

The instance type is not supported.

LimitExceeded.InstanceNotEmpty

The bound instance must not be specified.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

©2013-2022 Tencent Cloud. All rights reserved.

Page 118 of 500

TencentDB for Redis

ResourceUnavailable.InstanceStatusError

Operation unsupported: the instance is exceptional.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

UnsupportedOperation.LimitProxyVersion

The instance version is too low.

©2013-2022 Tencent Cloud. All rights reserved.

Page 119 of 500

TencentDB for Redis

DeleteInstanceAccount：

Last updated 2024-04-03 11:33:26

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to delete an instance sub-account.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID

AccountName

Yes

StringSub-account name

Name

Description
Common Params. The value used for this API:
DeleteInstanceAccount.

3. Output Parameters
Parameter
Name

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 120 of 500

TencentDB for Redis

TaskIdRequestId

Integer

Task ID

String

The unique request ID, generated by the server, will be returned for every request (ifthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
Input Example
https://redis.tencentcloudapi.com/?Action=DeleteInstanceAccount&InstanceId=crs-5a4py64p&AccountName=test&<Common request parameters>

Output Example{"Response": {"TaskId": 123456,"RequestId": "0e728fa9-c2e5-4bf8-8d6b-c1c4fab7b6db"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++©2013-2022 Tencent Cloud. All rights reserved.

Page 121 of 500

TencentDB for Redis

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InternalError.DbOperationFailed

Internal system error with the database operation, which may be
update, insert, select, etc.

InternalError.InternalError

Internal error.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

UnauthorizedOperation.UserNotInWhiteList

The user is not in the allowlist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 122 of 500

TencentDB for Redis

DeleteReplicationInstance：

Last updated 2024-04-15 11:08:58

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to remove replication group members. Note: The API is being deprecated. Please use
RemoveReplicationInstance instead.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

GroupId

Yes

StringReplication group ID.

InstanceId

Yes

String

Instance ID.

BooleanData synchronization type. Valid values: true (Strong synchronization isrequired.) and false (Strong synchronization is not required. This value

Name

SyncType

Yes

Description
Common Params. The value used for this API:
DeleteReplicationInstance.

applies only to primary instance deletion.)©2013-2022 Tencent Cloud. All rights reserved.

Page 123 of 500

TencentDB for Redis

3. Output Parameters
Parameter
Name

Type

Description

TaskIdFloat

Asynchronous task ID.

String

The unique request ID, generated by the server, will be returned for every request (if therequest fails to reach the server for other reasons, the request will not obtain a

RequestId

RequestId). RequestId is required for locating a problem.

4. Example
Example1 Request Sample
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteReplicationInstance<Common request parameters>{"InstanceId": "crs-sa5dsfs","SyncType": true,"GroupId": "crs-rpl-sa5dsfs"}

Output Example{"Response": {"RequestId": "c4ed5948-d156-4931-b9c3-10133a0bb6c9","TaskId": 10856}}

5. Developer Resources©2013-2022 Tencent Cloud. All rights reserved.

Page 124 of 500

TencentDB for Redis

SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InternalError.DbOperationFailed

Internal system error with the database operation, which
may be update, insert, select, etc.

InvalidParameterValue.CheckNotPass

Business verification failed

InvalidParameterValue.ReplicationGroupNotExists

The global replication group doesn’t exist.

LimitExceeded.ReplicationGroupLocked

Replication group locked

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

ResourceUnavailable.InstanceStatusError

Operation unsupported: the instance is exceptional.

UnsupportedOperation.Inspection

Inspecting replication group

UnsupportedOperation.InstanceNotOperation

Unsupported operation©2013-2022 Tencent Cloud. All rights reserved.

Page 125 of 500

TencentDB for Redis

DescribeAutoBackupConfig：

Last updated 2024-04-03 11:33:25

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to get the configuration rules for an automatic backup.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

StringName

Description
Common Params. The value used for this API:
DescribeAutoBackupConfig.

ID of the specified instance, such as "crs-xjhsdj****" Log in to the Redis
console and copy the instance ID in the instance list.

3. Output Parameters
Parameter NameType

Description

AutoBackupType

IntegerThis parameter is retained due to compatibility and can be ignored.

©2013-2022 Tencent Cloud. All rights reserved.

Page 126 of 500

TencentDB for Redis

WeekDays

Array

Backup cycle, which will be daily by default. Valid values: Monday ,ofStringTuesday , Wednesday , Thursday , Friday , Saturday ,TimePeriod

StringTime period for backup task initialization

BackupStorageDays

Integer

BinlogStorageDays

Integer

Sunday .

Retention time of full backup files in days. Default value: 7 . To retain thefiles for more days, submit a ticket for application.
This parameter has been disused.
The unique request ID, generated by the server, will be returned for every

RequestId

Stringrequest (if the request fails to reach the server for other reasons, the request
will not obtain a RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
This example shows you how to query the automatic backup rules for a specified instance.
Input Example
https://redis.tencentcloudapi.com/?Action=DescribeAutoBackupConfig&InstanceId=crs-5a4p****&<Common request parameters>

Output Example{"Response": {"RequestId": "65e950b9-78e8-49b1-9200-0e62a1925559","BackupStorageDays": 7,"BinlogStorageDays": 7,"AutoBackupType": 1,"WeekDays": ["Monday","Tuesday"],"TimePeriod": "01:00-02:00"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 127 of 500

TencentDB for Redis

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InternalError.InternalError

Internal error.

InvalidParameter.InvalidParameter

Invalid service parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

©2013-2022 Tencent Cloud. All rights reserved.

Page 128 of 500

TencentDB for Redis

DescribeBandwidthRange：

Last updated 2024-04-03 11:33:25

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the information of instance bandwidth.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeBandwidthRange.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID

Name

3. Output Parameters
Parameter NameType

BaseBandwidth

Integer

Description
Standard bandwidth, which is the bandwidth allocated by the system to eachnode when an instance is purchased.

©2013-2022 Tencent Cloud. All rights reserved.

Page 129 of 500

TencentDB for Redis

AddBandwidth

Integer

The additional bandwidth of the instance. If the standard bandwidth does notmeet your needs, you can increase the bandwidth on your own.
If read-only replica is enabled, the total instance bandwidth = additional
bandwidth * shard quantity + standard bandwidth * shard quantity * Max([read-only replica quantity, 1]). The shard quantity in the standard
architecture is 1.
If read-only replica is not enabled, the total instance bandwidth = additional
bandwidth * shard quantity + standard bandwidth * shard quantity. The
shard quantity in the standard architecture is 1.

MinAddBandwidth

Integer

The lower limit for additional bandwidth

MaxAddBandwidth

Integer

The upper limit for additional bandwidth

String

The unique request ID, generated by the server, will be returned for every
request (if the request fails to reach the server for other reasons, the request

RequestId

will not obtain a RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBandwidthRange<Common request parameters>{"InstanceId": "crs-sa5****"}

Output Example{"Response": {"MinAddBandwidth": 0,"MaxAddBandwidth": 0,"BaseBandwidth": 0,"AddBandwidth": 0,©2013-2022 Tencent Cloud. All rights reserved.

Page 130 of 500

TencentDB for Redis"RequestId": "xx"}}5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

CAM signature/authentication error.

AuthFailure.InvalidAuthorization

Invalid authorization.

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

FailedOperation.UnSupportError

The instance does not support this API.

InternalError

Internal error.

InvalidParameter.IllegalParameterError

Invalid parameter.

©2013-2022 Tencent Cloud. All rights reserved.

Page 131 of 500

TencentDB for Redis

InvalidParameter.InvalidParameter

Invalid service parameter.

InvalidParameterValue

Incorrect parameter value.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

©2013-2022 Tencent Cloud. All rights reserved.

Page 132 of 500

TencentDB for Redis

DescribeInstanceAccount：

Last updated 2024-04-03 11:33:23

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the information of an instance sub-account.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeInstanceAccount.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

StringID of a specified instance, such as "crs-xjhsdj****" Log in to the Redis
console and copy the instance ID in the instance list.

Limit

Yes

IntegerNumber of entries per page

OffsetYes

Integer

Pagination offset, which is an integral multiple of Limit . Calculation
formula: offset = limit * (page number - 1).

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 133 of 500

TencentDB for Redis

Parameter
Name

Type

Description

Accounts

Array of
Account

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

TotalCount

IntegerNumber of accounts
Note: This field may return null, indicating that no valid values can be obtained.
The unique request ID, generated by the server, will be returned for every request (ifRequestId

Stringthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
This example shows you how to query the account information of a specified instance.
Input Example
https://redis.tencentcloudapi.com/?Action=DescribeInstanceAccount&InstanceId=crs5a4py64p&Limit=10&Offset=0&<Common request parameters>

Output Example{"Response": {"Accounts": [{"AccountName": "root","InstanceId": "crs-mufy7q15","Privilege": "rw","ReadonlyPolicy": ["master","replication"],"Remark": "default","Status": 2}],"RequestId": "b97a9706-dee2-4d5c-8f2d-84873bc79629","TotalCount": 1©2013-2022 Tencent Cloud. All rights reserved.

Page 134 of 500

TencentDB for Redis}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InternalError.InternalError

Internal error.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

UnauthorizedOperation.UserNotInWhiteList

The user is not in the allowlist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 135 of 500

TencentDB for Redis

DescribeInstanceDTSInfo：

Last updated 2024-04-03 11:33:23

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the DTS task details of an instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID

Description
Common Params. The value used for this API:
DescribeInstanceDTSInfo.

3. Output Parameters
Parameter
Name

Type

Description

JobId

String

DTS task ID©2013-2022 Tencent Cloud. All rights reserved.

Page 136 of 500

TencentDB for Redis

Note: This field may return null, indicating that no valid
values can be obtained.
DTS task name
JobNameStringNote: This field may return null, indicating that no valid
values can be obtained.
Task status. Valid values: 1 (Creating), 3 (Checking), 4

StatusInteger(CheckPass), 5 (CheckNotPass), 7 (Running), 8(ReadyComplete), 9 (Success), 10 (Failed), 11(Stopping), 12 (Completing)Note: This field may return null, indicating that no valid
values can be obtained.

StatusDesc

StringStatus description
Note: This field may return null, indicating that no valid
values can be obtained.
Sync latency in bytes

OffsetInteger

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

CutDownTime

StringNote: This field may return null, indicating that no valid
values can be obtained.
Source instance information

SrcInfo

DstInfo

DescribeInstanceDTSInstanceInfo

DescribeInstanceDTSInstanceInfo

Note: This field may return null, indicating that no valid
values can be obtained.
Target instance information
Note: This field may return null, indicating that no valid
values can be obtained.
The unique request ID, generated by the server, will be
returned for every request (if the request fails to reach

RequestId

Stringthe server for other reasons, the request will not obtaina RequestId). RequestId is required for locating aproblem.

4. Example
Example1 Sample request
Input Example©2013-2022 Tencent Cloud. All rights reserved.

Page 137 of 500

TencentDB for Redis

https://redis.tencentcloudapi.com/?Action=DescribeInstanceDTSInfo&InstanceId=crs-6ia1c1c3&<Common request parameters>

Output Example{"Response": {"CutDownTime": "2019-08-16 17:10:13","DstInfo": {"InstanceId": "crs-jufvqtt7","InstanceName": "dtsdsttest28","RegionId": 1,"SetId": 15005,"Status": 1,"Type": 2,"Vip": "172.16.16.48","ZoneId": 100002},"JobId": "dts-l2g434lt","JobName": "redis_dts_test28","Offset": 0,"RequestId": "f5ff1c8e-7ea4-40a8-b179-8a99c6f7085b","SrcInfo": {"InstanceId": "crs-6ia1c1c3","InstanceName": "dtsSrctest28","RegionId": 1,"SetId": 15005,"Status": -4,"Type": 2,"Vip": "172.16.16.9","ZoneId": 100002},"Status": 10,"StatusDesc": "Failed"}}

5. Developer Resources
SDK©2013-2022 Tencent Cloud. All rights reserved.

Page 138 of 500

TencentDB for Redis

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

©2013-2022 Tencent Cloud. All rights reserved.

Page 139 of 500

TencentDB for Redis

DescribeInstanceZoneInfo：

Last updated 2024-04-03 11:33:19

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the details of a Redis node.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeInstanceZoneInfo.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

No

StringID of a specified instance, such as "crs-xjhsdj****" Log in to the Redis
console and copy the instance ID in the instance list.

Name

3. Output Parameters
Parameter
Name
TotalCountType

Description

IntegerNumber of instance node groups©2013-2022 Tencent Cloud. All rights reserved.

Page 140 of 500

TencentDB for Redis

ReplicaGroups

Array of

List of instance node groups

ReplicaGroupThe unique request ID, generated by the server, will be returned for every
RequestId

Stringrequest (if the request fails to reach the server for other reasons, therequest will not obtain a RequestId). RequestId is required for locating aproblem.

4. Example
Example1 Sample request
This example shows you how to query the node information of a specified instance.
Input Example
https://redis.tencentcloudapi.com/?Action=DescribeInstanceZoneInfo&InstanceId=crs-6tl7****&<Common request parameters>

Output Example{"Response": {"ReplicaGroups": [{"GroupId": 125101,"GroupName": "","ZoneId": "ap-guangzhou-2","Role": "master","RedisNodes": [{"Keys": 39,"Slot": "0-16383","Status": "normal","Role": "master","NodeId": "5f83a663d58f092f4791630065cb3a76c50b40a5"}]},{"GroupId": 125102,"GroupName": "ng-1","ZoneId": "ap-guangzhou-3","Role": "replica",©2013-2022 Tencent Cloud. All rights reserved.

Page 141 of 500

TencentDB for Redis"RedisNodes": [{"Keys": 0,"Slot": "","Status": "normal","Role": "replica","NodeId": "bdc6d645f4741948cf51f93f7013edd64f44c3ba"}]}],"RequestId": "e3d683fc-f2ff-43c9-980d-fae7a1166abc","TotalCount": 2}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error Code©2013-2022 Tencent Cloud. All rights reserved.

Description

Page 142 of 500

TencentDB for Redis

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

FailedOperation.UnSupportError

The instance does not support this API.

FailedOperation.Unknown

Invalid data is entered for weekday.

InternalError.DbOperationFailed

Internal system error with the database operation, which may be
update, insert, select, etc.

InvalidParameter

Incorrect parameter.

InvalidParameter.EmptyParam

The parameter is empty.

InvalidParameter.InvalidParameter

Invalid service parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

©2013-2022 Tencent Cloud. All rights reserved.

Page 143 of 500

TencentDB for Redis

DescribeInstances：

Last updated 2024-04-03 11:33:19

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the list of Redis instances.
A maximum of 50 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 201804-12.

RegionNo

StringCommon Params. This parameter is not required forthis API.

Limit

No

Integer

Common Params. The value used for this API:
DescribeInstances.

Number of instances returned per page. Default value:
20 . Maximum value: 1000 .
Pagination offset, which is an integral multiple ofOffsetNo

Integer

Limit . Calculation formula: offset = limit* (page number - 1).

InstanceId

No

String©2013-2022 Tencent Cloud. All rights reserved.

ID of a specified instance, such as "crs-xjhsdj****" Login to the Redis console and copy the instance ID in the

Page 144 of 500

TencentDB for Redis

instance list.

The instance list is sorted according to the following

OrderByNo

Stringenumeration valid values:- projectId: By project ID.- createtime: By the creation
time of instances.- instancename: By the name of
instances.- type: By the type of instances.curDeadline: By the expiration time of instances.

OrderTypeNo

Integer

For instance sorting order, the default is descendingorder.
- 1: Descending order.
- 0: Ascending order.
Array of VPC IDs such as 47525. If this parameter is
not passed in or the array is empty, the classic network

VpcIds.N

No

Array of String

will be selected by default. This parameter is retained
and can be ignored. It is set based on UniqVpcIds
parameter format.

SubnetIds.N

No

Array of String

Array of VPC subnet IDs such as 56854. Thisparameter is retained and can be ignored. It is set
based on UniqSubnetIds parameter format.
Setting keywords field for fuzzy query, only instanceSearchKey

No

StringProjectIds.N

No

Array of Integer

Array of project IDs

InstanceName

No

String

Instance namenames support fuzzy query.

Array of VPC IDs such as vpc-sad23jfdfk. If thisUniqVpcIds.N

No

Array of String

parameter is not passed in or or the array is empty, theclassic network will be selected by default.

UniqSubnetIds.N

No

Array of String

Array of VPC subnet IDs such as subnet-fdj24n34j2

Array of Integer

Array of region IDs (disused). The corresponding
region can be queried through the common parameter

RegionIds.N

No

Region .
Status.N

No

Array of Integer

Instance status.
- 0: To be initialized.
- 1: In process.
- 2: Running.

©2013-2022 Tencent Cloud. All rights reserved.

Page 145 of 500

TencentDB for Redis- -2: Isolated.
- -3: Pending Delete.

TypeVersion

No

Integer

Instance architecture version.
- 1: Single-node edition.
- 2: Master-replica edition.- 3: Cluster edition.
Storage engine information. Valid values: Redis-

EngineName

No

String2.8 , Redis-4.0 , Redis-5.0 , Redis6.0 or CKV .

AutoRenew.N

No

Array of Integer

BillingMode

No

StringRenewal pattern.
- 0: Manual renewal.
- 1: Automatic renewal.
- 2: No renewal after expiry.
Billing mode. Only pay-as-you-go billing is supported.
Instance type. Valid values: - 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

Type

No

Integer

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).
This parameter is of array type and supports theconfiguration of instance names, instance IDs, and IP
addresses. Among these, the instance name is fuzzy
matching while the instance ID and IP address are

SearchKeys.N

No

Array of String

precise matching.
- Each element in the array is used for a union-basedmatching query.- When both InstanceId andSearchKeys are configured simultaneously, theirintersection will be used for the matching query.

TypeList.N

No

Array of Integer

Internal parameter, which can be ignored.

MonitorVersion

No

StringInternal parameter, which can be ignored.

InstanceTags.N

No

Array ofResources filter by tag key and value. If this parameter©2013-2022 Tencent Cloud. All rights reserved.

Page 146 of 500

TencentDB for Redis

InstanceTagInfo

TagKeys.N

No

Array of String

is not specified or is an empty array, resources will not
be filtered.
Resources filter by tag key. If this parameter is not
specified or is an empty array, resources will not be
filtered.
The product version of the instance. If this parameter is
not configured or the array is set to empty, instances

ProductVersions.N

No

Array of String

will not be filtered based on this parameter by default.
- local: local Disk Edition.- cdc: Cluster dedicatededition.

InstanceIds.N

No

Array of String

AzModeNo

StringBatch query of the specified instances ID. The numberof results returned is based on Limit .
Availability zone mode.
- singleaz: Single availability zone.- multiaz: Multiple
availability zones.

3. Output Parameters
Parameter
Name

Type

Description

TotalCount

Integer

Total number of instances

InstanceSet

Array of
InstanceSet

List of instance details
The unique request ID, generated by the server, will be returned for every

RequestId

Stringrequest (if the request fails to reach the server for other reasons, the request will
not obtain a RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
This example shows you how to query the list of Redis instances
Input Example©2013-2022 Tencent Cloud. All rights reserved.

Page 147 of 500

TencentDB for Redis

POST / HTTP/1.1Host: redis.tencentcloudapi.comContent-Type: application/jsonX-TCAction: DescribeInstances<Common request parameters>{ "Limit": 2, "Offset": 0, "O
rderBy": "createtime "}Output Example{"Response": {"InstanceSet": [{"Appid": 251223628,"AutoRenewFlag": 0,"BillingMode": 1,"ClientLimit": 10000,"ClientLimitMax": 40000,"ClientLimitMin": 10000,"CloseTime": "0000-00-00 00:00:00","Createtime": "2023-04-17 11:32:18","CurrentProxyVersion": "5.8.0","CurrentRedisVersion": "6.0.0","DeadlineTime": "2023-05-17 11:32:18","DiskSize": 0,"DtsStatus": 0,"Engine": "Redis","InstanceId": "crs-4nmzc0ul","InstanceName": "Redis_automation_is_awesome","InstanceNode": [],"InstanceTags": [],"InstanceTitle": "Adding an instance","MonitorVersion": "5s","NetLimit": 24,"NoAuth": false,"NodeSet": [{"NodeId": 336948,"NodeType": 0,"ZoneId": 100002,"ZoneName": ""},{"NodeId": 336946,"NodeType": 1,"ZoneId": 100003,"ZoneName": ""},©2013-2022 Tencent Cloud. All rights reserved.

Page 148 of 500

TencentDB for Redis{"NodeId": 336947,"NodeType": 1,"ZoneId": 100004,"ZoneName": ""}],"OfflineTime": "","PasswordFree": 0,"PolarisServer": "","Port": 6379,"PriceId": 1000848,"ProductType": "standalone","ProjectId": 0,"ProjectName": "Default project","ReadOnly": 0,"RedisReplicasNum": 2,"RedisShardNum": 1,"RedisShardSize": 4096,"Region": "ap-guangzhou","RegionId": 1,"RemainBandwidthDuration": "","Size": 4096,"SizeUsed": 0,"SlaveReadWeight": 0,"Status": 1,"SubStatus": 37,"SubnetId": 2282634,"Tags": [],"Type": 15,"UniqSubnetId": "subnet-1ed4w7to","UniqVpcId": "vpc-mjwornzj","UpgradeProxyVersion": "","UpgradeRedisVersion": "","Vip6": "","VpcId": 11133673,"WanAddress": "","WanIp": "10.0.1.61","ZoneId": 100002},{"Appid": 251223628,"AutoRenewFlag": 0,"BillingMode": 1,"ClientLimit": 10000,"ClientLimitMax": 40000,"ClientLimitMin": 10000,©2013-2022 Tencent Cloud. All rights reserved.

Page 149 of 500

TencentDB for Redis"CloseTime": "0000-00-00 00:00:00","Createtime": "2023-04-17 11:47:02","CurrentProxyVersion": "5.5.0","CurrentRedisVersion": "92.0.0","DeadlineTime": "2023-05-17 11:47:01","DiskSize": 0,"DtsStatus": 0,"Engine": "Redis","InstanceId": "crs-46njvft9","InstanceName": "Redis_automation_is_awesome","InstanceNode": [],"InstanceTags": [],"InstanceTitle": "Running","MonitorVersion": "5s","NetLimit": 24,"NoAuth": false,"NodeSet": [{"NodeId": 336951,"NodeType": 0,"ZoneId": 100002,"ZoneName": ""},{"NodeId": 336949,"NodeType": 1,"ZoneId": 100003,"ZoneName": ""},{"NodeId": 336950,"NodeType": 1,"ZoneId": 100004,"ZoneName": ""}],"OfflineTime": "","PasswordFree": 0,"PolarisServer": "","Port": 6379,"PriceId": 1000848,"ProductType": "standalone","ProjectId": 0,"ProjectName": "Default project","ReadOnly": 0,"RedisReplicasNum": 2,"RedisShardNum": 1,©2013-2022 Tencent Cloud. All rights reserved.

Page 150 of 500

TencentDB for Redis"RedisShardSize": 4096,"Region": "ap-guangzhou","RegionId": 1,"RemainBandwidthDuration": "","Size": 4096,"SizeUsed": 0,"SlaveReadWeight": 0,"Status": 2,"SubStatus": 19,"SubnetId": 2282634,"Tags": [],"Type": 6,"UniqSubnetId": "subnet-1ed4w7to","UniqVpcId": "vpc-mjwornzj","UpgradeProxyVersion": "","UpgradeRedisVersion": "","Vip6": "","VpcId": 11133673,"WanAddress": "","WanIp": "10.0.1.71","ZoneId": 100002}],"RequestId": "3fb5a4d2-680c-45a2-aa88-0213b76d1489","TotalCount": 8}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++©2013-2022 Tencent Cloud. All rights reserved.

Page 151 of 500

TencentDB for Redis

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

FailedOperation.Unknown

Invalid data is entered for weekday.

InternalError.DbOperationFailed

Internal system error with the database operation, which may be
update, insert, select, etc.

InvalidParameter

Incorrect parameter.

InvalidParameter.EmptyParam

The parameter is empty.

InvalidParameter.InvalidParameter

Invalid service parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

UnsupportedOperation

The operation is not supported.

©2013-2022 Tencent Cloud. All rights reserved.

Page 152 of 500

TencentDB for Redis

DescribeProxySlowLog：

Last updated 2024-04-03 11:33:17

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the slow queries of the proxy.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeProxySlowLog.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

StringID of a specified instance, such as "crs-xjhsdj****" Log in to theRedis console and copy the instance ID in the instance list.

BeginTime

Yes

StringStart time of slow query

EndTimeYes

String

End time of slow query

MinQueryTime

No

Integer

Slow query threshold in milliseconds

Limit

No

Integer©2013-2022 Tencent Cloud. All rights reserved.

Number of results per page. Default value: 20 . Value range:[20,1000].

Page 153 of 500

TencentDB for Redis

OffsetNo

Integer

Offset, which is an integral multiple of Limit .

3. Output Parameters
Parameter NameType

Description

TotalCount

Integer

Total number of slow queries

InstanceProxySlowLogDetail

Array of
InstanceProxySlowlogDetail

Slow query details
The unique request ID, generated by theserver, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for otherreasons, the request will not obtain a
RequestId). RequestId is required for locatinga problem.

4. Example
Example1 Sample request
This example shows you how to query the slow log record of a specified instance.
Input Example
https://redis.tencentcloudapi.com/?Action=DescribeProxySlowLog&InstanceId=crs-asd
a****&BeginTime=2019-09-08 12:12:41&EndTime=2019-09-09 12:12:41&<Common request p
arameters>

Output Example{"Response": {"TotalCount": 106980,"InstanceProxySlowLogDetail": [{"Duration": 45,"ExecuteTime": "2019-09-08 12:13:08","CommandLine": "hget hash_key classify_scope::default","Client": "172.16.21.78",©2013-2022 Tencent Cloud. All rights reserved.

Page 154 of 500

TencentDB for Redis"Command": "hget"}],"RequestId": "121d5b40-d2b8-11e9-8c40-ef686158cbd6"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

FailedOperation.Unknown

Invalid data is entered for weekday.

InternalError.DbOperationFailed

Internal system error with the database operation, which may
be update, insert, select, etc.

InvalidParameter.EmptyParam

The parameter is empty.

©2013-2022 Tencent Cloud. All rights reserved.

Page 155 of 500

TencentDB for Redis

InvalidParameter.PermissionDenied

The API has no CAM permissions.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

ResourceUnavailable.InstanceStatusAbnormal
ResourceUnavailable.InstanceStatusError©2013-2022 Tencent Cloud. All rights reserved.

The Redis status is exceptional, and the corresponding
process cannot be executed.
Operation unsupported: the instance is exceptional.

Page 156 of 500

TencentDB for Redis

DescribeSlowLog：

Last updated 2024-04-03 11:33:15

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the records of slow query.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeSlowLog.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

StringID of a specified instance, such as "crs-xjhsdj****" Log in to theRedis console and copy the instance ID in the instance list.

BeginTime

Yes

StringStart time for prequerying a slow log

EndTimeYes

String

End time for prequerying a slow log

MinQueryTime

No

Integer

The average execution time threshold of slow query in microseconds

Limit

No

IntegerName©2013-2022 Tencent Cloud. All rights reserved.

Number of slow queries displayed per page. Default value: 20 .
Value range: [20,1000].

Page 157 of 500

TencentDB for Redis

OffsetNo

Integer

Slow query offset, which is an integral multiple of Limit .
Calculation formula: offset = limit * (page number - 1).

Role

No

StringNode role.
- master: Master node.- slave: Replica node.

3. Output Parameters
Parameter NameType

Description

TotalCount

Integer

Total number of slow queries

InstanceSlowlogDetail

Array of
InstanceSlowlogDetail

InstanceSlowLogDetail

RequestId

Array of
InstanceSlowlogDetail

StringDue to the naming irregularity of this parameter. It is
recommended to use the parameter
InstanceSlowLogDetail instead. Details of slow queries.
Details of slow queries.
The unique request ID, generated by the server, will be
returned for every request (if the request fails to reach theserver for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Query Slow Query Logs of the InstanceThis example shows you how to query detailed information about slow queries for a specific instance through the
DescribeSlowLog API, including the slow query commands, command line information, latency time, client addresses,
and node IDs.
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSlowLog<Common request parameters>{"InstanceId": "crs-asda****","EndTime": "2019-09-09 12:12:41",©2013-2022 Tencent Cloud. All rights reserved.

Page 158 of 500

TencentDB for Redis"BeginTime": "2019-09-08 12:12:41"}

Output Example{"Response": {"InstanceSlowlogDetail": [{"Node": "833a2f6d8b402319aee8ad7f1c0fbbf7********","Command": "hget","CommandLine": "hget hash_key classify_scope::default","Duration": 45,"ExecuteTime": "2019-09-08 12:13:08","Client": ""},{"Node": "833a2f6d8b402319aee8ad7f1c0fbbf7********","Command": "keys","CommandLine": "keys OtherResControler:orion.ovs.client.1514259512471:orion.ovs.e
ntprise.9281083591:sence:*","Duration": 41,"ExecuteTime": "2019-09-08 12:13:08","Client": ""},{"Node": "24a05f0d545da235f07a5bc5deebb937********","Command": "get","CommandLine": "get slot::fsm::status::orion.ovs.client.1508751991541::1db7ffcf92
16bc1fd939e6c710514f6fb40fd4fe1525f","Duration": 41,"ExecuteTime": "2019-09-08 12:13:08","Client": ""}],"RequestId": "121d5b40-d2b8-11e9-8c40-ef686158cbd6","TotalCount": 106980}}

5. Developer Resources
SDK©2013-2022 Tencent Cloud. All rights reserved.

Page 159 of 500

TencentDB for Redis

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InternalError.DbOperationFailed

Internal system error with the database operation, which may be
update, insert, select, etc.

InvalidParameter.EmptyParam

The parameter is empty.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

InvalidParameterValue.UnSupportedType

The instance type is not supported.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

ResourceUnavailable.InstanceStatusError

Operation unsupported: the instance is exceptional.

©2013-2022 Tencent Cloud. All rights reserved.

Page 160 of 500

TencentDB for Redis

DescribeTendisSlowLog：

Last updated 2024-04-03 11:33:13

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query slow queries of a Tendis instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeTendisSlowLog.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID in the format of crs-ngvou0i1

BeginTime

Yes

StringStart time in the format of 2019-09-08 12:12:41

EndTimeYes

String

End time in the format of 2019-09-09 12:12:41

MinQueryTime

No

Integer

Slow query threshold in ms

Limit

No

IntegerMaximum number of results returned per page. Default value: 20.

OffsetNo

Integer

Offset, which is an integral multiple of Limit .

Name©2013-2022 Tencent Cloud. All rights reserved.

Page 161 of 500

TencentDB for Redis

3. Output Parameters
Parameter NameType

Description

TotalCount

Integer

Total number of slow queries

TendisSlowLogDetail

Array of
TendisSlowLogDetail

Slow query details

RequestId

String

The unique request ID, generated by the server, will be
returned for every request (if the request fails to reach theserver for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
Input Example
https://redis.tencentcloudapi.com/?Action=DescribeTendisSlowLog&InstanceId=crs-asdasdas&BeginTime=2019-09-08 12:12:41&EndTime=2019-09-09 12:12:41&<Common request parameters>

Output Example{"Response": {"TotalCount": 106980,"TendisSlowLogDetail": [{"Node": "833a2f6d8b402319aee8ad7f1c0fbbf7a6604337","Command": "hget","CommandLine": "hget hash_key classify_scope::default","Duration": 45,"ExecuteTime": "2019-09-08 12:13:08"}],"RequestId": "121d5b40-d2b8-11e9-8c40-ef686158cbd6"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 162 of 500

TencentDB for Redis

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.Unknown

Invalid data is entered for weekday.

InvalidParameter.EmptyParam

The parameter is empty.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

ResourceUnavailable.InstanceStatusError

Operation unsupported: the instance is exceptional.

©2013-2022 Tencent Cloud. All rights reserved.

Page 163 of 500

TencentDB for Redis

DestroyPostpaidInstance：

Last updated 2024-04-03 11:33:12

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to terminate a pay-as-you-go instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DestroyPostpaidInstance.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID

Name

3. Output Parameters
Parameter
Name

Type

Description

TaskIdInteger

Task ID©2013-2022 Tencent Cloud. All rights reserved.

Page 164 of 500

TencentDB for Redis

RequestId

String

The unique request ID, generated by the server, will be returned for every request (ifthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Terminating pay-as-you-go instance
Input Example
https://redis.tencentcloudapi.com/?Action=DestroyPostpaidInstance&InstanceId=crs-5a4py64p&<Common request parameters>

Output Example{"Response": {"TaskId": "6954227","RequestId": "4daddc97-0005-45d8-b5b8-38514ec1e97c"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface©2013-2022 Tencent Cloud. All rights reserved.

Page 165 of 500

TencentDB for Redis

Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InternalError.DbOperationFailed

Internal system error with the database operation, which may be
update, insert, select, etc.

InternalError.InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

InvalidParameterValue.UnSupportedType

The instance type is not supported.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

ResourceUnavailable.InstanceStatusError

Operation unsupported: the instance is exceptional.

UnauthorizedOperation

The operation is unauthorized.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

UnauthorizedOperation.UserNotInWhiteList

The user is not in the allowlist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 166 of 500

TencentDB for Redis

DestroyPrepaidInstance：

Last updated 2024-04-03 11:33:11

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to return a monthly subscribed instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DestroyPrepaidInstance.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID

3. Output Parameters
Parameter
Name

Type

Description

DealIdStringOrder ID©2013-2022 Tencent Cloud. All rights reserved.

Page 167 of 500

TencentDB for Redis

RequestId

String

The unique request ID, generated by the server, will be returned for every request (if therequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Returning monthly subscribed instance
Input Example
https://redis.tencentcloudapi.com/?Action=DestroyPrepaidInstance&InstanceId=crs-5a4py64p&<Common request parameters>

Output Example{"Response": {"RequestId": "2d4387ee-2011-449e-a32b-87f9366f3ef4","DealId": "6977675"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface©2013-2022 Tencent Cloud. All rights reserved.

Page 168 of 500

TencentDB for Redis

Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

FailedOperation.Unknown

Invalid data is entered for weekday.

InternalError.DbOperationFailed

Internal system error with the database operation, which may be
update, insert, select, etc.

InternalError.InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

InvalidParameterValue.UnSupportedType

The instance type is not supported.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

ResourceUnavailable.InstanceDeleted

The instance has already been repossessed.

ResourceUnavailable.InstanceIsolated

The instance has expired.

ResourceUnavailable.InstanceNoDeal

The order does not exist.

UnauthorizedOperation

The operation is unauthorized.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

©2013-2022 Tencent Cloud. All rights reserved.

Page 169 of 500

TencentDB for Redis

DisableReplicaReadonly：

Last updated 2024-04-03 11:33:11

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to disable read/write separation.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:DisableReplicaReadonly.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID

3. Output Parameters
Parameter
Name

Type

Description

TaskIdInteger

Task ID©2013-2022 Tencent Cloud. All rights reserved.

Page 170 of 500

TencentDB for Redis

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

RequestId

String

The unique request ID, generated by the server, will be returned for every request (ifthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Disabling read/write separation
Input Example
https://redis.tencentcloudapi.com/?Action=DisableReplicaReadonly&InstanceId=crs-5a4py64p&<Common request parameters>

Output Example{"Response": {"RequestId": "2d4387ee-2011-449e-a32b-87f9366f3ef4","TaskId": 15236}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++©2013-2022 Tencent Cloud. All rights reserved.

Page 171 of 500

TencentDB for Redis

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

FailedOperation.UnSupportError

The instance does not support this API.

InternalError.DbOperationFailed

Internal system error with the database operation, which may be update,insert, select, etc.

InternalError.InternalError

Internal error.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

ResourceUnavailable.CallOssError

Failed to call the backend API.

©2013-2022 Tencent Cloud. All rights reserved.

Page 172 of 500

TencentDB for Redis

EnableReplicaReadonly：

Last updated 2024-04-03 11:33:10

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to enable read/write separation.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID

Array
ReadonlyPolicy.N

NoofStringDescription
Common Params. The value used for this API:
EnableReplicaReadonly.

Account routing policy. If master or replication isentered, it means to route to the master or replica node; if thisparameter is left empty, it means to write into the master node andread from the replica node by default.

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 173 of 500

TencentDB for Redis

Parameter

Type

Description

Name
StatusStringTaskIdIntegerRequestId

StringValid values: ERROR , OK . This field has been disused.
Note: This field may return null, indicating that no valid values can be obtained.
Task ID
Note: This field may return null, indicating that no valid values can be obtained.
The unique request ID, generated by the server, will be returned for every request (ifthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Enabling read/write separation
Input Example
https://redis.tencentcloudapi.com/?Action=EnableReplicaReadonly&InstanceId=crs-5a4py64p&<Common request parameters>

Output Example{"Response": {"RequestId": "2d4387ee-2011-449e-a32b-87f9366f3ef4","Status": "OK","TaskId": 21312}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python©2013-2022 Tencent Cloud. All rights reserved.

Page 174 of 500

TencentDB for Redis

Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

FailedOperation.UnSupportError

The instance does not support this API.

InternalError.DbOperationFailed

Internal system error with the database operation, which may be
update, insert, select, etc.

InternalError.InternalError

Internal error.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

ResourceUnavailable.CallOssError

Failed to call the backend API.

ResourceUnavailable.InstanceConfError

An instance configuration error occurred.

©2013-2022 Tencent Cloud. All rights reserved.

Page 175 of 500

TencentDB for Redis

InquiryPriceCreateInstance：

Last updated 2024-04-03 11:33:09

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the price for purchasing an instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

Common Params. The value used for this API:
InquiryPriceCreateInstance.

Instance type. Valid values: 2 (Redis 2.8 memory edition instandard architecture), 3 (CKV 3.2 memory edition instandard architecture), 4 (CKV 3.2 memory edition in
TypeIdYes

Integercluster architecture), 6 (Redis 4.0 memory edition instandard architecture), 7 (Redis 4.0 memory edition incluster architecture), 8 (Redis 5.0 memory edition instandard architecture), 9 (Redis 5.0 memory edition incluster architecture).

MemSize

Yes

Integer©2013-2022 Tencent Cloud. All rights reserved.

Memory capacity in MB, which must be a multiple of 1,024. It
is subject to the purchasable specifications returned by the

Page 176 of 500

TencentDB for Redis

DescribeProductInfo API.
If TypeId indicates the standard architecture, MemSize
indicates the total memory capacity of an instance; if
TypeId indicates the cluster architecture, MemSize
indicates the memory capacity per shard.

GoodsNum

Yes

IntegerNumber of instances. The actual quantity purchasable at atime is subject to the specifications returned by the
DescribeProductInfo API.
Length of purchase in months, which is required when creating

PeriodYes

Integer

BillingMode

Yes

Integer

ZoneIdNo

Integera monthly-subscribed instance. Value range:[1,2,3,4,5,6,7,8,9,10,11,12,24,36]. For pay-as-you-go
instances, set the parameter to 1 .
Billing mode. Valid values: 0 (pay-as-you-go), 1 (monthly
subscription).
ID of the AZ where the instance resides. For more information,
see Regions and AZs.
Instance shard quantity. This field is not required by Redis 2.8

RedisShardNum

RedisReplicasNum

No

No

Integer

Integerstandard architecture, CKV standard architecture, Redis 2.8
standalone edition, and Redis 4.0 standard architecture.
Instance replica quantity. This field is not required by Redis 2.8
standard architecture, CKV standard architecture, and Redis
2.8 standalone edition.

ReplicasReadonly

No

BooleanWhether to support read-only replicas. This field is not required
by Redis 2.8 standard architecture, CKV standard
architecture, and Redis 2.8 standalone edition.

ZoneName

No

StringName of the AZ where the instance resides. For more
information, see Regions and AZs.
Valid values: local (local disk edition), cloud (cloud

ProductVersion

No

Stringdisk edition), cdc (dedicated cluster edition). Default value:
local (local disk edition)

3. Output Parameters
Parameter
Name

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 177 of 500

TencentDB for Redis

Price

Float

Price. Unit: USD (accurate down to the cent)Note: This field may return null , indicating that no valid values can be obtained.

RequestId

String

The unique request ID, generated by the server, will be returned for every request (if therequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample
Input Example
https://redis.tencentcloudapi.com/?Action=InquiryPriceCreateInstance&ZoneId=100002&TypeId=6&MemSize=4096&GoodsNum=1&Period=1&BillingMode=1&<Common request parameters>

Output Example{"Response": {"Price": 30400,"RequestId": "0115d979-2c38-4ad2-b282-bec09d5b4c0b"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP©2013-2022 Tencent Cloud. All rights reserved.

Page 178 of 500

TencentDB for Redis

Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InternalError.InternalError

Internal error.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

InvalidParameterValue.SpecNotExist

The instance specification doesn’t exist.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

UnauthorizedOperation.UserNotInWhiteList

The user is not in the allowlist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 179 of 500

TencentDB for Redis

InquiryPriceUpgradeInstance：

Last updated 2024-04-03 11:33:09

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the price for scaling an instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
InquiryPriceUpgradeInstance.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID.

MemSize

Yes

Integer

Shard size in MB.
Number of shards. This parameter can be left blank for Redis

RedisShardNum

RedisReplicasNum

No

No

Integer

Integer

2.8 in standard architecture, CKV in standard architecture, andRedis 2.8 in standalone architecture.
Number of replicas. This parameter can be left blank for Redis
2.8 in standard architecture, CKV in standard architecture, andRedis 2.8 in standalone architecture.

©2013-2022 Tencent Cloud. All rights reserved.

Page 180 of 500

TencentDB for Redis

3. Output Parameters
Parameter
Name

Type

Price

Float

Description
Price. Unit: USD
Note: this field may return null , indicating that no valid values can be obtained.
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample
Input Example
https://redis.tencentcloudapi.com/?Action=InquiryPriceUpgradeInstance&<Common request parameters>&InstanceId=crs-xjhsdjcxjd&MemSize=4096

Output Example{"Response": {"Price": 30400,"RequestId": "0115d979-2c38-4ad2-b282-bec09d5b4c01"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python©2013-2022 Tencent Cloud. All rights reserved.

Page 181 of 500

TencentDB for Redis

Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InvalidParameter.InvalidParameter

Invalid service parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

InvalidParameterValue.ReduceCapacityNotAllowed
InvalidParameterValue.SpecNotExist
LimitExceeded.MemSizeNotInRange

The request capacity is too small. Capacity reduction is
not supported.
The instance specification doesn’t exist.
The requested capacity is out of the purchasable
capacity range.

ResourceUnavailable.InstanceStateError

Instance status error.

ResourceUnavailable.InstanceStatusError

Operation unsupported: the instance is exceptional.

©2013-2022 Tencent Cloud. All rights reserved.

Page 182 of 500

TencentDB for Redis

KillMasterGroup：

Last updated 2024-04-03 11:33:08

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to simulate the failure.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: KillMasterGroup.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

StringID of a specified instance, such as "crs-xjhsdj****" Log in to the Redis
console and copy the instance ID in the instance list.
A parameter used to configure the access password for a specified
instance. If password-free authentication is enabled, this parameter will
not be required. Required password strength. - It must contains 8-30

Password

No

Stringcharacters. We recommend that you use a password of more than 12
characters. - It must contain at least two of the following types:
lowercase letters, uppercase letters, digits, and symbols(()`~!@#$%^&*-+=_|{}[]:;<>,.?/), and it cannot start with a slash (/).

ShardIds.N

No

Array

Shard ID of a sharded cluster©2013-2022 Tencent Cloud. All rights reserved.

Page 183 of 500

TencentDB for RedisofInteger

3. Output Parameters
Parameter
Name
TaskIdRequestId

Type

Description

Integer

Async task ID

String

The unique request ID, generated by the server, will be returned for every request (ifthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
This example shows you how to simulate a failure.
Input Example
POST / HTTP/1.1Host: redis.tencentcloudapi.comContent-Type: application/jsonX-TCAction: KillMasterGroup<Common request parameters>{ "InstanceId": "crs-joak5XXX","Password": "pwd@1234", "ShardIds": [ 0 ]}Output Example{"Response": {"RequestId": "da6b0bea-7aab-4d4b-b819-d524f4c9eXXX","TaskId": 1682324000}}

5. Developer Resources
SDK©2013-2022 Tencent Cloud. All rights reserved.

Page 184 of 500

TencentDB for Redis

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

CAM signature/authentication error.

AuthFailure.InvalidAuthorization

Invalid authorization.

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

FailedOperation.UnSupportError

The instance does not support this API.

InternalError.InternalError

Internal error.

InvalidParameter.IllegalParameterError

Invalid parameter.

InvalidParameter.InvalidParameter

Invalid service parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

InvalidParameterValue.PasswordEmpty

The password is empty.

InvalidParameterValue.PasswordError

Password verification error due to incorrect password.

InvalidParameterValue.PasswordRuleError©2013-2022 Tencent Cloud. All rights reserved.

When the password is set, the old password passed inby MC does not match the previously set password.

Page 185 of 500

TencentDB for Redis

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

ResourceUnavailable.InstanceNotSupportOperation

Instances in this status do not support the operation.

ResourceUnavailable.InstanceStatusError

Operation unsupported: the instance is exceptional.

©2013-2022 Tencent Cloud. All rights reserved.

Page 186 of 500

TencentDB for Redis

ModifyAutoBackupConfig：

Last updated 2024-04-03 11:33:07

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to set the configuration for an automatic backup.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

StringID of a specified instance, such as "crs-xjhsdj****" Log in to theRedis console and copy the instance ID in the instance list.
Automatic backup cycle. Valid values: Monday , Tuesday ,

Yes

Array
of
StringSunday . This parameter currently cannot be modified.

WeekDays.N

TimePeriod

Yes

StringAutoBackupType

No

Integer©2013-2022 Tencent Cloud. All rights reserved.

Description
Common Params. The value used for this API:
ModifyAutoBackupConfig.

Wednesday , Thursday , Friday , Saturday ,Automatic backup time in the format of 00:00-01:00, 01:0002:00... 23:00-00:00.
Automatic backup type. Valid value: 1 (scheduled backup).

Page 187 of 500

TencentDB for Redis

3. Output Parameters
Parameter NameType

Description

AutoBackupType

Integer

Automatic backup type. Valid value: 1 (scheduled backup).

Array

Automatic backup cycle. Valid values: Monday , Tuesday ,WeekDaysofString

TimePeriod

StringBackupStorageDays

Integer

Retention time of full backup files in days

String

The unique request ID, generated by the server, will be returned for every
request (if the request fails to reach the server for other reasons, the request

RequestId

Wednesday , Thursday , Friday , Saturday , Sunday .
Time period for automatic scheduled backup in the format of “00:00-01:00,
01:00-02:00...... 23:00-00:00”.

will not obtain a RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
This example shows you how to automatically back up the configuration.
Input Example
POST / HTTP/1.1Host: redis.tencentcloudapi.comContent-Type: application/jsonX-TCAction: ModifyAutoBackupConfig<Common request parameters>{ "InstanceId": "crs-5a4
py64p", "AutoBackupType": "1", "TimePeriod": "00%3A00-01%3A00", "WeekDays": [ "We
dnesday" ]}Output Example{"Response": {"BackupStorageDays": 7,"AutoBackupType": 1,"WeekDays": ["Wednesday"],"RequestId": "65e950b9-78e8-49b1-9200-0e62a1925554","TimePeriod": "00:00-01:00"©2013-2022 Tencent Cloud. All rights reserved.

Page 188 of 500

TencentDB for Redis}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.Unknown

Invalid data is entered for weekday.

InternalError.InternalError

Internal error.

InvalidParameter.InvalidParameter

Invalid service parameter.

InvalidParameter.NotSupported

The operation is unsupported due to incorrect parameters.

InvalidParameter.Period

The time format or time range is invalid.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

InvalidParameterValue.WeekDaysIsInvalid

Invalid data is entered for weekday .

©2013-2022 Tencent Cloud. All rights reserved.

Page 189 of 500

TencentDB for Redis

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

©2013-2022 Tencent Cloud. All rights reserved.

Page 190 of 500

TencentDB for Redis

ModifyInstance：

Last updated 2024-04-03 11:33:06

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to modify instance information.
A maximum of 50 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: ModifyInstance.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.
Instance modification type. rename: rename an instance;

Operation

Yes

StringmodifyProject: modify the project of an instance;
modifyAutoRenew: modify the auto-renewal flag of an instance.

Array
InstanceIds.N

No

ofString

Instance ID

Array
InstanceNames.N

Noof

New name of the instanceStringProjectId

No

Integer©2013-2022 Tencent Cloud. All rights reserved.

Project ID

Page 191 of 500

TencentDB for Redis

AutoRenews.N

No

Array
of

Auto-renewal flag. 0: default status (manual renewal); 1: autorenewal enabled; 2: auto-renewal disabled

Integer
InstanceId

No

StringDisusedInstanceName

No

StringDisusedAutoRenew

No

Integer

Disused

3. Output Parameters
Parameter
Name

Type

Description
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
Input Example
https://redis.tencentcloudapi.com/?Action=ModifyInstance&Operation=rename&InstanceIds.0=crs-r3nqjq3n&InstanceNames.0=newname1&InstanceIds.1=crs-9bvd9b8v&InstanceNames.1=newname2&<Common request parameters>

Output Example{"Response": {"RequestId": "6d1e8909-496a-4f27-ad0d-2e4a069b52c0"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 192 of 500

TencentDB for Redis

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error Code
FailedOperation.SystemError

Description
Internal system error, which is irrelevant to thebusiness.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

UnauthorizedOperation

The operation is unauthorized.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

UnauthorizedOperation.UserNotInWhiteList

The user is not in the allowlist.

UnsupportedOperation.ClusterInstanceAccessedDeny

The Redis cluster edition is not allowed toconnect to a security group.

UnsupportedOperation.IsAutoRenewError

There is an error with the auto-renewal flag.

UnsupportedOperation.OnlyClusterInstanceCanExportBackup

Only Cluster Edition instances support
backup exporting.

©2013-2022 Tencent Cloud. All rights reserved.

Page 193 of 500

TencentDB for Redis©2013-2022 Tencent Cloud. All rights reserved.

Page 194 of 500

TencentDB for Redis

ModifyInstanceAccount：

Last updated 2024-04-03 11:33:05

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to modify an instance sub-account.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
ModifyInstanceAccount.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID

AccountName

Yes

StringAccountPassword

No

StringSub-account password

RemarkNo

StringSub-account description information

ReadonlyPolicy.N

No

Array of
StringRouting policy. Valid values: master (master node); replication(replica node)©2013-2022 Tencent Cloud. All rights reserved.

Sub-account name. If the root account is to be modified, enterroot .

Page 195 of 500

TencentDB for Redis

Privilege

No

StringSub-account read/write policy. Valid values: r (read-only); w(write-only); rw (read/write).

NoAuthNo

Booleantrue: make the root account password-free. This is applicable toroot accounts only. Sub-accounts cannot be made passwordfree.

3. Output Parameters
Parameter
Name

Type

Description

TaskIdInteger

Task ID
The unique request ID, generated by the server, will be returned for every request (ifRequestId

Stringthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
Input Example
https://redis.tencentcloudapi.com/?Action=ModifyInstanceAccount&InstanceId=crs-5a4py64p&AccountName=test&<Common request parameters>

Output Example{"Response": {"TaskId": 123456,"RequestId": "0e728fa9-c2e5-4bf8-8d6b-c1c4fab7b6db"}}

5. Developer Resources©2013-2022 Tencent Cloud. All rights reserved.

Page 196 of 500

TencentDB for Redis

SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

FailedOperation.UnSupportError

The instance does not support this API.

InternalError.InternalError

Internal error.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

ResourceUnavailable.GetSecurityError

Failed to get the security group information.

ResourceUnavailable.InstanceStatusError

Operation unsupported: the instance is exceptional.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

UnauthorizedOperation.UserNotInWhiteList

The user is not in the allowlist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 197 of 500

TencentDB for Redis

ModifyInstanceReadOnly：

Last updated 2024-04-03 11:33:04

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to set instance input mode.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID

InputMode

Yes

String

Instance input mode. Valid values: 0 (read/write), 1 (read-only)

Description
Common Params. The value used for this API:
ModifyInstanceReadOnly.

3. Output Parameters
Parameter
Name

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 198 of 500

TencentDB for Redis

TaskIdInteger

Task ID
The unique request ID, generated by the server, will be returned for every request (ifRequestId

Stringthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
Input Example
https://redis.tencentcloudapi.com/?Action=ModifyInstanceReadOnly&InstanceId=crs-5a4py64p&InputMode=0&<Common request parameters>

Output Example{"Response": {"TaskId": 0,"RequestId": "c07beb69-a8f0-4e09-9655-68e59677a7f1"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++©2013-2022 Tencent Cloud. All rights reserved.

Page 199 of 500

TencentDB for Redis

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

CAM signature/authentication error.

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

ResourceNotFoundThe resource doesn’t exist.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

©2013-2022 Tencent Cloud. All rights reserved.

Page 200 of 500

TencentDB for Redis

ModifyMaintenanceWindow：

Last updated 2024-04-03 11:33:03

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to modify the instance maintenance time. The maintenance time specifies a time period during which
compatible version upgrade, architecture upgrade, backend maintenance, and other operations can be performed to
avoid affecting business. Note: if the compatible version upgrade or architecture upgrade task has been initiated for an
instance, its maintenance time cannot be modified.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
ModifyMaintenanceWindow.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID

StartTime

Yes

StringMaintenance start time, such as 17:00

EndTimeYes

StringMaintenance end time, such as 19:00

Name©2013-2022 Tencent Cloud. All rights reserved.

Page 201 of 500

TencentDB for Redis

3. Output Parameters
Parameter
Name
StatusRequestId

Type

Description

StringModification status. Valid values: success, failed.

String

The unique request ID, generated by the server, will be returned for every request (if therequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample
Input Example
https://redis.tencentcloudapi.com/?Action=ModifyMaintenanceWindow&InstanceId=crs-5a4py64p&StartTime=03:00&EndTime=06:00&<Common request parameters>

Output Example{"Response": {"Status": "success","RequestId": "0e728fa9-c2e5-4bf8-8d6b-c1c4fab7b6db"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python©2013-2022 Tencent Cloud. All rights reserved.

Page 202 of 500

TencentDB for Redis

Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error Code
FailedOperation.SystemError

Description
Internal system error, which is irrelevant to thebusiness.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

UnauthorizedOperation.UserNotInWhiteList

The user is not in the allowlist.

UnsupportedOperation.ClusterInstanceAccessedDeny
UnsupportedOperation.IsAutoRenewError©2013-2022 Tencent Cloud. All rights reserved.

The Redis cluster edition is not allowed to connect toa security group.
There is an error with the auto-renewal flag.

Page 203 of 500

TencentDB for Redis

ModifyNetworkConfig：

Last updated 2024-04-03 11:33:03

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to modify the network configuration of an instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: ModifyNetworkConfig.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID

Name

Network change type. Valid values:- changeVip : VPC change, including the private IPv4 address andOperation

Yes

Stringport.
- changeVpc : Subnet change.
- changeBaseToVpc : Change from classic network to VPC.
- changeVPort : Port change.

Vip

No

StringPrivate IPv4 address of the instance, which is required if Operationis changeVip .

©2013-2022 Tencent Cloud. All rights reserved.

Page 204 of 500

TencentDB for Redis

VpcId

No

String

VPC ID after the change, which is required if Operation ischangeVpc or changeBaseToVpc .

SubnetId

No

StringSubnet ID after the change, which is required if Operation ischangeVpc or changeBaseToVpc .
Retention period of the original private IPv4 address- Unit: Days.
- Valid values: 0 , 1 , 2 , 3 , 7 , 15 .

RecycleNo

Integer
Note: You can set the retention period of the original address only in thelatest SDK. In earlier SDKs, the original address is released immediately.
To view the SDK version, go to SDK Center.

VPort

No

Integer

Network port after the change, which is required if Operation ischangeVPort or changeVip . Value range: [1024,65535].

3. Output Parameters
Parameter

Type

Description

StatusBoolean

Execution status. Ignore this parameter.

SubnetId

StringNew subnet ID of the instance

VpcId

StringNew VPC ID of the instance

Vip

String

New private IPv4 address of the instance

TaskIdInteger

Name

Task ID, which can be used to query the task execution status through the
DescribeTaskInfo API.
The unique request ID, generated by the server, will be returned for every request (ifRequestId

Stringthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Modifying the network configuration of an instanceThis example shows you how to modify the VPC of an instance.

©2013-2022 Tencent Cloud. All rights reserved.

Page 205 of 500

TencentDB for Redis

Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyNetworkConfig<Common request parameters>{"InstanceId": "crs-5a4p****","Operation": "changeVip"}

Output Example{"Response": {"Status": true,"Vip": "192.168.1.1","VpcId": "vpc-hu6khgap","SubnetId": "subnet-6mt7lir6","TaskId": 0,"RequestId": "f1b5aabe-806a-4886-b839-9907baa24c85"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface©2013-2022 Tencent Cloud. All rights reserved.

Page 206 of 500

TencentDB for Redis

Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

FailedOperation.Unknown

Invalid data is entered for weekday.

InternalError.DbOperationFailed

Internal system error with the database operation, which may
be update, insert, select, etc.

InternalError.InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameter.NotSupported

The operation is unsupported due to incorrect parameters.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

InvalidParameterValue.CheckNotPass

Business verification failed

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

ResourceUnavailable.InstanceLockedError

Redis has been locked by another process.

ResourceUnavailable.InstanceStatusError

Operation unsupported: the instance is exceptional.

ResourceUnavailable.InstanceUnLockedError

The instance has been locked by another process.

UnauthorizedOperation

The operation is unauthorized.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

UnauthorizedOperation.UserNotInWhiteList

The user is not in the allowlist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 207 of 500

TencentDB for Redis

OpenSSL：Last updated 2024-04-03 11:33:02

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to enable SSL.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: OpenSSL.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID

3. Output Parameters
Parameter

Type

Description

TaskIdInteger

Task ID

RequestId

String

The unique request ID, generated by the server, will be returned for every request (ifName©2013-2022 Tencent Cloud. All rights reserved.

Page 208 of 500

TencentDB for Redisthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Enabling SSL request
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: OpenSSL<Common request parameters>{"InstanceId": "xx"}

Output Example{"Response": {"TaskId": 329,
"RequestId": "e546784b-709c-401d-aba6-73037eb4e522"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js©2013-2022 Tencent Cloud. All rights reserved.

Page 209 of 500

TencentDB for Redis

Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

FailedOperation.UnSupportError

The instance does not support this API.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

InvalidParameterValue.UnSupportedType

The instance type is not supported.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

ResourceUnavailable.InstanceStatusError

Operation unsupported: the instance is exceptional.

UnsupportedOperation.InstanceNotOperation

Unsupported operation

UnsupportedOperation.LimitProxyVersion

The instance version is too low.

©2013-2022 Tencent Cloud. All rights reserved.

Page 210 of 500

TencentDB for Redis

ReleaseWanAddress：

Last updated 2024-04-03 11:33:01

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to disable public network access.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID.

Name

Description
Common Params. The value used for this API:
ReleaseWanAddress.

3. Output Parameters
Parameter
Name
FlowIdType

Description

Integer

Async task ID©2013-2022 Tencent Cloud. All rights reserved.

Page 211 of 500

TencentDB for Redis

WanStatus

StringStatus of disabling public network access
The unique request ID, generated by the server, will be returned for every request (ifRequestId

Stringthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Disabling public network instance
Input Example
https://redis.tencentcloudapi.com/?Action=ReleaseWanAddress&InstanceId=crs-5qlrlhux&<Common request parameters>

Output Example{"Response": {"FlowId": 327,
"WanStatus": “Disabling public network access”,"RequestId": "e546784b-709c-401d-aba6-73037eb4e522"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++©2013-2022 Tencent Cloud. All rights reserved.

Page 212 of 500

TencentDB for Redis

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

FailedOperation.Unknown

Invalid data is entered for weekday.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

©2013-2022 Tencent Cloud. All rights reserved.

Page 213 of 500

TencentDB for Redis

RenewInstance：

Last updated 2024-04-03 11:33:00

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to renew an instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: RenewInstance.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

PeriodYes

Integer

Validity period in months

InstanceId

Yes

String

Instance ID

Name

The parameter used to determine whether to modify the billingmode.
If you want to change the billing mode from pay-as-you-go to
ModifyPayMode

No

Stringmonthly subscription, specify this parameter as prepaid.
If the current instance is monthly subscribed, this parameter is
not required.

©2013-2022 Tencent Cloud. All rights reserved.

Page 214 of 500

TencentDB for Redis

3. Output Parameters
Parameter
Name
DealIdType

Description

StringTransaction ID
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RenewInstance<Common request parameters>{"InstanceId": "crs-5a4py64p","Period": "12"}Output Example{"Response": {"DealId": "6954225","RequestId": "495d8e9f-61bf-465e-aa4e-14be54a9095a"}}

5. Developer Resources
SDK©2013-2022 Tencent Cloud. All rights reserved.

Page 215 of 500

TencentDB for Redis

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.PayFailed

Payment failed.

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InvalidParameter.EmptyParam

The parameter is empty.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

LimitExceeded.PeriodExceedMaxLimit

The requested length of purchase is more than three years
and exceeds the maximum value.

LimitExceeded.PeriodLessThanMinLimit

The length of purchase is invalid. It must be at least one
month.

ResourceInUse.InstanceBeenLocked

The instance is locked by another process.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

ResourceUnavailable.AccountBalanceNotEnoughThe request order number does not exist.

ResourceUnavailable.InstanceDeleted

The instance has already been repossessed.

©2013-2022 Tencent Cloud. All rights reserved.

Page 216 of 500

TencentDB for Redis

ResetPassword：

Last updated 2024-04-03 11:32:59

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to reset a password.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: ResetPassword.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

StringRedis instance ID

Password

No

StringPassword reset (this parameter can be left blank when switching to
password-free instance mode and is required in other cases)
Whether to switch to password-free instance mode. false: switch to

NoAuthNo

Booleanpassword-enabled instance mode; true: switch to password-freeinstance mode. Default value: false.

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 217 of 500

TencentDB for Redis

Parameter
Name

Type

Description
Task ID (this parameter is the task ID when changing a password. If you are switching

TaskIdInteger

between password-free and password-enabled instance mode, you can leave thisparameter alone)

RequestId

String

The unique request ID, generated by the server, will be returned for every request (ifthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
Input Example
https://redis.tencentcloudapi.com/?Action=ResetPassword&Password=zy456987&InstanceId=crs-5a4py64p&<Common request parameters>

Output Example{"Response": {"RequestId": "137c2607-07d1-4df0-9978-4b57a7ca3465","TaskId": 16657}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP©2013-2022 Tencent Cloud. All rights reserved.

Page 218 of 500

TencentDB for Redis

Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

FailedOperation.UnSupportError

The instance does not support this API.

FailedOperation.Unknown

Invalid data is entered for weekday.

InternalError.DbOperationFailed

Internal system error with the database operation, which may
be update, insert, select, etc.

InvalidParameter

Incorrect parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

InvalidParameterValue.PasswordFreeDenied

InvalidParameterValue.PasswordRuleError

Tencent internal accounts are not allowed to use passwordfree instances.
When the password is set, the old password passed in by MC
does not match the previously set password.

ResourceUnavailable.InstanceStatusAbnormal

The Redis status is exceptional, and the corresponding
process cannot be executed.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

©2013-2022 Tencent Cloud. All rights reserved.

Page 219 of 500

TencentDB for Redis

StartupInstance：

Last updated 2024-04-03 11:32:59

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to deisolate an instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: StartupInstance.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID

3. Output Parameters
Parameter
Name

Type

Description

TaskIdInteger

Task ID

RequestId

String

The unique request ID, generated by the server, will be returned for every request (if©2013-2022 Tencent Cloud. All rights reserved.

Page 220 of 500

TencentDB for Redisthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
Input Example
https://redis.tencentcloudapi.com/?Action=StartupInstance&InstanceId=crs-7ponppu3&<Common request parameters>

Output Example{"Response": {"RequestId": "3e96ecad-23db-4fa8-ac41-af9b8e015b26","TaskId": 1203}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0©2013-2022 Tencent Cloud. All rights reserved.

Page 221 of 500

TencentDB for Redis

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.PayFailed

Payment failed.

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

FailedOperation.UnSupportError

The instance does not support this API.

FailedOperation.Unknown

Invalid data is entered for weekday.

InternalError.InternalError

Internal error.

InvalidParameter.EmptyParam

The parameter is empty.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

ResourceUnavailable.InstanceLockedError

Redis has been locked by another process.

ResourceUnavailable.InstanceStatusAbnormal©2013-2022 Tencent Cloud. All rights reserved.

The Redis status is exceptional, and the corresponding
process cannot be executed.

Page 222 of 500

TencentDB for Redis

SwitchProxy：

Last updated 2024-04-03 11:32:57

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to simulate the failure of a proxy node.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: SwitchProxy.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID

ProxyID

No

String

Instance ProxyID

3. Output Parameters
Parameter
Name
RequestId

Type

Description

String

The unique request ID, generated by the server, will be returned for every request (if the©2013-2022 Tencent Cloud. All rights reserved.

Page 223 of 500

TencentDB for Redis

request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
Input Example
https://redis.tencentcloudapi.com/?Action=SwitchProxy&InstanceId=crs-5a4py64p&<Common request parameters>

Output Example{"Response": {"RequestId": "2d4387ee-2011-449e-a32b-87f9366f3ef4"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0©2013-2022 Tencent Cloud. All rights reserved.

Page 224 of 500

TencentDB for Redis

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

CAM signature/authentication error.

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

©2013-2022 Tencent Cloud. All rights reserved.

Page 225 of 500

TencentDB for Redis

UpgradeInstanceVersion：

Last updated 2024-04-03 11:32:56

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to upgrade the instance to a later version or to upgrade the current standard architecture to thecluster architecture.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

TargetInstanceType

Yes

StringTarget instance type after the change, which is the same as theCommon Params. The value used for this API:
UpgradeInstanceVersion.

TypeId of the CreateInstances API.
- For Redis 4.0 or later, a standard architecture instance canbe upgraded to a cluster architecture instance on the sameversion; for example, you can upgrade from Redis 4.0
Standard Architecture to Redis 4.0 Cluster Architecture.
- Cross-version architecture upgrade is not supported; forexample, you cannot upgrade from Redis 4.0 Standard
Architecture to Redis 5.0 Cluster Architecture.
- The architecture of Redis 2.8 cannot be upgraded.

©2013-2022 Tencent Cloud. All rights reserved.

Page 226 of 500

TencentDB for Redis- Cluster architecture cannot be downgraded to standard
architecture.
Switch time. Valid values:
SwitchOption

Yes

Integer- 1 : Switch in the maintenance time.
- 2 (default value): Switch now.

InstanceId

Yes

StringID of the specified instance, such as crs-xjhsdj**** .
Log in to the Redis console, and copy it in the instance list.

3. Output Parameters
Parameter
Name
DealIdType

Description

StringOrder ID
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample
This example shows you how to upgrade the current instance to Redis 4.0 cluster architecture.
Input Example
https://redis.tencentcloudapi.com/?Action=UpgradeInstanceVersion&InstanceId=crs-5qlr****&SwitchOption=2&TargetInstanceType=7&<Common request parameters>

Output Example{"Response": {"DealId": "6954227","RequestId": "4daddc97-0005-45d8-b5b8-38514ec1e97c"©2013-2022 Tencent Cloud. All rights reserved.

Page 227 of 500

TencentDB for Redis}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

FailedOperation.Unknown

Invalid data is entered for weekday.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

UnauthorizedOperation.UserNotInWhiteList

The user is not in the allowlist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 228 of 500

TencentDB for Redis

UpgradeProxyVersion：

Last updated 2024-04-03 11:32:55

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to upgrade instance proxy version.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

ActionYes

String

VersionYes

StringRegionNo

String

InstanceId

Yes

String

Instance ID

CurrentProxyVersion

Yes

String

The current proxy version

UpgradeProxyVersion

Yes

StringUpgradeable redis version

InstanceTypeUpgradeNow

Yes

Integer©2013-2022 Tencent Cloud. All rights reserved.

Description
Common Params. The value used for this API:
UpgradeProxyVersion.
Common Params. The value used for this API: 2018-0412.
Common Params. This parameter is not required for thisAPI.

1 (upgrade immediately), 0 (upgrade during
maintenance time)

Page 229 of 500

TencentDB for Redis

3. Output Parameters
Parameter
Name
FlowIdType

Description

Integer

Async task ID
The unique request ID, generated by the server, will be returned for every request (ifRequestId

Stringthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Upgrading instance proxy
Input Example
https://redis.tencentcloudapi.com/?Action=UpgradeProxyVersion&InstanceId=crs-94w4mqbt&CurrentProxyVersion=4.1.1&UpgradeProxyVersion=4.3.0&InstanceTypeUpgradeNow=1&<Common request parameters>

Output Example{"Response": {"FlowId": 327,
"RequestId": "e546784b-709c-401d-aba6-73037eb4e522"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to callAPIs.

©2013-2022 Tencent Cloud. All rights reserved.

Page 230 of 500

TencentDB for Redis

Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

InvalidParameterValue.CheckNotPass

Business verification failed©2013-2022 Tencent Cloud. All rights reserved.

Page 231 of 500

TencentDB for Redis

UpgradeSmallVersion：

Last updated 2024-04-03 11:32:55

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to upgrade instance minor version.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
UpgradeSmallVersion.

VersionYes

StringRegionNo

String

InstanceId

Yes

String

Instance ID

CurrentRedisVersion

Yes

String

The current redis version

UpgradeRedisVersion

Yes

StringUpgradeable redis version

InstanceTypeUpgradeNow

Yes

Integer©2013-2022 Tencent Cloud. All rights reserved.

Common Params. The value used for this API: 2018-0412.
Common Params. This parameter is not required for thisAPI.

1 (upgrade immediately), 0 (upgrade during
maintenance time)

Page 232 of 500

TencentDB for Redis

3. Output Parameters
Parameter
Name
FlowIdType

Description

Integer

Async task ID
The unique request ID, generated by the server, will be returned for every request (ifRequestId

Stringthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Upgrading instance minor version
Input Example
https://redis.tencentcloudapi.com/?Action=UpgradeSmallVersion&InstanceId=crs-2btr9ryn&CurrentRedisVersion=2.3.0&UpgradeRedisVersion=2.4.0&InstanceTypeUpgradeNow=1&<Common request parameters>

Output Example{"Response": {"FlowId": 329,
"RequestId": "e546784b-709c-401d-aba6-73037eb4e522"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to callAPIs.

©2013-2022 Tencent Cloud. All rights reserved.

Page 233 of 500

TencentDB for Redis

Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

FailedOperation.Unknown

Invalid data is entered for weekday.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

UnsupportedOperation.InstanceNotOperation

Unsupported operation©2013-2022 Tencent Cloud. All rights reserved.

Page 234 of 500

TencentDB for Redis

UpgradeVersionToMultiAvailabilityZones：

Last updated 2024-04-03 11:32:54

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to upgrade an instance to support multi-AZ deployment.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
UpgradeVersionToMultiAvailabilityZones.

VersionYes

StringRegionNo

String

InstanceId

Yes

String

Instance ID

UpgradeProxyAndRedisServer

No

BooleanWhether to support “Reading Local Nodes Only”

Common Params. The value used for this API:2018-04-12.
Common Params. This parameter is not required
for this API.

feature after upgrading to multi-AZ deployment.
ul>true : The “Read Local Nodes Only” feature
is supported. During the upgrade, you need to
upgrade the proxy version and Redis kernel minor
version simultaneously, which will involve data
migration and may take hours to complete.

©2013-2022 Tencent Cloud. All rights reserved.

Page 235 of 500

TencentDB for Redis

false : The “Read Local Nodes Only”
feature is not supported. Upgrading to multi-AZ
deployment will involve metadata migration only
without affecting the service, which generally takeless than three minutes to complete.

3. Output Parameters
Parameter
Name
FlowIdType

Description

Integer

Task ID
The unique request ID, generated by the server, will be returned for every request (ifRequestId

Stringthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpgradeVersionToMultiAvailabilityZones<Common request parameters>{"InstanceId": "crs-5qlrlhux","UpgradeProxyAndRedisServer": "true"}

Output Example{"Response": {"FlowId": "140171780","RequestId": "4daddc97-0005-45d8-b5b8-38514ec1e97c"©2013-2022 Tencent Cloud. All rights reserved.

Page 236 of 500

TencentDB for Redis}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

FailedOperation.Unknown

Invalid data is entered for weekday.

InvalidParameter.InvalidParameter

Invalid service parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

UnsupportedOperation.InstanceNotOperation

Unsupported operation

UnsupportedOperation.LimitProxyVersion

The instance version is too low.

©2013-2022 Tencent Cloud. All rights reserved.

Page 237 of 500

TencentDB for Redis

DescribeCommonDBInstances：

Last updated 2024-04-03 11:33:24

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API has been disused. It was used to query the list of Redis instance information.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeCommonDBInstances.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

VpcIds.N

No

SubnetIds.N

No

Array ofInteger

PayModeNo

Integer

InstanceIds.N

No

Array ofIntegerArray of
String©2013-2022 Tencent Cloud. All rights reserved.

List of VPC IDs

List of subnet IDs
List of billing modes. 0: monthly subscription; 1: pay-as-yougo
List of instance IDs

Page 238 of 500

TencentDB for Redis

InstanceNames.N

No

Array of

List of instance names

StringStatus.N

No

Array of
StringList of instance status

OrderByNo

String

Sorting field

OrderByType

No

String

Sorting order

Vips.NNo

UniqVpcIds.N

No

UniqSubnetIds.N

No

Limit

No

IntegerQuantity limit. Recommended default value: 100.

OffsetNo

Integer

Offset. Default value: 0

Array of
StringArray of
StringArray of
StringList of instance VIPs

List of VPC IDs

List of unique subnet IDs

3. Output Parameters
Parameter

Type

Description

TotalCount

IntegerNumber of instances

InstanceDetails

Array of
RedisCommonInstanceList

Instance information

Name

The unique request ID, generated by the server, will be
RequestId

Stringreturned for every request (if the request fails to reach theserver for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
Disused APIs

©2013-2022 Tencent Cloud. All rights reserved.

Page 239 of 500

TencentDB for Redis

Input Example
https://redis.tencentcloudapi.com/?Action=DescribeCommonDBInstances&PayMode=0&Ins
tanceIds.0=crs-nh47ubwr&<Common request parameters>

Output Example{"Response": {"TotalCount": 0,"InstanceDetails": [{"InstanceName": "abc","InstanceId": "abc","AppId": 0,"ProjectId": 0,"Region": "abc","Zone": "abc","VpcId": "abc","SubnetId": "abc","Status": "abc","Vips": ["abc"],"Vport": 0,"Createtime": "abc","PayMode": 0,"NetType": 0}],"RequestId": "abc"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java©2013-2022 Tencent Cloud. All rights reserved.

Page 240 of 500

TencentDB for Redis

Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

FailedOperation.Unknown

Invalid data is entered for weekday.

InternalError.DbOperationFailed

Internal system error with the database operation, which may be update,insert, select, etc.

InvalidParameter

Incorrect parameter.

InvalidParameter.EmptyParam

The parameter is empty.

InvalidParameter.InvalidParameter

Invalid service parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

©2013-2022 Tencent Cloud. All rights reserved.

Page 241 of 500

TencentDB for Redis

ChangeReplicaToMaster：

Last updated 2024-04-03 11:33:31

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to promote a replica node group to a master node group or a replica node to a master node for an
instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: ChangeReplicaToMaster.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

StringNameGroupId

No

Integer

ID of the specified instance, such as "crs-xjhsdj****" Log in to the Redis
console and copy the instance ID in the instance list.
ID of the replica node group. You can get more ID information of themulti-AZ replica node group though the DescribeInstanceZoneInfo API.
This parameter is not required for a single-AZ replica node group.

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 242 of 500

TencentDB for Redis

Parameter
Name
TaskIdType

Description

Integer

Async task ID
The unique request ID, generated by the server, will be returned for every request (ifRequestId

Stringthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
This example shows you how to promote a replica to a master in single AZ or multiple AZs.
Input Example
POST / HTTP/1.1Host: redis.tencentcloudapi.comContent-Type: application/jsonX-TCAction: ChangeReplicaToMaster<Common request parameters>{ "InstanceId": "crs-sa5****", "GroupId": 301524}

Output Example{"Response": {"RequestId": "c4ed5948-d156-4931-b9c3-10133a0bb6c9","TaskId": 10856}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go©2013-2022 Tencent Cloud. All rights reserved.

Page 243 of 500

TencentDB for Redis

Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

CAM signature/authentication error.

AuthFailure.InvalidAuthorization

Invalid authorization.

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

FailedOperation.UnSupportError

The instance does not support this API.

InvalidParameter.IllegalParameterError

Invalid parameter.

InvalidParameter.InvalidParameter

Invalid service parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

InvalidParameterValue

Incorrect parameter value.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

ResourceUnavailable.InstanceStatusError

Operation unsupported: the instance is exceptional.

©2013-2022 Tencent Cloud. All rights reserved.

Page 244 of 500

TencentDB for Redis

CloneInstances：

Last updated 2024-04-03 11:33:29

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to clone a complete new instance based on the current instance backup file.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

ActionYes

String

VersionYes

StringRegionNo

StringDescription
Common Params. The value used for this API:
CloneInstances.
Common Params. The value used for this API: 201804-12.
Common Params. This parameter is not required forthis API.
The ID of the source instance to be cloned, such as

InstanceId

Yes

String"crs-xjhsdj****". Log in to the Redis console and copy
the instance ID in the instance list.
The number of clone instances at a time
- The maximum number of monthly subscribed

GoodsNum

Yes

Integer

instances is 100 for each purchase.
- The maximum number of pay-as-you-go instances
is 30 for each purchase.

©2013-2022 Tencent Cloud. All rights reserved.

Page 245 of 500

TencentDB for Redis

ZoneIdYes

Integer

ID of the AZ where the clone instance resides. For
more information, see Regions and AZs.
Billing mode. Valid values:

BillingMode

Yes

Integer

0 (Pay-as-you-go)
1 (Monthly subscription)

Purchase duration of an instance.
Unit: Month
Valid values: 1 , 2 , 3 , 4 , 5 , 6 ,PeriodYes

Integer

7 , 8 , 9 , 10 , 11 , 12 , 24 , 36 ,48 , 60 (for monthly subscription mode).
Valid value: 1 (for pay-as-you-go mode).

SecurityGroupIdList.N

Yes

Array of String

BackupId

Yes

StringSecurity group ID, which can be obtained on the
Security Group page in the console.
Backup ID of the clone instance, which can beobtained through the DescribeInstanceBackups API.
Whether the clone instance supports password-freeaccess. Valid values:

NoAuthNo

Booleantrue (Yes)
false (No. When SSL or public network is
enabled). Default value: false .

The VPC ID of the clone instance. If this parameter is
VpcId

No

Stringnot passed in, the classic network will be selected bydefault.
The VPC subnet ID to which the clone instanceSubnetId

No

Stringbelongs, which is not required for the classic
network.
Name of the clone instance.

InstanceName

No

StringEnter up to 60 letters, digits, hyphens, andunderscores.

Password

No

String

The access password of the clone instance.
When the input parameter NoAuth is true, thisparameter is not required.
When the instance is Redis 2.8, 4.0, or 5.0, thepassword must contain 8–30 characters in at©2013-2022 Tencent Cloud. All rights reserved.

Page 246 of 500

TencentDB for Redis

least two of the following types: lowercase letters,
uppercase letters, digits, and special characters() ~!@#$%^&*-+=_|{}[]:;<>,.?/ and cannot
start with /`.
When the instance is CKV 3.2, the password mustand can only contain 8–30 letters and digits.

The auto-renewal flag. Valid values
0 : Manual renewal (default).
AutoRenew

No

Integer

1 : Auto-renewal.
2 : Not auto-renewal (set by user).

VPort

No

Integer

Customized port. Valid range: 1024-65535. Default
value: 6379 .
Node information of an instance.
Currently supported type and AZ information of a

NodeSet.N

No

Array of
RedisNodeInfo

node to be configured (master node or replicanode) For more information, see RedisNodeInfo.
This parameter is not required for single-AZ
deployment.

Project ID. Log in to the Redis console, and find the
ProjectId

No

Integer

project ID in Account Center > ProjectManagement in the top-right corner.

ResourceTags.N

No

Array ofResourceTag

Tag to be bound for the clone instance
The parameter template ID associated with the clone
instance- If this parameter is not configured, the system willautomatically adapt the corresponding default

TemplateId

No

Stringtemplate based on the selected compatible version
and architecture.
- You can query the parameter template list of theinstance to get the template ID through the
DescribeParamTemplates API.
The alarm policy ID of the instance to be cloned. Log

AlarmPolicyList.N

No

Array of String©2013-2022 Tencent Cloud. All rights reserved.

in to the Tencent Cloud Observable Platform
console, and get the policy ID in Alarm
Management > Policy Management.

Page 247 of 500

TencentDB for Redis

3. Output Parameters
Parameter

Type

Description

DealIdStringRequest task ID

InstanceIds

Array
of

Clone instance ID

NameString
The unique request ID, generated by the server, will be returned for every request (ifRequestId

Stringthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
This example shows you how to clone an instance.
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CloneInstances<Common request parameters>{"InstanceId": "abc","GoodsNum": 1,"NoAuth": true,"VpcId": "abc","SubnetId": "abc","ZoneId": 1,"InstanceName": "abc","BillingMode": 0,"Period": 1,"Password": "abc","AutoRenew": 1,"SecurityGroupIdList": [
"abc"
],

©2013-2022 Tencent Cloud. All rights reserved.

Page 248 of 500

TencentDB for Redis"VPort": 1,"BackupId": "abc","NodeSet": [{"NodeId": 0,"NodeType": 0,"ZoneId": 1,"ZoneName": "abc"}],"ProjectId": 0,"ResourceTags": [{"TagKey": "abc","TagValue": "abc"}],"TemplateId": "abc","AlarmPolicyList": [
"abc"
]
}

Output Example{"Response": {"RequestId": "2a836c00-175f-11eb-aeb3-db134c8d8fec","InstanceIds": ["crs-kic3****"],"DealId": "22716"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java©2013-2022 Tencent Cloud. All rights reserved.

Page 249 of 500

TencentDB for Redis

Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.PayFailed

Payment failed.

FailedOperation.SystemError

Internal system error, which is irrelevant to thebusiness.

FailedOperation.Unknown

Invalid data is entered for weekday.

InternalError.InternalError

Internal error.

InvalidParameter.EmptyParam

The parameter is empty.

InvalidParameter.OnlyVPCOnSpecZoneId

Only VPCs are provided in the Shanghai Finance
AZ.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

InvalidParameterValue.BaseNetWorkAccessDeny

The instance is not in a VPC.

InvalidParameterValue.CheckNotPass

Business verification failed
The type of instances requested for purchase isInvalidParameterValue.InvalidInstanceTypeId

incorrect (TypeId - 1: Cluster Edition; 2: MasterReplica Edition, i.e., the legacy Master-Replica
Edition).

InvalidParameterValue.InvalidSubnetId

The vpcid or subnet ID in the VPC is invalid.

InvalidParameterValue.PasswordEmpty

The password is empty.

©2013-2022 Tencent Cloud. All rights reserved.

Page 250 of 500

TencentDB for Redis

InvalidParameterValue.PasswordFreeDenied

Tencent internal accounts are not allowed to use
password-free instances.
When the password is set, the old password passed

InvalidParameterValue.PasswordRuleError

in by MC does not match the previously set
password.

InvalidParameterValue.SecurityGroupIdsNotExists

InvalidParameterValue.UnVpcIdNotExists
LimitExceeded

The request parameter or security group ID isincorrect.
The uniqVpcId or subnet ID in the VPC isinvalid.
The quota limit has been reached.
The requested capacity is out of the purchasable

LimitExceeded.InvalidMemSize

specification range ( memSize should be an
integer multiple of 1,024 in MB).

LimitExceeded.InvalidParameterGoodsNumNotInRange

LimitExceeded.PeriodLessThanMinLimit

LimitExceeded.ReachTheAmountLimit

The number of instances requested for purchase ata time is out of the purchasable quantity range.
The length of purchase is invalid. It must be at least
one month.
The quantity of requested TencentDB for Redis
instances falls out of the limit range.

ResourceInsufficient

The resource is insufficient.

ResourceNotFound.AccountDoesNotExists

The UIN value is empty.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

ResourceUnavailable.InstanceDeleted

The instance has already been repossessed.

ResourceUnavailable.NoEnoughVipInVPCThe IP resources in the VPC are insufficient.

ResourceUnavailable.NoRedisService

ResourceUnavailable.NoServiceAvailableForThisZoneId

ResourceUnavailable.SaleOut
UnauthorizedOperation.NoCAMAuthed©2013-2022 Tencent Cloud. All rights reserved.

The requested region currently does not provide theRedis service.
The requested zoneId doesn’t provide Redis
service.
Resources of the specified type in the region are
sold out.
No CAM permissions.

Page 251 of 500

TencentDB for Redis

UnauthorizedOperation.UserNotInWhiteList

The user is not in the allowlist.

UnsupportedOperation

The operation is not supported.

©2013-2022 Tencent Cloud. All rights reserved.

Page 252 of 500

TencentDB for Redis

CreateInstances：

Last updated 2024-04-22 11:08:48

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to create an TencentDB or Redis instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
CreateInstances.

VersionYes

StringRegionNo

String

TypeIdYes

Integer

Common Params. The value used for this API: 201804-12.
Common Params. This parameter is not required forthis API.
Instance type2 : Redis 2.8 Memory Edition (Standard
Architecture).
3 : CKV 3.2 Memory Edition (Standard
Architecture).
4 : CKV 3.2 Memory Edition (Cluster
Architecture).
6 : Redis 4.0 Memory Edition (Standard
Architecture).

©2013-2022 Tencent Cloud. All rights reserved.

Page 253 of 500

TencentDB for Redis

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

Memory capacity in MB, which must be an integer
multiple of 1024. For specific specifications, query
the sales specifications in all regions through the
DescribeProductInfo API.
MemSize

Yes

Integer- When TypeId is a standard architecture,
MemSize is the total memory capacity of theinstance;- When TypeId is a cluster architecture, MemSize
is the single-shard memory capacity.
The number of instances for each purchase. For

GoodsNum

Yes

Integer

details, query the sales specifications in all regions
through the DescribeProductInfo API.
The purchase duration of an instance- If BillingMode is 1 , that is, when the billingmode is monthly subscription, you need to set thisparameter to specify the duration of the purchased

PeriodYes

Integer

instance. Unit: month. Value range:[1,2,3,4,5,6,7,8,9,10,11,12,24,36].
- If BillingMode is 0 , that is, when the billingmode is pay-as-you-go, you need to set thisparameter to 1 .

BillingMode

Yes

Integer

ZoneIdNo

Integer

Password

No

StringBilling mode. 0: pay-as-you-go
ID of the AZ where the instance resides. For more
information, see Regions and AZs.
Instance access password- When the input parameter NoAuth is true , itmeans that the instance access is set to be
password-free, and the Password field does notneed to be configured; otherwise, Password is a©2013-2022 Tencent Cloud. All rights reserved.

Page 254 of 500

TencentDB for Redis

required parameter.
- When the instance type TypeId is Redis 2.8
Memory Edition (Standard Architecture), Redis 4.0,
5.0, 6.0 (regardless of architecture), the password
must contains 8-30 characters in at least two of thefollowing types: lowercase letters, uppercase letters,
digits, and symbols (()`~!@#$%^&*-+=_|{}[]:;<>,.?/),and it cannot start with a slash (/).
- When the instance type TypeId is CKV 3.2
Memory Edition (regardless of architecture), thepassword contains 8-30 letters and digits andexcludes other characters.
VPC ID. If this parameter is not passed in, the
VpcId

No

Stringclassic network will be selected by default. You canquery the specific VPC ID in the VPC console.
VPC subnet ID. This parameter is not required for

SubnetId

No

Stringthe classic network. You can get the specific subnet
ID by querying the subnet list in the VPC console.
Project ID. Log in to the Redis console, go to theProjectId

No

Integer

account information menu in the top-right corner,and select Project Management to query the
project ID.
Auto-renewal flag

AutoRenew

No

Integer- 0 : Manual renewal (default).
- 1 : Auto-renewal.
- 2 : Not auto-renewal (set by user).
Array of security group IDs. Get the security group ID

SecurityGroupIdList.N

No

Array of String

VPort

No

Integerof the instance through the
DescribeInstanceSecurityGroup API.
User-defined network port. Default value: 6379 .
Range: [1024,65535].
Quantity of instance shards- This parameter is not required for instances ofRedisShardNum

No

IntegerStandard Edition.
- For instances of Cluster Edition, the range of shard
quantity is [1, 3, 5, 8, 12, 16, 24, 32, 40, 48, 64, 80,
96, 128].

RedisReplicasNum

No

IntegerQuantity of instance replicas- For Redis Memory Edition 4.0, 5.0, 6.2 (regardless©2013-2022 Tencent Cloud. All rights reserved.

Page 255 of 500

TencentDB for Redisof architecture), the range of replica quantity is [1,5].
- For Redis 2.8 Standard Edition and CKV Standard
Edition, the replica quantity is 1 .
Whether to support read-only replicas.
- Redis 2.8 Standard Edition and CKV Standard
Edition don’t support read-only replicas.
- If read-only replicas are enabled, read/write
ReplicasReadonly

No

Booleanseparation will be automatically enabled for an
instance, with write requests routed to the masternode and read requests to the replica node.
- To enable read-only replicas, we recommend thatyou create two or more replicas.

InstanceName

No

String

Instance name, which can contain up to 60 letters,
digits, hyphens, and underscores.
Whether to support password-free access for an

NoAuthNo

Booleaninstance- true : The instance access is password-free.
- false : The instance access is passwordenabled. Default value: false . Only instances ina VPC support the password-free access.
The node information of the instance, including node

NodeSet.N

No

Array of
RedisNodeInfo

ID, type, and AZ. For more information, see
RedisNodeInfo.
Node information of an instance. Currently,
information about the node type (master or replica)
and node AZ can be passed in. This parameter is
not required for instances deployed in a single AZ.

Array ofResourceTags.N

No

ZoneName

No

StringTemplateId

No

StringResourceTag

The tag for an instanceName of the AZ where the instance resides. For
more information, see Regions and AZs.
The parameter template ID associated with the
instance- If this parameter is not configured, the system willautomatically adapt the corresponding default
template based on the selected compatible version
and architecture.
- Query the list of parameter templates of an©2013-2022 Tencent Cloud. All rights reserved.

Page 256 of 500

TencentDB for Redis

instance to get the template ID through the
DescribeParamTemplates API.
An internal parameter used to indicate whether tocheck when creating an instance.
- false : Default value. Send a normal request
DryRunNo

Booleanand create an instance if all the requirements aremet.
- true : Send a check request and create no
instance.
The product edition of the instance- local : Local Disk Edition.

ProductVersion

No

String- cloud : Cloud Disk Edition.
- cdc : Dedicated Cluster Edition. Default value:
local .

RedisClusterId

No

StringExclusive cluster ID. When ProductVersion is
set to cdc , this parameter is required.
Alarm policy ID array.- Please log in to Tencent
Cloud Observability Platform - Alarm Management -AlarmPolicyList.N

No

Array of String

Policy Management to access the alarm policy ID.- If
this parameter is not configured, the default alarm
policy will be bound. For the specific information
about the default alarm policy, please log in to
Tencent Cloud Observability Platform - Alarm
Management - Policy Management to view.

3. Output Parameters
Parameter
Name
DealIdType

Description

StringTransaction ID

Array
InstanceIds

of

Instance ID

String
The unique request ID, generated by the server, will be returned for every request (ifRequestId

Stringthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

©2013-2022 Tencent Cloud. All rights reserved.

Page 257 of 500

TencentDB for Redis

4. Example
Example1 Sample request 1
This example shows you how to purchase a monthly subscribed TencentDB for Redis 5.0 instance on Memory Edition(Cluster Architecture).
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateInstances<Common request parameters>{"TypeId": "9","VpcId": "vpc-fmh*****","GoodsNum": "1","RedisShardNum": "3","Period": "3","BillingMode": "1",
"NoAuth": "true","MemSize": "2048","SubnetId": "subnet-680c****","RedisReplicasNum": "1","ZoneId": "200002"}

Output Example{"Response": {"DealId": "154494263","InstanceIds": ["crs-h9sn****"],"RequestId": "d39baee1-e34f-4685-a810-5d27c510acb3"}}

Example2 Sample request 2©2013-2022 Tencent Cloud. All rights reserved.

Page 258 of 500

TencentDB for Redis

This example shows you how to purchase a pay-as-you-go TencentDB for Redis 4.0 instance on Memory Edition(Standard Architecture).
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateInstances<Common request parameters>{"TypeId": "6",
"Password": "**********","GoodsNum": "1","Period": "1",
"BillingMode": "0","MemSize": "1024","ZoneId": "100002"}

Output Example{"Response": {"RequestId": "2a836c00-175f-11eb-aeb3-db134c8d8fec","InstanceIds": ["crs-kic39axx"],"DealId": "22716"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP©2013-2022 Tencent Cloud. All rights reserved.

Page 259 of 500

TencentDB for Redis

Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.PayFailed

Payment failed.

FailedOperation.SystemError

Internal system error, which is irrelevant to thebusiness.

FailedOperation.Unknown

Invalid data is entered for weekday.

InternalError.InternalError

Internal error.

InvalidParameter.EmptyParam

The parameter is empty.

InvalidParameter.OnlyVPCOnSpecZoneId

Only VPCs are provided in the Shanghai Finance
AZ.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

InvalidParameterValue.BaseNetWorkAccessDeny

The instance is not in a VPC.
The type of instances requested for purchase isInvalidParameterValue.InvalidInstanceTypeId

incorrect (TypeId - 1: Cluster Edition; 2: MasterReplica Edition, i.e., the legacy Master-Replica
Edition).

InvalidParameterValue.InvalidSubnetId

The vpcid or subnet ID in the VPC is invalid.

InvalidParameterValue.PasswordEmpty

The password is empty.

InvalidParameterValue.PasswordFreeDenied©2013-2022 Tencent Cloud. All rights reserved.

Tencent internal accounts are not allowed to use
password-free instances.

Page 260 of 500

TencentDB for Redis

InvalidParameterValue.PasswordRuleError

When the password is set, the old password passed
in by MC does not match the previously set
password.

InvalidParameterValue.SecurityGroupIdsNotExists

InvalidParameterValue.UnVpcIdNotExists
LimitExceeded

The request parameter or security group ID isincorrect.
The uniqVpcId or subnet ID in the VPC isinvalid.
The quota limit has been reached.
The requested capacity is out of the purchasable

LimitExceeded.InvalidMemSize

specification range ( memSize should be an
integer multiple of 1,024 in MB).

LimitExceeded.InvalidParameterGoodsNumNotInRange

LimitExceeded.PeriodExceedMaxLimit

LimitExceeded.PeriodLessThanMinLimit

The number of instances requested for purchase ata time is out of the purchasable quantity range.
The requested length of purchase is more than three
years and exceeds the maximum value.
The length of purchase is invalid. It must be at least
one month.

ResourceInsufficient

The resource is insufficient.

ResourceNotFound.AccountDoesNotExists

The UIN value is empty.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

ResourceUnavailable.InstanceDeleted

The instance has already been repossessed.

ResourceUnavailable.NoEnoughVipInVPCThe IP resources in the VPC are insufficient.

ResourceUnavailable.NoRedisService

ResourceUnavailable.NoTypeIdRedisService

The requested region currently does not provide theRedis service.
The requested region currently does not provide therequested type of Redis service.

ResourceUnavailable.SaleOut

Resources of the specified type in the region are
sold out.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

UnauthorizedOperation.UserNotInWhiteList

The user is not in the allowlist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 261 of 500

TencentDB for Redis

UnsupportedOperation©2013-2022 Tencent Cloud. All rights reserved.

The operation is not supported.

Page 262 of 500

TencentDB for Redis

DescribeInstanceDealDetail：

Last updated 2024-04-03 11:33:22

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the order information.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

DealIds.N

Yes

Array of
StringArray of order transaction IDs, i.e., the DealId output parameter

Description
Common Params. The value used for this API:
DescribeInstanceDealDetail.

of the CreateInstances API.

3. Output Parameters
Parameter
Name

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 263 of 500

TencentDB for Redis

DealDetails

Array of

Order details

TradeDealDetailThe unique request ID, generated by the server, will be returned for every
RequestId

Stringrequest (if the request fails to reach the server for other reasons, the request
will not obtain a RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
This example shows you how to query the order information.
Input Example
https://redis.tencentcloudapi.com/?Action=DescribeInstanceDealDetail&DealIds.0=6959052&<Common request parameters>

Output Example{"Response": {"DealDetails": [{"DealId": "6959052","DealName": "20181101110365","ZoneId": 100002,"GoodsNum": 1,"Creater": "1817983094","CreatTime": "2018-11-01 21:12:05","OverdueTime": "2018-11-16 21:12:05","EndTime": "2018-11-01 21:13:18","Status": 4,"Description": "Successfully delivered","Price": 91949,"InstanceIds": ["crs-bz8prb7x"]}],"RequestId": "5d739ed7-af13-489f-b005-aaa57aeaf022"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 264 of 500

TencentDB for Redis

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

ResourceUnavailable.InstanceConfError

An instance configuration error occurred.

©2013-2022 Tencent Cloud. All rights reserved.

Page 265 of 500

TencentDB for Redis

DescribeInstanceNodeInfo：

Last updated 2024-04-03 11:33:21

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the information of an instance node.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

StringID of a specified instance, such as "crs-xjhsdj****" Log in to the Redis
console and copy the instance ID in the instance list.

Limit

No

Integer

Description
Common Params. The value used for this API:
DescribeInstanceNodeInfo.

List size Size of node information returned per page. Default value:
20 . Maximum value: 1000 . This field has been disused.
Pagination offset, which is an integral multiple of Limit . Calculation

OffsetNo

Integer

formula: offset = limit * (page number - 1). This field has been
disused.

©2013-2022 Tencent Cloud. All rights reserved.

Page 266 of 500

TencentDB for Redis

3. Output Parameters
Parameter

Type

Description

ProxyCount

Integer

The number of proxy nodes

Proxy

Array ofProxyNodes

Name

RedisCount

Redis

TendisCount

TendisProxy node information
Note: This field may return null, indicating that no valid values can beobtained.

Integer

The number of Redis nodes

Array of

Redis node information
Note: This field may return null, indicating that no valid values can be

RedisNodes
IntegerArray of
TendisNodes

obtained.
This parameter has been disused.
This parameter has been disused.
Note: This field may return null, indicating that no valid values can beobtained.
The unique request ID, generated by the server, will be returned for every

RequestId

Stringrequest (if the request fails to reach the server for other reasons, the request
will not obtain a RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
This example shows you how to query the node information.
Input Example
POST / HTTP/1.1Host: redis.tencentcloudapi.comContent-Type: application/jsonX-TCAction: DescribeInstanceNodeInfo<Common request parameters>{ "InstanceId": "crs-m
ufy7q15"}

Output Example{"Response": {©2013-2022 Tencent Cloud. All rights reserved.

Page 267 of 500

TencentDB for Redis"Proxy": [{"NodeId": "de1d54148ed79f11c3b4a49c878b29c7218a6a30","ZoneId": 100006},{"NodeId": "de1d54148ed79f11c3b4a49c878b29c7218a6a30","ZoneId": 100006},{"NodeId": "524cc561f6621bc90d726dc62e15c66523754351","ZoneId": 100006},{"NodeId": "5a0b7dfd340e8938762a3fabd390fed0e3635bb2","ZoneId": 100006},{"NodeId": "71506b68e9ee8657b117846f66d66b8dd93a1344","ZoneId": 100006},{"NodeId": "d4d3c819851952b01bd64e9ed7b3ada279b98ff7","ZoneId": 100006},{"NodeId": "183a26e4ca59f98487276ce303ba50a2d71a423b","ZoneId": 100006},{"NodeId": "002293180829fa0b2ab75b4ecd46d39194cabbfb","ZoneId": 100006},{"NodeId": "6cd3f7b5cf412d1e93ab423c959c667e9ff6b75c","ZoneId": 100006},{"NodeId": "52dd9608df1a0b8db6a28510866071f6638855bf","ZoneId": 100006},{"NodeId": "6b62f8239e0851f8a2660cd13dd58bf171cb0f49","ZoneId": 100006},{"NodeId": "6643b7242ad3c47c8b8622f28bf241db0a7b0dde",©2013-2022 Tencent Cloud. All rights reserved.

Page 268 of 500

TencentDB for Redis"ZoneId": 100006},{"NodeId": "dc78e5013a6cfd886eb16a49c2248b956551e77c","ZoneId": 100004},{"NodeId": "d89e53a50448b3d61433317bc090625217cdeaf1","ZoneId": 100004},{"NodeId": "156aebf190383685303ff68978c91adcd308ef27","ZoneId": 100004},{"NodeId": "b8ebc56c5c346b6f79d75f81e6ee5d5f739c75f1","ZoneId": 100004},{"NodeId": "ebbc08014c2c8c53132a541c7321dbf9cef8d09f","ZoneId": 100004},{"NodeId": "e7c18f48e024bdd938a970a67fea207c6cf77138","ZoneId": 100004},{"NodeId": "755d3a3ffc28786b92c2615bde8f17e37e861e57","ZoneId": 100004},{"NodeId": "bb160769730dc46e8408c1d7ebddc8cdd6c1a0f8","ZoneId": 100004},{"NodeId": "4ecab8b25acc46e6bd82dc469328a50fb9568656","ZoneId": 100004},{"NodeId": "27bdbc76b6f714764fb48ff4ddc26db6a20796f5","ZoneId": 100004},{"NodeId": "833f13e8d33ed1b5e8e87a935d0e48c4025af8c3","ZoneId": 100004},{©2013-2022 Tencent Cloud. All rights reserved.

Page 269 of 500

TencentDB for Redis"NodeId": "81c2bd2f68215c5a5020fa900f481894e3b95eca","ZoneId": 100004}],"ProxyCount": 24,"Redis": [{"ClusterId": 0,"NodeId": "cc1e7c5ca61f52252df1ca6562db22e2af6eaa1f","NodeRole": "master","ZoneId": 100006},{"ClusterId": 0,"NodeId": "7b567e0bf382294e03ca88c33ef536f4a0412c7c","NodeRole": "master","ZoneId": 100006},{"ClusterId": 0,"NodeId": "78dd8883679ecda91293ded3051db82eec220da3","NodeRole": "slave","ZoneId": 100004},{"ClusterId": 0,"NodeId": "58b509ea080e53d5aa71776688d2b70b23c63341","NodeRole": "slave","ZoneId": 100006},{"ClusterId": 0,"NodeId": "b451eafdfe3fa6fcd2f309b3a874414e255fc7e9","NodeRole": "slave","ZoneId": 100006},{"ClusterId": 0,"NodeId": "eb7baf3b620417f2ac7b2e61db47494bfe944a20","NodeRole": "slave","ZoneId": 100006},{"ClusterId": 0,"NodeId": "1f4fc3cf0f5dd641896fab7346c19486854b91cf","NodeRole": "slave","ZoneId": 100006©2013-2022 Tencent Cloud. All rights reserved.

Page 270 of 500

TencentDB for Redis},{"ClusterId": 0,"NodeId": "365e4bd53d1b22b7b11a478e59bedd7b36664168","NodeRole": "slave","ZoneId": 100004},{"ClusterId": 0,"NodeId": "6906d69a5378dc368da4cc3b0a924608ded3033a","NodeRole": "slave","ZoneId": 100006},{"ClusterId": 0,"NodeId": "7bf8f6080c14b449a617cff4ad4fd2b326198314","NodeRole": "slave","ZoneId": 100006},{"ClusterId": 0,"NodeId": "14f01a4ae7aa67aa163494bbc6e8c084961b3ca2","NodeRole": "slave","ZoneId": 100004},{"ClusterId": 0,"NodeId": "165bc741b8f9e929b382a6ea14ce8e9d243b4ad9","NodeRole": "slave","ZoneId": 100006},{"ClusterId": 0,"NodeId": "aaafa08a670047eaed7662b09ddac78e2a449590","NodeRole": "slave","ZoneId": 100006},{"ClusterId": 0,"NodeId": "cc37908d0829a977727ebccbac393e1e6eacb7b6","NodeRole": "slave","ZoneId": 100006}],"RedisCount": 15,"RequestId": "eba33751-49d1-43a8-a4c5-5a3596b41f06","Tendis": [],©2013-2022 Tencent Cloud. All rights reserved.

Page 271 of 500

TencentDB for Redis"TendisCount": 0}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InternalError.InternalError

Internal error.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

©2013-2022 Tencent Cloud. All rights reserved.

Page 272 of 500

TencentDB for Redis

DescribeInstanceShards：

Last updated 2024-04-03 11:33:21

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to get the shard information of the instance on cluster architecture.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

StringFilterSlave

No

BooleanName

Description
Common Params. The value used for this API:
DescribeInstanceShards.

ID of a specified instance, such as "crs-xjhsdj****" Log in to the Redis
console and copy the instance ID in the instance list.
Whether to filter out the replica node information. Valid values: true(yes), false (no).

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 273 of 500

TencentDB for Redis

Parameter
Name

InstanceShards

TotalCountType

Array of
InstanceClusterShard
Integer

Description

List information of the instance shards, which includes node
information, node ID, key count, used capacity, and capacity
slope.
Number of instance shard nodes
The unique request ID, generated by the server, will be returned

RequestId

Stringfor every request (if the request fails to reach the server for otherreasons, the request will not obtain a RequestId). RequestId isrequired for locating a problem.

4. Example
Example1 Sample request
This example shows you how to get the shard information of a cluster edition instance.
Input Example
POST / HTTP/1.1Host: redis.tencentcloudapi.comContent-Type: application/jsonX-TCAction: DescribeInstanceShards<Common request parameters>{ "InstanceId": "crs-7po
n****", "FilterSlave": true}

Output Example{"Response": {"InstanceShards": [{"Connected": 1,"Keys": 274171,"Role": 0,"Runid": "edd1020ca1e3767c0d281d205964d168a2f5XXXX","ShardId": "crs-7pon****-001-02","Slots": "[\"0-5460\"]","Storage": 92353816,"StorageSlope": 0},{"Connected": 1,"Keys": 272958,©2013-2022 Tencent Cloud. All rights reserved.

Page 274 of 500

TencentDB for Redis"Role": 0,"Runid": "8f8b3760bfbea22e0fad8a0a9575d7716801XXXX","ShardId": "3",
"ShardName": "crs-XXXXXXXX-003-01","Slots": "[\"10923-16383\"]","Storage": 92096256,"StorageSlope": 0},{"Connected": 1,"Keys": 273074,"Role": 0,"Runid": "b6ed2e93ed754054f06220b995d42f4a07c2XXXX","ShardId": "2",
"ShardName": "crs-XXXXXXXX-002-01","Slots": "[\"5461-10922\"]","Storage": 92149456,"StorageSlope": 0}],"RequestId": "9a57167a-f1a3-47ad-XXXX-b0ad835630a5","TotalCount": 3}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0©2013-2022 Tencent Cloud. All rights reserved.

Page 275 of 500

TencentDB for Redis

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

InvalidParameterValue.UnSupportedType

The instance type is not supported.

©2013-2022 Tencent Cloud. All rights reserved.

Page 276 of 500

TencentDB for Redis

DescribeMaintenanceWindow：

Last updated 2024-04-03 11:33:18

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query instance maintenance window. The maintenance window specifies a time period during
which compatible version upgrade, architecture upgrade, backend maintenance, and other operations can be
performed to avoid affecting business.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeMaintenanceWindow.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID

Name

3. Output Parameters
Parameter

Type

DescriptionName©2013-2022 Tencent Cloud. All rights reserved.

Page 277 of 500

TencentDB for Redis

StartTime

StringStart time of the maintenance window, such as 17:00.

EndTimeString

End time of the maintenance window, such as 19:00.
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample
Input Example
https://redis.tencentcloudapi.com/?Action=DescribeMaintenanceWindow&InstanceId=crs-5a4py64p&<Common request parameters>

Output Example{"Response": {"StartTime": "03:00","EndTime": "06:00","RequestId": "0e728fa9-c2e5-4bf8-8d6b-c1c4fab7b6db"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js©2013-2022 Tencent Cloud. All rights reserved.

Page 278 of 500

TencentDB for Redis

Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error Code
FailedOperation.SystemError

Description
Internal system error, which is irrelevant to thebusiness.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

UnauthorizedOperation.UserNotInWhiteList

The user is not in the allowlist.

UnsupportedOperation.ClusterInstanceAccessedDeny©2013-2022 Tencent Cloud. All rights reserved.

The Redis cluster edition is not allowed to connect toa security group.

Page 279 of 500

TencentDB for Redis

DescribeParamTemplateInfo：

Last updated 2024-04-03 11:33:17

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the details of a parameter template.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeParamTemplateInfo.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

TemplateId

YesStringName

The parameter template ID for query. Get parameter template list
information through the DescribeParamTemplates API.

3. Output Parameters
Parameter
Name

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 280 of 500

TencentDB for Redis

TotalCount

IntegerQuantity of parameters in the parameter template

TemplateId

StringParameter template ID.

NameStringParameter template name.
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).

ProductType

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

Description
Items

StringParameter template description

Array of

Parameter details, including parameter name, current value, default value,

ParameterDetailmaximum value, minimum value, enumeration value and other information.
The unique request ID, generated by the server, will be returned for every

RequestId

Stringrequest (if the request fails to reach the server for other reasons, therequest will not obtain a RequestId). RequestId is required for locating aproblem.

4. Example
Example1 Querying the information of a parameter template
This example shows you how to query the template information by the specified parameter template ID.
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeParamTemplateInfo<Common request parameters>{"TemplateId": "crs-cfg-7mgt****"}©2013-2022 Tencent Cloud. All rights reserved.

Page 281 of 500

TencentDB for Redis

Output Example{"Response": {"Description": "MyCustomParamTemplate","Items": [{"CurrentValue": "","Default": "\"\"","Description": "commands in such config will not be allowed to run in this instance,you can config multi commands like this 'flushdb,keys'","EnumValue": ["flushall","flushdb","keys","hgetall","eval","evalsha","script"],"Max": "","Min": "","Name": "disable-command-list","NeedReboot": 0,"ParamType": "multi"},{"CurrentValue": "512","Default": "512","Description": "Hashes are encoded using a memory efficient data structure when t
hey have a small number of entries","EnumValue": null,"Max": "10000","Min": "1","Name": "hash-max-ziplist-entries","NeedReboot": 0,"ParamType": "integer"},{"CurrentValue": "64","Default": "64","Description": "Hashes are encoded using a memory efficient data structure when t
he biggest entry does not exceed a given threshold","EnumValue": null,"Max": "10000",©2013-2022 Tencent Cloud. All rights reserved.

Page 282 of 500

TencentDB for Redis"Min": "1","Name": "hash-max-ziplist-value","NeedReboot": 0,"ParamType": "integer"},{"CurrentValue": "10","Default": "10","Description": "The frequency at which Redis background tasks are performed. A hi
gher value results in higher CPU consumption but smaller latency. We recommend that you do not specify a value larger than 100.","EnumValue": null,"Max": "500","Min": "1","Name": "hz","NeedReboot": 0,"ParamType": "integer"}],"Name": "redis_automation_is_awesome_1","ProductType": 2,"RequestId": "72881d6c-c2a0-42af-862a-a5de09de104d","TemplateId": "crs-cfg-7mgt****","TotalCount": 14}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface©2013-2022 Tencent Cloud. All rights reserved.

Page 283 of 500

TencentDB for Redis

Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error Code
FailedOperation.SystemError

Description
Internal system error, which is irrelevant to thebusiness.

InvalidParameter

Incorrect parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

UnauthorizedOperation

The operation is unauthorized.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

UnauthorizedOperation.UserNotInWhiteList

The user is not in the allowlist.

UnsupportedOperation.ClusterInstanceAccessedDeny©2013-2022 Tencent Cloud. All rights reserved.

The Redis cluster edition is not allowed to connect toa security group.

Page 284 of 500

TencentDB for Redis

DescribeReplicationGroup：

Last updated 2024-04-03 11:33:16

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query a replication group.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

Limit

Yes

IntegerNumber of instances returned per page. Default value: 20 .

OffsetYes

Integer

Name

Description
Common Params. The value used for this API:
DescribeReplicationGroup.

Pagination offset, which is an integral multiple of Limit . offset= limit * (page number - 1).
ID of the specified replication group, such as crs-rpl-m3zt**** .

GroupId

No

String

Log in to the TencentDB for Redis console, and get it in the global
replication group list.

SearchKey

No

StringKeyword for fuzzy query, which can be a replication group ID or name.
Log in to the TencentDB for Redis console, and get them in the global©2013-2022 Tencent Cloud. All rights reserved.

Page 285 of 500

TencentDB for Redis

replication group list.

3. Output Parameters
Parameter

Type

Description

TotalCount

IntegerNumber of replication groups

GroupsArrayofReplication group information

NameGroupsThe unique request ID, generated by the server, will be returned for every request (ifRequestId

Stringthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
This example shows you how to query the information of a single replication group.
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeReplicationGroup<Common request parameters>{"Limit": 20,"GroupId": "crs-rpl-lkgv****","Offset": 0}

Output Example{"Response": {"TotalCount": 1,©2013-2022 Tencent Cloud. All rights reserved.

Page 286 of 500

TencentDB for Redis"RequestId": "65e950b9-78e8-49b1-9200-0e62a1925557","Groups": [{"Status": 37,"Remark": "Test replication group","InstanceCount": 1,"Instances": [{"Engine": "Redis Community Edition","Vip6": "","UpdateTime": "2022-11-02 15:04:05","VpcID": 16770550,"InstanceId": "crs-9c36****","RedisShardSize": 1024,"RegionId": 1,"RedisShardNum": 1,"Status": 1,"Vip": "10.0.4.42","DiskSize": 0,"CreateTime": "2022-11-02 15:04:05","ProductType": 9,"AppId": 0,"Role": "rw","VPort": 6379,"ZoneId": 1,"InstanceName": "crs-test","RedisReplicasNum": 1,"GrocerySysId": 1000259}],"RegionId": 1,"GroupName": "crs-ben-test","AppId": 0,"GroupId": "crs-rpl-lkgv****"}]}}

5. Developer Resources
SDK©2013-2022 Tencent Cloud. All rights reserved.

Page 287 of 500

TencentDB for Redis

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InvalidParameterValue.ReplicationGroupNotExists

The global replication group doesn’t exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 288 of 500

TencentDB for Redis

DescribeSSLStatus：

Last updated 2024-04-03 11:33:15

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the SSL authentication information of an instance, such as enablement status, configuration
status, and certificate address.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeSSLStatus.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID

3. Output Parameters
Parameter NameType

Description

CertDownloadUrl

StringDownload address for SSL certificate©2013-2022 Tencent Cloud. All rights reserved.

Page 289 of 500

TencentDB for Redis

UrlExpiredTime

StringExpiration time of the certificate download address
Whether the SSL is enabled for the identified instance.

SSLConfig

Boolean- true : Enabled- false : Disabled
Whether SSL is supported for the identified instance.

FeatureSupport

Boolean- true : Supported- false : Not supported

StatusInteger

Status of SSL configuration- 1 : Configuring- 2 : Configured successfully
The unique request ID, generated by the server, will be returned for every

RequestId

Stringrequest (if the request fails to reach the server for other reasons, the request
will not obtain a RequestId). RequestId is required for locating a problem.

4. Example
Example1 Example 1
This example shows you how to query the SSL authentication information of an instance.
Input Example
https://redis.tencentcloudapi.com/?Action=DescribeSSLStatus&InstanceId=crs-2btr9ryn&<Common request parameters>

Output Example{"Response": {"CertDownloadUrl": "abc","UrlExpiredTime": "abc","SSLConfig": true,"FeatureSupport": true,"Status": 0,"RequestId": "abc"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 290 of 500

TencentDB for Redis

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameter.ActionNotFoundThe corresponding API was not found.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

InvalidParameterValue.UnSupportedType

The instance type is not supported.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

ResourceUnavailable.InstanceStatusError

Operation unsupported: the instance is exceptional.

©2013-2022 Tencent Cloud. All rights reserved.

Page 291 of 500

TencentDB for Redis

DescribeTaskInfo：

Last updated 2024-04-03 11:33:14

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to get the execution of a specified task.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeTaskInfo.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

TaskIdYes

Integer

Task ID

3. Output Parameters
Parameter
Name
StatusType

Description

StringTask status. Valid values:- preparing : To be run- running : Running©2013-2022 Tencent Cloud. All rights reserved.

Page 292 of 500

TencentDB for Redis- succeed : Succeeded- failed : Failed- Error : Error occurred while running
StartTime

StringTask start time
Task type, including Create , Configure , Disable Instance ,TaskType

StringClear Instance , Reset Password , Upgrade Version , Back up
Instance , Modify Network , Migrate to New AZ and Promote
to Master .

InstanceId

String

Instance ID

TaskMessage

StringMessage returned by task execution, which will be an error message when
execution fails or be empty when the status is running or succeed- .

RequestId

String

The unique request ID, generated by the server, will be returned for every request (ifthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
This example shows you how to query the task execution results.
Input Example
https://redis.tencentcloudapi.com/?Action=DescribeTaskInfo&TaskId=18215&<Common request parameters>

Output Example{"Response": {"Status": "succeed","StartTime": "2018-11-01 17:25:14","TaskType": "redis cache clearing process","InstanceId": "crs-09u2u96z","TaskMessage": "","RequestId": "81120ab8-fea0-41ab-af7e-283c0348c4fc"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 293 of 500

TencentDB for Redis

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InvalidParameter.InvalidParameter

Invalid service parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

©2013-2022 Tencent Cloud. All rights reserved.

Page 294 of 500

TencentDB for Redis

DescribeTaskList：

Last updated 2024-04-03 11:33:13

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the task list information of a specified instance.
A maximum of 100 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeTaskList.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

No

String

InstanceName

No

String

Limit

No

Integer

OffsetNo

Integer

ProjectIds.N

No

Array

Name

©2013-2022 Tencent Cloud. All rights reserved.

ID of a specified instance, such as "crs-xjhsdj****" Log in to theRedis console and copy the instance ID in the instance list.
Instance name
Number of taskss returned per page. Default value: 20 . Maximum
value: 100 .
Pagination offset, which is an integral multiple of Limit .
Calculation formula: offset = limit * (page number - 1).
Project ID Log in to the Redis console, go to the account information

Page 295 of 500

TencentDB for Redisofmenu in the top-right corner, and select Project Management toIntegerquery the project ID.
Task type. Valid values: - FLOW_CREATE : Create an instance. FLOW_MODIFYCONNECTIONCONFIG : Adjust the number of
bandwidth connections. FLOW_MODIFYINSTANCEPASSWORDFREE : Modify the process ofpassword-free access. - FLOW_CLEARNETWORK : Returning VPC FLOW_SETPWD : Set the access password. - FLOW_EXPORSHR :Expand or reduce the capacity. - FLOW_UpgradeArch : Upgrade
the instance architecture. - FLOW_MODIFYINSTANCEPARAMS :Modify the instance parameters. -TaskTypes.N

No

Array

FLOW_MODIFYINSTACEREADONLY : Modify read-only process. -ofFLOW_CLOSE : Disable the instance. - FLOW_DELETE : Delete

Stringthe instance. - FLOW_OPEN_WAN : Enable the public network. FLOW_FLOW_CLEAN : Clear the instance. FLOW_MODIFYINSTANCEACCOUNT : Modify the instance account.
- FLOW_ENABLEINSTANCE_REPLICATE : Enable the replica
read-only feature. - FLOW_DISABLEINSTANCE_REPLICATE :Disable the replica read-only feature. FLOW_SWITCHINSTANCEVIP : Swap the VIPs of instances. FLOW_CHANGE_REPLICA_TO_MSTER: Promote the replica
node to the mater node. - FLOW_BACKUPINSTANCE : Back up an
instance.

BeginTimeNo

String

EndTimeNo

StringStart time for executing a task, in the format of “2020-10-1200:00:00”.
End time for executing a task, in the format of “2021-12-30
20:59:35”.

Array
TaskStatus.N

No

ofThis parameter is only for internal use and can be ignored.

Integer

Result.N

No

Array
of
IntegerArray

OperatorUin.N

No

ofInteger

Task execution status. Valid values: - 0 (initilized) - 1(executing) - 2 (completed) - 4 (failed)

The field OperatorUin has been disused and replaced byOperateUin .

ArrayOperateUin.N

No

ofOperator account ID or UIN

String©2013-2022 Tencent Cloud. All rights reserved.

Page 296 of 500

TencentDB for Redis

3. Output Parameters
Parameter
Name
TotalCount
Tasks

RequestId

Type

Description

Integer

Total number of tasks

Array of
TaskInfoDetail

StringTask details
The unique request ID, generated by the server, will be returned for every
request (if the request fails to reach the server for other reasons, the request
will not obtain a RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample
This example shows you how to query the task details of an instance.
Input Example
POST / HTTP/1.1Host: redis.tencentcloudapi.comContent-Type: application/jsonX-TCAction: DescribeTaskList<Common request parameters>{ "InstanceId": "crs-opcazbrb"}

Output Example{"Response": {"RequestId": "19a7fb07-8e21-4827-88dd-fee57f38e8cd","Tasks": [{"EndTime": "2019-11-15 14:25:46","InstanceId": "crs-opcazbrb","InstanceName": "multidbccbugfix11153","Progress": 1,"ProjectId": 0,"Result": 2,"StartTime": "2019-11-15 14:25:37","TaskId": 42372,©2013-2022 Tencent Cloud. All rights reserved.

Page 297 of 500

TencentDB for Redis"TaskType": "037"},{"EndTime": "2019-11-15 14:25:25","InstanceId": "crs-opcazbrb","InstanceName": "multidbccbugfix11153","Progress": 1,"ProjectId": 0,"Result": 2,"StartTime": "2019-11-15 14:25:16","TaskId": 42371,"TaskType": "037"}],"TotalCount": 2}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.

©2013-2022 Tencent Cloud. All rights reserved.

Page 298 of 500

TencentDB for Redis

Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InternalError.DbOperationFailed

Internal system error with the database operation, which may be update,insert, select, etc.

InternalError.InternalError

Internal error.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

©2013-2022 Tencent Cloud. All rights reserved.

Page 299 of 500

TencentDB for Redis

ModfiyInstancePassword：

Last updated 2024-04-03 11:33:07

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to modify the access password for an instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID, such as "crs-xjhsdj****". Log in to the Redis console andcopy the instance ID in the instance list.

OldPassword

Yes

String

Old password of an instanceDescription
Common Params. The value used for this API:
ModfiyInstancePassword.

New instance password, which has the following requirements:- It must contain 8-30 characters, preferably 12 or more.
Password

Yes

String- It cannot start with a slash (/)- It must contain two of the following three types: lowercase letters,
uppercase letters, and symbols (()~!@#$%^&*-+=_|{}[]:;<>,.?/)©2013-2022 Tencent Cloud. All rights reserved.

Page 300 of 500

TencentDB for Redis

3. Output Parameters
Parameter
Name
TaskIdType

Description

Integer

Task ID
The unique request ID, generated by the server, will be returned for every request (ifRequestId

Stringthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Modifying the password
This example shows you how to reset instance access password.
Input Example
https://redis.tencentcloudapi.com/?Action=ModfiyInstancePassword&InstanceId=crs-5a4p****&OldPassword=zy45****&Password=4569****&<Common request parameters>

Output Example{"Response": {"RequestId": "cca16225-a169-4f11-b1cf-13398200f604","TaskId": 16661}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to callAPIs.

©2013-2022 Tencent Cloud. All rights reserved.

Page 301 of 500

TencentDB for Redis

Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InvalidParameter.EmptyParam

The parameter is empty.

InvalidParameter.InvalidParameter

Invalid service parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

InvalidParameterValue.PasswordError

Password verification error due to incorrect password.

InvalidParameterValue.PasswordRuleError

When the password is set, the old password passed in by MC
does not match the previously set password.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

ResourceUnavailable.InstanceLockedError

Redis has been locked by another process.

ResourceUnavailable.InstanceStatusAbnormal
UnauthorizedOperation.NoCAMAuthed©2013-2022 Tencent Cloud. All rights reserved.

The Redis status is exceptional, and the corresponding
process cannot be executed.
No CAM permissions.

Page 302 of 500

TencentDB for Redis

RemoveReplicationInstance：

Last updated 2024-04-03 11:33:01

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to remove a member from a replication group.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

GroupId

Yes

StringReplication group ID

InstanceId

Yes

String

Instance ID

Description
Common Params. The value used for this API:
RemoveReplicationInstance.

Data sync type. Valid values: true (strong sync is required),
SyncType

Yes

Booleanfalse (strong sync is not required, only the master instance can bedeleted).

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 303 of 500

TencentDB for Redis

Parameter
Name

Type

Description

TaskIdInteger

Async task ID
The unique request ID, generated by the server, will be returned for every request (ifRequestId

Stringthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RemoveReplicationInstance<Common request parameters>{"InstanceId": "crs-sa5dsfs","SyncType": true,"GroupId": "crs-rpl-sa5dsfs"}

Output Example{"Response": {"RequestId": "c4ed5948-d156-4931-b9c3-10133a0bb6c9","TaskId": 10856}}

5. Developer Resources
SDK©2013-2022 Tencent Cloud. All rights reserved.

Page 304 of 500

TencentDB for Redis

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InternalError.DbOperationFailed

Internal system error with the database operation, which
may be update, insert, select, etc.

InvalidParameterValue.CheckNotPass

Business verification failed

InvalidParameterValue.ReplicationGroupNotExists

The global replication group doesn’t exist.

LimitExceeded.ReplicationGroupLocked

Replication group locked

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

ResourceUnavailable.InstanceStatusError

Operation unsupported: the instance is exceptional.

UnsupportedOperation.Inspection

Inspecting replication group

UnsupportedOperation.InstanceNotOperation

Unsupported operation©2013-2022 Tencent Cloud. All rights reserved.

Page 305 of 500

TencentDB for Redis

UpgradeInstance：

Last updated 2024-04-03 11:32:57

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to modify the instance configuration.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

String

VersionYes

StringRegionNo

StringCommon Params. This parameter is not required forthis API.

InstanceId

Yes

StringThe ID of instance to be modified.

MemSize

Yes

Integer

New memory size of an instance shard.

Common Params. The value used for this API:
UpgradeInstance.
Common Params. The value used for this API: 201804-12.

Unit: MB.
You can only modify one of the three parameters at atime: MemSize , RedisShardNum , andRedisReplicasNum . To modify one of them,
you need to enter the other two, which are consistent©2013-2022 Tencent Cloud. All rights reserved.

Page 306 of 500

TencentDB for Redis

with the original configuration specifications of theinstance.
In case of capacity reduction, the new specificationmust be at least 1.3 times the used capacity;
otherwise, the operation will fail.

New number of instance shards.
This parameter is not required for standard
architecture instances, but for cluster architecture
instances.
For cluster architecture, you can only modify one of
RedisShardNum

No

Integer

the three parameters at a time: MemSize ,RedisShardNum , and RedisReplicasNum .
To modify one of them, you need to enter the othertwo, which are consistent with the original
configuration specifications of the instance.

New replica quantity.
You can only modify one of the three parameters at atime: MemSize , RedisShardNum , andRedisReplicasNum . To modify one of them,
RedisReplicasNum

No

Integeryou need to enter the other two, which are consistent
with the original configuration specifications of theinstance.
To modify the number of replicas in a multi-AZ instance,
NodeSet must be passed in.

NodeSet.N

No

Array of

Additional information for adding replicas for multi-AZ
instances, including replica AZ and type ( NodeType

RedisNodeInfo

is 1 ). This parameter is not required for single-AZ
instances.

3. Output Parameters
Parameter

Type

Description

DealIdStringOrder ID

RequestId

String

The unique request ID, generated by the server, will be returned for every request (if theName©2013-2022 Tencent Cloud. All rights reserved.

Page 307 of 500

TencentDB for Redis

request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpgradeInstance<Common request parameters>{"InstanceId": "crs-5qlr****","MemSize": "4096","RedisShardNum": 5,"RedisReplicasNum": 3}

Output Example{"Response": {"DealId": "6954227","RequestId": "4daddc97-0005-45d8-b5b8-38514ec1e97c"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP©2013-2022 Tencent Cloud. All rights reserved.

Page 308 of 500

TencentDB for Redis

Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.PayFailed

Payment failed.

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

FailedOperation.Unknown

Invalid data is entered for weekday.

InvalidParameter.InvalidParameter

Invalid service parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

InvalidParameterValue.MemSizeNotInRange

InvalidParameterValue.ReduceCapacityNotAllowed

The requested capacity is out of the purchasable
capacity range.
The request capacity is too small. Capacity reduction is
not supported.

InvalidParameterValue.SpecNotExist

The instance specification doesn’t exist.

LimitExceeded

The quota limit has been reached.
The requested capacity is out of the purchasable

LimitExceeded.InvalidMemSize

specification range ( memSize should be an integer
multiple of 1,024 in MB).

ResourceInsufficient

The resource is insufficient.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

ResourceUnavailable.AccountBalanceNotEnoughThe request order number does not exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 309 of 500

TencentDB for Redis

ResourceUnavailable.InstanceStatusAbnormal

The Redis status is exceptional, and the corresponding
process cannot be executed.

ResourceUnavailable.InstanceStatusError
ResourceUnavailable.SaleOut
UnauthorizedOperation.NoCAMAuthed©2013-2022 Tencent Cloud. All rights reserved.

Operation unsupported: the instance is exceptional.
Resources of the specified type in the region are soldout.
No CAM permissions.

Page 310 of 500

TencentDB for Redis

DescribeInstanceEvents：

Last updated 2024-04-15 11:08:57

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the event information on a TecentDB for Redis instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

ExecutionStartDate

Yes

StringExecutionEndDate

Yes

StringCommon Params. The value used for this API:
DescribeInstanceEvents.

Configures the start date for querying the event execution
schedule.
Configures the end date for querying the event execution
schedule.
Specifies the instance ID. Example: crs-xjhsdj****. Log in to the

InstanceId

No

StringTencentDB for Redis console and copy the instance ID in the
instance list.

PageSizeNo

Integer©2013-2022 Tencent Cloud. All rights reserved.

Outputs the number of events displayed per page. Default
value: 10.

Page 311 of 500

TencentDB for Redis

PageNoNo

Integer

Configures the page number for querying events. You can query
events on a certain page by specifying PageNo and PageSize.
Default value: 1.
Current status of the event.- Waiting: The event is waiting for

Status.N

No

Array
of

execution on the execution date or during the operations
period.- Running: The event is being executed during theStringoperations period.- Finished: Execution of the event iscompleted.- Canceled: Execution of the event is canceled.

EventTypes.N

Grades.N

No

No

Array

Event type. Currently, the type can only be related to instanceofStringmigration, resource movement, and IDC deletion. Thisparameter can be set only to InstanceMigration.

Array

Configures the level of the queried event. Events are dividedofinto Critical, High, Medium, and Low events according to theStringseverity and urgency.- Critical- High- Medium- Low

3. Output Parameters
Parameter NameType

Description

TotalCount

Integer

Total number of events.

RedisInstanceEvents

RequestId

Array of
RedisInstanceEvent

String

Instance event information.
The unique request ID, generated by the server, will be
returned for every request (if the request fails to reach theserver for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Querying Instance Events
This example shows you how to query instance events.
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com©2013-2022 Tencent Cloud. All rights reserved.

Page 312 of 500

TencentDB for Redis

Content-Type: application/json
X-TC-Action: DescribeInstanceEvents<Common request parameters>{"InstanceId": "crs-b6wst31p","PageSize": 20,"PageNo": 1,"ExecutionStartDate": "2023-10-04","ExecutionEndDate": "2023-10-04","Grades": ["Low"],"Status": ["Waiting"],"EventTypes": ["InstanceMigration"]}

Output Example{"Response": {"RedisInstanceEvents": [{"EffectInfo": "Momentary disconnection that lasts for several seconds will occur
after the migration is completed.","EndTime": "22:00","ExecutionDate": "2023-09-18","Grade": "Low","ID": 10,
"InitialExecutionDate": "2023-08-19","InstanceId": "crs-b6wst31p","InstanceName": "benyqhuang8","LatestExecutionDate": "2023-09-18","StartTime": "21:00","Status": "Waiting","TaskEndTime": "0000-00-00 00:00:00","Type": "InstanceMigration"}],"RequestId": "36a33a3d-f9ce-47c1-87d0-84869a37466d","TotalCount": 1©2013-2022 Tencent Cloud. All rights reserved.

Page 313 of 500

TencentDB for Redis}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InternalError.DbOperationFailed

Internal system error with the database operation, which may
be update, insert, select, etc.

InvalidParameter.ActionNotFoundThe corresponding API was not found.

InvalidParameter.InvalidParameter

Invalid service parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

©2013-2022 Tencent Cloud. All rights reserved.

Page 314 of 500

TencentDB for Redis

UnsupportedOperation.InstanceNotOperation©2013-2022 Tencent Cloud. All rights reserved.

Unsupported operation

Page 315 of 500

TencentDB for Redis

ModifyInstanceAvailabilityZones：

Last updated 2024-04-03 11:33:05

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to change the availability zone of the instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

Name

Description
Common Params. The value used for this API:
ModifyInstanceAvailabilityZones.

Specify the instance ID.
InstanceId

Yes

StringFor example: crs-xjhsdj****, please log in to the [Redis
Console] (https://console.tencentcloud.com/redis#/) and copy
the instance ID from the instance list.

SwitchOption

Yes

Integer

Switch time.
- 1: Switch during the maintenance window.
- 2: Switch immediately.

NodeSet.N

Yes

Array of

Instance node information includes the node ID, node type,

RedisNodeInfo

and node availability zone ID, and so on. For specific©2013-2022 Tencent Cloud. All rights reserved.

Page 316 of 500

TencentDB for Redis

information, please see RedisNodeInfo .
For instances in a single availability zone, there is no need toconfigure the NodeId. For instances in multiple availability
zones, the NodeId is required to configure.

3. Output Parameters
Parameter
Name
TaskIdType

Description

Integer

Task ID.
The unique request ID, generated by the server, will be returned for every request (ifRequestId

Stringthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample 1
This example shows you how to change the availability zones of multiple AZ instances (time window switch).
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyInstanceAvailabilityZones<Common request parameters>{"InstanceId": "crs-rrhr1lm6","SwitchOption": 1,"NodeSet": [{"NodeId": 339472,"NodeType": 0,"ZoneId": 100004},{"NodeId": 339473,"NodeType": 1,"ZoneId": 100003©2013-2022 Tencent Cloud. All rights reserved.

Page 317 of 500

TencentDB for Redis},{"NodeId": 339549,"NodeType": 1,"ZoneId": 100003}]}

Output Example{"Response": {"RequestId": "27c0d6e8-9894-42e0-a03b-814a204437ba","TaskId": 2031290200}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error Code©2013-2022 Tencent Cloud. All rights reserved.

Page 318 of 500

TencentDB for Redis

The following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

FailedOperation.Unknown

Invalid data is entered for weekday.

InternalError.InternalError

Internal error.

InvalidParameter.InvalidParameter

Invalid service parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

InvalidParameterValue.CheckNotPass

Business verification failed

InvalidParameterValue.UnSupportedType

The instance type is not supported.

LimitExceeded.ReplicationGroupLocked

Replication group locked

ResourceInsufficient

The resource is insufficient.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

ResourceUnavailable.InstanceStatusAbnormal

The Redis status is exceptional, and the corresponding
process cannot be executed.

ResourceUnavailable.InstanceStatusError

Operation unsupported: the instance is exceptional.

UnsupportedOperation.InstanceNotOperation

Unsupported operation©2013-2022 Tencent Cloud. All rights reserved.

Page 319 of 500

TencentDB for Redis

ModifyInstanceEvent：

Last updated 2024-04-15 11:08:56

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to modify the operations event execution schedule of an instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: ModifyInstanceEvent.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

Name

Specifies the instance ID. Example: crs-xjhsdj****. Log in to the
InstanceId

Yes

StringTencentDB for Redis console and copy the instance ID in the
instance list.

EventId

Yes

Integer

Event ID. Obtain the ID of the event to be modified using
DescribeInstanceEvents.

StartTimeNo

StringModifies the scheduled start time of event execution.
Modifies the scheduled end time of event execution. After the start

EndTimeNo

Stringtime is configured, the end time can only be 30 minutes, 1 hour, 1.5
hours, 2 hours, or 3 hours later than the start time.

©2013-2022 Tencent Cloud. All rights reserved.

Page 320 of 500

TencentDB for Redis

ExecutionDate

No

StringModifies the start date of the event execution schedule.
Modifies the running status of the event. Currently, this parametercan be set only to Canceled, indicating that the execution of thecurrent event is canceled. You can query the running status and level

StatusNo

Stringof the current event using DescribeInstanceEvents.- Critical or Highevents cannot be canceled, which means that they must be
executed.- Only events in the Waiting state (to be executed) can becanceled.

3. Output Parameters
Parameter
Name

Type

Description

EventId

Integer

Event ID.
The unique request ID, generated by the server, will be returned for every request (ifRequestId

Stringthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Modifying Instance Event Information
This example shows you how to modify the instance event information.
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyInstanceEvent<Common request parameters>{"InstanceId": "crs-b6wst31p","EventId": 10,"StartTime": "22:00","EndTime": "23:01","ExecutionDate": "2023-09-18"}©2013-2022 Tencent Cloud. All rights reserved.

Page 321 of 500

TencentDB for Redis

Output Example{"Response": {"EventId": 10,"RequestId": "abc"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InternalError.DbOperationFailed

Internal system error with the database operation, which may
be update, insert, select, etc.

©2013-2022 Tencent Cloud. All rights reserved.

Page 322 of 500

TencentDB for Redis

InvalidParameter.InvalidParameter

Invalid service parameter.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

UnsupportedOperation.InstanceNotOperation

Unsupported operation©2013-2022 Tencent Cloud. All rights reserved.

Page 323 of 500

TencentDB for Redis

SwitchAccessNewInstance：

Last updated 2024-04-03 11:32:58

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to immediately switch instances that are in the time window pending switch operation. Users canmanually initiate this operation.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

Name

Description
Common Params. The value used for this API:
SwitchAccessNewInstance.

Specify the instance ID.
For example: crs-xjhsdj****. Please log in to the [Redis Console]
InstanceId

Yes

String(https://console.tencentcloud.com/redis#/) and copy the instance ID fromthe instance list.
Sample value: crs-asdasdas.

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 324 of 500

TencentDB for Redis

Parameter
Name

Type

Description
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample 1
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SwitchAccessNewInstance<Common request parameters>{"InstanceId": "crs-kf******"}

Output Example{"Response": {"RequestId": "dc7c5c1b-e0b4-4cbc-a1bf-b6fea3be9500"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP©2013-2022 Tencent Cloud. All rights reserved.

Page 325 of 500

TencentDB for Redis

Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.InternalError

Internal error.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

ResourceUnavailable.InstanceStatusAbnormal
ResourceUnavailable.InstanceStatusError©2013-2022 Tencent Cloud. All rights reserved.

The Redis status is exceptional, and the corresponding
process cannot be executed.
Operation unsupported: the instance is exceptional.

Page 326 of 500

TencentDB for Redis

DescribeInstanceSupportFeature：

Last updated 2024-04-03 11:33:20

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API (DescribeInstanceSupportFeature) is used to query the supported features of the instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

Name

Description
Common Params. The value used for this API:
DescribeInstanceSupportFeature.

Specify the instance ID.
InstanceId

Yes

StringFor example: crs-xjhsdj****. Please log in to the [Redis Console](https://console.tencentcloud.com/redis#/) and copy the instance ID
from the instance list.
Sample value: crs-asdasdas.

FeatureName

Yes

StringFeature names.
- Read-local-node-only: Proximity access feature.- multi-account:
Multiple accounts feature.

©2013-2022 Tencent Cloud. All rights reserved.

Page 327 of 500

TencentDB for Redis

3. Output Parameters
Parameter
Name
Support

RequestId

Type

Description

BooleanWhether to support.

String

The unique request ID, generated by the server, will be returned for every request (ifthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample 1
This example shows you how to query whether proximity access is supported.
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceSupportFeature<Common request parameters>{"InstanceId": "crs-fhsw2mh4","FeatureName": "read-local-node-only"}

Output Example{"Response": {"RequestId": "60b6c537-1021-4360-a7b9-90feaca647a1","Support": true}}

5. Developer Resources©2013-2022 Tencent Cloud. All rights reserved.

Page 328 of 500

TencentDB for Redis

SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.InternalError

Internal error.

InvalidParameter.ActionNotFoundThe corresponding API was not found.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

©2013-2022 Tencent Cloud. All rights reserved.

Page 329 of 500

TencentDB for Redis

Parameter Management APIs
ApplyParamsTemplate：

Last updated 2024-04-03 11:32:44

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to apply a parameter template to instances.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceIds.N

Yes

Array of
StringList of instance IDs

TemplateId

YesStringID of the parameter template to be applied

Description
Common Params. The value used for this API:
ApplyParamsTemplate.

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 330 of 500

TencentDB for Redis

Parameter

Type

Description

Name
Array
TaskIdsof

Task ID

Integer
The unique request ID, generated by the server, will be returned for every request (ifRequestId

Stringthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Modifying instance parameters
Input Example
https://redis.tencentcloudapi.com/?Action=ApplyParamsTemplate&InstanceIds.0=crs-5a4py64p&TemplateId=crs-cfg-rhlppeye&<Common request parameters>

Output Example{"Response": {"TaskIds": [
212,
213,
214
],
"RequestId": "e546784b-709c-401d-aba6-73037eb4e522"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to callAPIs.

©2013-2022 Tencent Cloud. All rights reserved.

Page 331 of 500

TencentDB for Redis

Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

FailedOperation.UnSupportError

The instance does not support this API.

InternalError.DbOperationFailed

Internal system error with the database operation, which may be
update, insert, select, etc.

InternalError.InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

ResourceUnavailable.CallOssError

Failed to call the backend API.

ResourceUnavailable.InstanceConfError

An instance configuration error occurred.

ResourceUnavailable.InstanceLockedError

Redis has been locked by another process.

ResourceUnavailable.InstanceStateError

Instance status error.

UnauthorizedOperation

The operation is unauthorized.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

©2013-2022 Tencent Cloud. All rights reserved.

Page 332 of 500

TencentDB for Redis

UnauthorizedOperation.UserNotInWhiteList©2013-2022 Tencent Cloud. All rights reserved.

The user is not in the allowlist.

Page 333 of 500

TencentDB for Redis

CreateParamTemplate：

Last updated 2024-04-03 11:32:43

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to create a parameter template.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

Name

Yes

StringParameter template name.

Description

No

StringParameter template description.

ProductType

No

Integer

Instance type. Valid values: 1 (Redis 2.8 Memory Edition in

Name

Description
Common Params. The value used for this API:
CreateParamTemplate.

cluster architecture), 2 (Redis 2.8 Memory Edition instandard architecture), 3 (CKV 3.2 Memory Edition instandard architecture), 4 (CKV 3.2 Memory Edition incluster architecture), 5 (Redis 2.8 Memory Edition instandalone architecture), 6 (Redis 4.0 Memory Edition in©2013-2022 Tencent Cloud. All rights reserved.

Page 334 of 500

TencentDB for Redisstandard architecture), 7 (Redis 4.0 Memory Edition incluster architecture), 8 (Redis 5.0 Memory Edition instandard architecture), 9 (Redis 5.0 Memory Edition incluster architecture). If TempateId is specified, thisparameter can be left blank; otherwise, it is required.
TemplateId

No

ParamList.N

No

StringArray of
InstanceParam

ID of the source parameter template.
Parameter list.

3. Output Parameters
Parameter
Name
TemplateId

Type

Description

StringParameter template ID.
The unique request ID, generated by the server, will be returned for every request (ifRequestId

Stringthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateParamTemplate<Common request parameters>{"ParamList": [{"Value": "120","Key": "timeout"}],"TemplateId": "crs-cfg-sa23d5d3",©2013-2022 Tencent Cloud. All rights reserved.

Page 335 of 500

TencentDB for Redis"Description": "MyCustomParamTemplate","ProductType": 6,"Name": "CustomParamTemplate"}

Output Example{"Response": {"TemplateId": "crs-cfg-sa23d5a2","RequestId": "0e728fa9-c2e5-4bf8-8d6b-c1c4fab7b6db"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error Code©2013-2022 Tencent Cloud. All rights reserved.

Description

Page 336 of 500

TencentDB for Redis

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InternalError.InternalError

Internal error.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

UnauthorizedOperation.UserNotInWhiteList

The user is not in the allowlist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 337 of 500

TencentDB for Redis

DeleteParamTemplate：

Last updated 2024-04-03 11:32:43

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to delete a parameter template.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

TemplateId

YesStringParameter template ID.

Name

Description
Common Params. The value used for this API:
DeleteParamTemplate.

3. Output Parameters
Parameter
Name

Type

Description

RequestId

String

The unique request ID, generated by the server, will be returned for every request (if the©2013-2022 Tencent Cloud. All rights reserved.

Page 338 of 500

TencentDB for Redis

request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteParamTemplate<Common request parameters>{"TemplateId": "crs-cfg-sa23d5d3"}

Output Example{"Response": {"RequestId": "0e728fa9-c2e5-4bf8-8d6b-c1c4fab7b6db"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET

©2013-2022 Tencent Cloud. All rights reserved.

Page 339 of 500

TencentDB for Redis

Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InternalError.InternalError

Internal error.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

UnauthorizedOperation.UserNotInWhiteList

The user is not in the allowlist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 340 of 500

TencentDB for Redis

DescribeInstanceParamRecords：

Last updated 2024-04-03 11:32:42

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the list of parameter modifications.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID

Limit

No

IntegerMaximum number of results returned per page

OffsetNo

Integer

Offset, which is an integral multiple of Limit .

Name

Description
Common Params. The value used for this API:
DescribeInstanceParamRecords.

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 341 of 500

TencentDB for Redis

Parameter NameType

Description

TotalCount

Integer

Total number of modifications.

InstanceParamHistory

Array of
InstanceParamHistory

Information of modifications.
The unique request ID, generated by the server, will be

RequestId

Stringreturned for every request (if the request fails to reach theserver for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Querying the list of parameter modifications
Input Example
https://redis.tencentcloudapi.com/?Action=DescribeInstanceParamRecords&InstanceId=crs-5a4py64p&<Common request parameters>

Output Example{"Response": {"InstanceParamHistory": [{"ModifyTime": "2019-01-07 11:28:58","NewValue": "511","ParamName": "hash-max-ziplist-entries","PreValue": "512","Status": 2},{"ModifyTime": "2019-01-07 11:28:48","NewValue": "15001","ParamName": "cluster-node-timeout","PreValue": "15000","Status": 2}],"RequestId": "e546784b-709c-401d-aba6-73037eb4e522","TotalCount": 2©2013-2022 Tencent Cloud. All rights reserved.

Page 342 of 500

TencentDB for Redis}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error Code
FailedOperation.SystemError

InternalError.DbOperationFailed

Description
Internal system error, which is irrelevant to thebusiness.
Internal system error with the database operation,
which may be update, insert, select, etc.

InternalError.InternalError

Internal error.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

ResourceUnavailable.InstanceStatusError

Operation unsupported: the instance is exceptional.

©2013-2022 Tencent Cloud. All rights reserved.

Page 343 of 500

TencentDB for Redis

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

UnauthorizedOperation.UserNotInWhiteList

The user is not in the allowlist.

UnsupportedOperation.ClusterInstanceAccessedDeny

The Redis cluster edition is not allowed to connect toa security group.

©2013-2022 Tencent Cloud. All rights reserved.

Page 344 of 500

TencentDB for Redis

DescribeInstanceParams：

Last updated 2024-04-03 11:32:41

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the parameter list of an instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeInstanceParams.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

StringName

ID of a specified instance, such as "crs-xjhsdj****" Log in to the Redis
console and copy the instance ID in the instance list.

3. Output Parameters
Parameter NameType

Description

TotalCount

Integer

Total number of the parameter lists©2013-2022 Tencent Cloud. All rights reserved.

Page 345 of 500

TencentDB for Redis

InstanceEnumParam

Array of

Instance parameter in Enum typeInstanceEnumParam
InstanceIntegerParam

InstanceTextParam

InstanceMultiParam

RequestId

Array of
InstanceIntegerParam
Array of
InstanceTextParam
Array of
InstanceMultiParamString

Instance parameter in Integer typeInstance parameter in Char typeInstance parameter in Multi typeThe unique request ID, generated by the server, will be
returned for every request (if the request fails to reach theserver for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Querying the list of instance parameters
This example shows you how to query the parameter information of a specified instance.
Input Example
https://redis.tencentcloudapi.com/?Action=DescribeInstanceParams&InstanceId=crs-5
a4p****&<Common request parameters>

Output Example{"Response": {"InstanceEnumParam": [{"CurrentValue": "yes","DefaultValue": "yes","EnumValue": ["yes","no"],"NeedRestart": "false","ParamName": "lazyfree-lazy-eviction","Status": 2,"Tips": "lazyfree switch on eviction",©2013-2022 Tencent Cloud. All rights reserved.

Page 346 of 500

TencentDB for Redis"ValueType": "enum"},{"CurrentValue": "yes","DefaultValue": "yes","EnumValue": ["yes","no"],"NeedRestart": "false","ParamName": "lazyfree-lazy-expire","Status": 2,"Tips": "lazyfree switch on expire","ValueType": "enum"},{"CurrentValue": "yes","DefaultValue": "yes","EnumValue": ["yes","no"],"NeedRestart": "lazyfree-lazy-server-del","Status": 2,"Tips": "lazyfree switch on server implicit deletion","ValueType": "enum"},{"CurrentValue": "noeviction","DefaultValue": "noeviction","EnumValue": ["volatile-lru","volatile-lfu","allkeys-lru","allkeys-lfu","volatile-random","allkeys-random","volatile-ttl","noeviction"],"NeedRestart": "false","ParamName": "maxmemory-policy","Status": 2,"Tips": "How Redis will select what to remove when maxmemory is reached","ValueType": "enum"},{©2013-2022 Tencent Cloud. All rights reserved.

Page 347 of 500

TencentDB for Redis"CurrentValue": "yes","DefaultValue": "yes","EnumValue": ["yes","no"],"NeedRestart": "false","ParamName": "replica-lazy-flush","Status": 2,"Tips": "lazyfree switch on full resynchronization","ValueType": "enum"},{"CurrentValue": "no","DefaultValue": "no","EnumValue": ["yes","no"],"NeedRestart": "false","ParamName": "sentineauth","Status": 2,"Tips": "Executing a sentinel order eliminates the password","ValueType": "enum"}],"InstanceIntegerParam": [{"CurrentValue": "15000","DefaultValue": "15000","Max": "120000","Min": "15000","NeedRestart": "false","ParamName": "cluster-node-timeout","Status": 2,"Tips": "Cluster node timeout is the amount of milliseconds a node must be unreac
hable for it to be considered in failure state","Unit": "","ValueType": "integer"},{"CurrentValue": "512","DefaultValue": "512","Max": "10000","Min": "1",
"NeedRestart": "false","ParamName": "hash-max-ziplist-entries",©2013-2022 Tencent Cloud. All rights reserved.

Page 348 of 500

TencentDB for Redis"Status": 2,"Tips": "Hashes are encoded using a memory efficient data structure when they hav
e a small number of entries","Unit": "","ValueType": "integer"},{"CurrentValue": "64","DefaultValue": "64","Max": "10000","Min": "1",
"NeedRestart": "false","ParamName": "hash-max-ziplist-value","Status": 2,"Tips": "Hashes are encoded using a memory efficient data structure when the bigg
est entry does not exceed a given threshold","Unit": "","ValueType": "integer"},{"CurrentValue": "10","DefaultValue": "10","Max": "500","Min": "1",
"NeedRestart": "false","ParamName": "hz","Status": 2,"Tips": "The frequency at which Redis background tasks are performed. A higher va
lue results in higher CPU consumption but smaller latency. We recommend that you
do not specify a value larger than 100.","Unit": "","ValueType": "integer"},{"CurrentValue": "500","DefaultValue": "500","Max": "1000","Min": "10","NeedRestart": "false","ParamName": "proxy-slowlog-log-slower-than","Status": 2,"Tips": "the commands over this time will in proxy","Unit": "ms","ValueType": "integer"},{"CurrentValue": "512",©2013-2022 Tencent Cloud. All rights reserved.

Page 349 of 500

TencentDB for Redis"DefaultValue": "512","Max": "10000","Min": "1",
"NeedRestart": "false","ParamName": "set-max-intset-entries","Status": 2,"Tips": "When a set is composed of just strings that happen to be integers in radix 10 in the range of 64 bit signed integers.","Unit": "","ValueType": "integer"},{"CurrentValue": "10","DefaultValue": "10","Max": "1000","Min": "1",
"NeedRestart": "false","ParamName": "slowlog-log-slower-than","Status": 2,"Tips": "Over this time the command is recorded in us.a negative number disables
the slow log,a value of zero forces the logging of every command","Unit": "ms","ValueType": "integer"},{"CurrentValue": "31536000","DefaultValue": "31536000","Max": "2147483647","Min": "60","NeedRestart": "false","ParamName": "timeout","Status": 2,"Tips": "Close the connection after a client is idle for N seconds","Unit": "","ValueType": "integer"},{"CurrentValue": "128","DefaultValue": "128","Max": "10000","Min": "1",
"NeedRestart": "false","ParamName": "zset-max-ziplist-entries","Status": 2,"Tips": "Sorted sets are encoded using a memory efficient data structure when they have a small number of entries.","Unit": "",©2013-2022 Tencent Cloud. All rights reserved.

Page 350 of 500

TencentDB for Redis"ValueType": "integer"},{"CurrentValue": "64","DefaultValue": "64","Max": "10000","Min": "1",
"NeedRestart": "false","ParamName": "zset-max-ziplist-value","Status": 2,"Tips": "Sorted sets are encoded using a memory efficient data structure when the
biggest entry does not exceed a given threshold.","Unit": "","ValueType": "integer"}],"InstanceMultiParam": [{"CurrentValue": "\"\"","DefaultValue": "\"\"","EnumValue": ["flushall","flushdb","keys","hgetall","eval","evalsha","script","scan","psetex","set","hmset","hset","lpush","rpush","sadd","zadd","del","mget","mset","bitop","exists","msetnx","blpop","brpop","rpoplpush","brpoplpush",©2013-2022 Tencent Cloud. All rights reserved.

Page 351 of 500

TencentDB for Redis"smove","sunion","sinter","sdiff","sunionstore","sinterstore","sdiffstore","zunionstore","zinterstore","pfmerge","pfcount"],"NeedRestart": "false","ParamName": "disable-command-list","Status": 2,"Tips": "commands in such config will not be allowed to run in this instance,you
can config multi commands like this 'flushdb,keys'","ValueType": "multi"}],"InstanceTextParam": [{"CurrentValue": "\"\"","DefaultValue": "\"\"","NeedRestart": "false","ParamName": "notify-keyspace-events","Status": 2,"TextValue": [
"K",
"E",
"g",
"$",
"l",
"s",
"h",
"z",
"x",
"e",
"A"
],
"Tips": "Changes in key space notification to registered clients","ValueType": "text"}],"RequestId": "a4abf600-2813-4c5b-a3f8-fc4268efd151","TotalCount": 18©2013-2022 Tencent Cloud. All rights reserved.

Page 352 of 500

TencentDB for Redis}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error Code
FailedOperation.SystemError
FailedOperation.UnSupportError
InternalError.DbOperationFailed

Description
Internal system error, which is irrelevant to thebusiness.
The instance does not support this API.
Internal system error with the database operation,
which may be update, insert, select, etc.

InternalError.InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

©2013-2022 Tencent Cloud. All rights reserved.

Page 353 of 500

TencentDB for Redis

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

ResourceUnavailable.InstanceStatusError

Operation unsupported: the instance is exceptional.

UnauthorizedOperation

The operation is unauthorized.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

UnauthorizedOperation.UserNotInWhiteList

The user is not in the allowlist.

UnsupportedOperation.ClusterInstanceAccessedDeny©2013-2022 Tencent Cloud. All rights reserved.

The Redis cluster edition is not allowed to connect toa security group.

Page 354 of 500

TencentDB for Redis

DescribeInstanceSecurityGroup：

Last updated 2024-04-03 11:32:41

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the security group information of an instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceIds.N

Yes

Array of
StringList of instance IDs, such as "crs-f2ho5rsz\n".

Description
Common Params. The value used for this API:
DescribeInstanceSecurityGroup.

3. Output Parameters
Parameter NameType

Description

InstanceSecurityGroupsDetail

Array of

Security group information of an instance©2013-2022 Tencent Cloud. All rights reserved.

Page 355 of 500

TencentDB for Redis

InstanceSecurityGroupDetailThe unique request ID, generated by theserver, will be returned for every request (ifRequestId

Stringthe request fails to reach the server for otherreasons, the request will not obtain a
RequestId). RequestId is required forlocating a problem.

4. Example
Example1 Sample request
This example shows you how to query a security group.
Input Example
https://redis.tencentcloudapi.com/?Action=DescribeInstanceSecurityGroup&InstanceI
ds.0=crs-f2ho****&<Common request parameters>

Output Example{"Response": {"InstanceSecurityGroupsDetail": [{"InstanceId": "crs-f2ho****","SecurityGroupDetails": [{"CreateTime": "2018-01-30 15:58:00","InboundRule": [{"Action": "ACCEPT","Ip": "0.0.0.0/0","Port": "ALL","Proto": "ALL"},{"Action": "ACCEPT","Ip": "0.0.0.0/0","Port": "ALL","Proto": "ALL"}],©2013-2022 Tencent Cloud. All rights reserved.

Page 356 of 500

TencentDB for Redis"OutboundRule": [{"Action": "ACCEPT","Ip": "0.0.0.0/0","Port": "ALL","Proto": "ALL"}],"ProjectId": 0,"SecurityGroupId": "sg-gl1egaj1","SecurityGroupName": "all","SecurityGroupRemark": ""}]}],"RequestId": "e546784b-709c-401d-aba6-73037eb4e522"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error Code©2013-2022 Tencent Cloud. All rights reserved.

Page 357 of 500

TencentDB for Redis

The following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InternalError.DbOperationFailed

Internal system error with the database operation, which may be
update, insert, select, etc.

InternalError.InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

UnauthorizedOperation

The operation is unauthorized.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

UnauthorizedOperation.UserNotInWhiteList

The user is not in the allowlist.

UnsupportedOperation

The operation is not supported.

©2013-2022 Tencent Cloud. All rights reserved.

Page 358 of 500

TencentDB for Redis

DescribeParamTemplates：

Last updated 2024-04-03 11:32:40

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the list of parameter templates.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

Common Params. The value used for this API:
DescribeParamTemplates.

Array of instance types. Valid values: 1 (Redis 2.8 Memory
Edition in cluster architecture), 2 (Redis 2.8 Memory Editionin standard architecture), 3 (CKV 3.2 Memory Edition in
Array
ProductTypes.N

Noof
Integerstandard architecture), 4 (CKV 3.2 Memory Edition in clusterarchitecture), 5 (Redis 2.8 Memory Edition in standalonearchitecture), 6 (Redis 4.0 Memory Edition in standard
architecture), 7 (Redis 4.0 Memory Edition in clusterarchitecture), 8 (Redis 5.0 Memory Edition in standard
architecture), 9 (Redis 5.0 Memory Edition in clusterarchitecture).

©2013-2022 Tencent Cloud. All rights reserved.

Page 359 of 500

TencentDB for Redis

TemplateNames.N

No

Array
of

Array of template names.

StringArray
TemplateIds.N

No

ofArray of template IDs.

String

3. Output Parameters
Parameter

Type

Description

TotalCount

IntegerNumber of parameter templates of the user.

Items

Array of
ParamTemplateInfo

Parameter template details.

Name

The unique request ID, generated by the server, will be returned for every
RequestId

Stringrequest (if the request fails to reach the server for other reasons, therequest will not obtain a RequestId). RequestId is required for locating aproblem.

4. Example
Example1 Sample request
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeParamTemplates<Common request parameters>{}

Output Example{"Response": {©2013-2022 Tencent Cloud. All rights reserved.

Page 360 of 500

TencentDB for Redis"TotalCount": 1,"RequestId": "0e728fa9-c2e5-4bf8-8d6b-c1c4fab7b6db","Items": [{"Name": "CustomParamTemplate","Description": "MyCustomParamTemplate","ProductType": 6,"TemplateId": "crs-cfg-sa23d5d3"}]}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

©2013-2022 Tencent Cloud. All rights reserved.

Page 361 of 500

TencentDB for Redis

InternalError.InternalError

Internal error.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

UnauthorizedOperation.UserNotInWhiteList

The user is not in the allowlist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 362 of 500

TencentDB for Redis

DescribeProjectSecurityGroup：

Last updated 2024-04-03 11:32:39

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the security group information of a project.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeProjectSecurityGroup.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

ProjectId

No

Integer

0: default project; -1: all projects; >0: specified project

SecurityGroupId

No

StringSecurity group ID

Name

3. Output Parameters
Parameter Name

Type©2013-2022 Tencent Cloud. All rights reserved.

Description

Page 363 of 500

TencentDB for Redis

SecurityGroupDetails

Array of

Security group of the project

SecurityGroupDetailThe unique request ID, generated by the server, will be
RequestId

Stringreturned for every request (if the request fails to reach theserver for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Querying the security group information of project
Input Example
https://redis.tencentcloudapi.com/?Action=DescribeProjectSecurityGroup&SecurityGroupId=sg-gl1egaj1&<Common request parameters>

Output Example{"Response": {"RequestId": "4cc888c8-cc1c-4a77-9259-dd0f6907b559","SecurityGroupDetails": [{"CreateTime": "2018-01-30 15:58:00","InboundRule": [{"Action": "ACCEPT","Ip": "0.0.0.0/0","Port": "ALL","Proto": "ALL"},{"Action": "ACCEPT","Ip": "0.0.0.0/0","Port": "ALL","Proto": "ALL"}],"OutboundRule": [{"Action": "ACCEPT","Ip": "0.0.0.0/0",©2013-2022 Tencent Cloud. All rights reserved.

Page 364 of 500

TencentDB for Redis"Port": "ALL","Proto": "ALL"}],"ProjectId": 0,"SecurityGroupId": "sg-gl1egaj1","SecurityGroupName": "all","SecurityGroupRemark": ""}]}}5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

©2013-2022 Tencent Cloud. All rights reserved.

Page 365 of 500

TencentDB for Redis

InternalError.DbOperationFailed

Internal system error with the database operation, which
may be update, insert, select, etc.

InternalError.InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

ResourceUnavailable.GetSecurityError

Failed to get the security group information.

ResourceUnavailable.SecurityGroupNotSupported

The product has not been connected to any security
group.

UnauthorizedOperation

The operation is unauthorized.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

UnauthorizedOperation.UserNotInWhiteList

The user is not in the allowlist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 366 of 500

TencentDB for Redis

ModifyConnectionConfig：

Last updated 2024-04-15 11:08:54

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to modify the connection configuration of an instance, including the bandwidth and maximum numberof connections.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: ModifyConnectionConfig.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID, which can contain 12 to 36 characters.

BandwidthNo

Integer

Additional bandwidth in MB, which should be greater than 0.

ClientLimitNo

Integer

Total number of connections of a single shard.When read-only replicas
are not enabled, the lower limit is 10,000, and the upper limit is40,000.When read-only replicas are enabled, the lower limit is 10,000,
and the upper limit is 10,000 × (the number of read-only replicas + 3).

©2013-2022 Tencent Cloud. All rights reserved.

Page 367 of 500

TencentDB for Redis

3. Output Parameters
Parameter
Name

Type

Description

TaskIdInteger

Task ID.
The unique request ID, generated by the server, will be returned for every request (ifRequestId

Stringthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Request Sample
Input Example
https://redis.tencentcloudapi.com/?Action=ModifyConnectionConfig&InstanceId=crs-cpz6b1fn&Bandwidth=5&ClientLimit=20000&<Common request parameters>

Output Example{"Response": {"RequestId": "950088b4-c71f-4bb3-ae6d-a0d0569f8666","TaskId": 95027}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python©2013-2022 Tencent Cloud. All rights reserved.

Page 368 of 500

TencentDB for Redis

Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

©2013-2022 Tencent Cloud. All rights reserved.

Page 369 of 500

TencentDB for Redis

ModifyInstanceParams：

Last updated 2024-04-03 11:32:39

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to modify the parameters of TencentDB for Redis instances
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
ModifyInstanceParams.

VersionYes

StringRegionNo

String

InstanceId

Yes

String

Instance ID

InstanceParams.N

Yes

Array of
InstanceParam

List of instance parameters modified

Common Params. The value used for this API: 201804-12.
Common Params. This parameter is not required forthis API.

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 370 of 500

TencentDB for Redis

Parameter
Name

Type

Description

Whether the parameter is modified successfully.
ChangedBooleanTrue : Yes
False : No

TaskIdInteger

ID of the task
The unique request ID, generated by the server, will be returned for every request (ifRequestId

Stringthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Modifying Instance Parameters
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyInstanceParams<Common request parameters>{"InstanceId": "crs-5a4py64p","InstanceParams": [{"Value": "120","Key": "timeout"}]}

Output Example{"Response": {"Changed": false,"TaskId": 327,
"RequestId": "e546784b-709c-401d-aba6-73037eb4e522"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 371 of 500

TencentDB for Redis

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.UnSupportError

The instance does not support this API.

InternalError.DbOperationFailed

Internal system error with the database operation, which may be
update, insert, select, etc.

InternalError.InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

ResourceUnavailable.CallOssError

Failed to call the backend API.

©2013-2022 Tencent Cloud. All rights reserved.

Page 372 of 500

TencentDB for Redis

ResourceUnavailable.InstanceConfError

An instance configuration error occurred.

ResourceUnavailable.InstanceLockedError

Redis has been locked by another process.

ResourceUnavailable.InstanceStateError

Instance status error.

UnauthorizedOperation

The operation is unauthorized.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

UnauthorizedOperation.UserNotInWhiteList

The user is not in the allowlist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 373 of 500

TencentDB for Redis

ModifyParamTemplate：

Last updated 2024-04-03 11:32:38

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to modify a parameter template.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
ModifyParamTemplate.

VersionYes

StringCommon Params. The value used for this API: 2018-0412.

RegionNo

StringTemplateId

YesStringID of the source parameter template.

Name

No

String

New name after the parameter template is modified.

Description

No

String

New description after the parameter template is modified.

ParamList.N

No

Array ofNew parameter list after the parameter template is

InstanceParam

modified.

Name©2013-2022 Tencent Cloud. All rights reserved.

Common Params. This parameter is not required for thisAPI.

Page 374 of 500

TencentDB for Redis

3. Output Parameters
Parameter
Name

Type

Description
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyParamTemplate<Common request parameters>{"ParamList": [{"Value": "120","Key": "timeout"}],"TemplateId": "crs-cfg-sa23d5d3","Description": "MyCustomParamTemplate","Name": "CustomParamTemplate"}

Output Example{"Response": {"RequestId": "0e728fa9-c2e5-4bf8-8d6b-c1c4fab7b6db"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 375 of 500

TencentDB for Redis

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InternalError.InternalError

Internal error.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

UnauthorizedOperation.UserNotInWhiteList

The user is not in the allowlist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 376 of 500

TencentDB for Redis

Other APIs
AssociateSecurityGroups：

Last updated 2024-04-03 11:32:48

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to bind a security group to instances in batches.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

Product

Yes

StringDatabase engine name, which is redis for this API.

SecurityGroupId

YesStringID of the security group to be associated in the format of sgefil73jd.

Yes

Array
of

ID(s) of the instance(s) to be associated in the format of ins-

Name

InstanceIds.N

String©2013-2022 Tencent Cloud. All rights reserved.

Description
Common Params. The value used for this API:
AssociateSecurityGroups.

lesecurk. You can specify multiple instances.

Page 377 of 500

TencentDB for Redis

3. Output Parameters
Parameter
Name

RequestId

Type

Description

String

The unique request ID, generated by the server, will be returned for every request (if therequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AssociateSecurityGroups<Common request parameters>{"Product": "redis","SecurityGroupId": "sg-ajr1jzgj","InstanceIds": ["crs-eb2w7dto"]}

Output Example{"Response": {"RequestId": "1a42feb9-82087f71-6a0031ac-699a92a1"}}

5. Developer Resources
SDK©2013-2022 Tencent Cloud. All rights reserved.

Page 378 of 500

TencentDB for Redis

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.AddInstanceInfoFailed

Failed to add the security group information of theinstance.

FailedOperation.AssociateSecurityGroupsFailed

Failed to associate the security group.

FailedOperation.ClearInstanceInfoFailed

Failed to clear the security group information of theinstance.

FailedOperation.DisassociateSecurityGroupsFailed

Failed to unbind the security group.

FailedOperation.UpdateSecurityGroupsFailed

Failed to update the security group.

InternalError.InstanceOperatePermissionError

You do not have the operation permission.

InternalError.ListInstancesError

An error occurred while obtaining the list of instances.
Try again later.

InvalidParameter.InstanceSGOverLimitError

The security groups of the instance exceeds the limit.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

©2013-2022 Tencent Cloud. All rights reserved.

Page 379 of 500

TencentDB for Redis

DescribeDBSecurityGroups：

Last updated 2024-04-03 11:32:47

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the security group details of an instance.
A maximum of 100 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeDBSecurityGroups.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

Product

Yes

StringDatabase engine name, which is redis for this API.

InstanceId

Yes

StringID of the specified instance, such as "crs-xjhsdj****" Log in to the Redis
console and copy the instance ID in the instance list.

Name

3. Output Parameters
Parameter

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 380 of 500

TencentDB for Redis

NameGroupsArray of
SecurityGroup

Security group rules

VIP

StringPrivate IPv4 address of an instance

VPort

StringPrivate network port
The unique request ID, generated by the server, will be returned for every

RequestId

Stringrequest (if the request fails to reach the server for other reasons, the request
will not obtain a RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
This example shows you how to query the security group information of a specified instance.
Input Example
POST / HTTP/1.1Host: redis.tencentcloudapi.comContent-Type: application/jsonX-TCAction: DescribeDBSecurityGroups<Common request parameters>{ "Product": "redis","InstanceId": "crs-m1kxvlkf"}

Output Example{"Response": {"Groups": [{"CreateTime": "2023-04-26 17:40:29","Inbound": [{"Action": "ACCEPT","AddressModule": "","CidrIp": "106.55.103.75","Desc": "","Id": "",
"IpProtocol": "tcp","PortRange": "8000","ServiceModule": ""},{©2013-2022 Tencent Cloud. All rights reserved.

Page 381 of 500

TencentDB for Redis"Action": "ACCEPT","AddressModule": "","CidrIp": "119.147.10.191","Desc": "bro-local public network IP",
"Id": "",
"IpProtocol": "tcp","PortRange": "8000","ServiceModule": ""},{"Action": "ACCEPT","AddressModule": "","CidrIp": "43.136.90.27","Desc": "CVM-public network","Id": "",
"IpProtocol": "tcp","PortRange": "8000","ServiceModule": ""}],"Outbound": [],"ProjectId": 0,"SecurityGroupId": "sg-7y0pa6nf","SecurityGroupName": "test_lb","SecurityGroupRemark": "custom"}],"RequestId": "d6b8d050-f113-4db3-a85e-ca8122deddce","VIP": "10.0.4.13","VPort": "6379"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go©2013-2022 Tencent Cloud. All rights reserved.

Page 382 of 500

TencentDB for Redis

Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.AddInstanceInfoFailed

Failed to add the security group information of theinstance.

FailedOperation.AssociateSecurityGroupsFailed

Failed to associate the security group.

FailedOperation.ClearInstanceInfoFailed

Failed to clear the security group information of theinstance.

FailedOperation.DisassociateSecurityGroupsFailed

Failed to unbind the security group.

FailedOperation.GetSecurityGroupDetailFailed

Failed to query the security group details. Try again
later.

InternalError.CamAuthOssResponseReturnCodeError

A CAM authentication error occurred.

InternalError.ExecHttpRequestError

Failed to execute the HTTP request. Try again later.

InternalError.ListInstancesError

An error occurred while obtaining the list of instances.
Try again later.

InternalError.NetWorkErr

A network error occurred.

InvalidParameter.ActionNotFoundThe corresponding API was not found.

InvalidParameter.IllegalParameterError

Invalid parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

ResourceNotFound.InstanceNotFoundThe instance was not found.

©2013-2022 Tencent Cloud. All rights reserved.

Page 383 of 500

TencentDB for Redis

DescribeProjectSecurityGroups：

Last updated 2024-04-03 11:32:47

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the security group details of a project.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeProjectSecurityGroups.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

Product

Yes

StringDatabase engine name, which is redis for this API.

ProjectId

Yes

Integer

Project ID

OffsetNo

Integer

Offset, which is an integral multiple of Limit .

Limit

No

Integer

The number of security groups to be pulled. Default value: 20 .

SearchKey

No

StringSearch criteria. You can enter a security group ID or name.

©2013-2022 Tencent Cloud. All rights reserved.

Page 384 of 500

TencentDB for Redis

3. Output Parameters
Parameter

Type

Description

GroupsArray of
SecurityGroup

Security group rules.

Total

Integer

Total number of eligible security groups.

String

The unique request ID, generated by the server, will be returned for every
request (if the request fails to reach the server for other reasons, the request

Name

RequestId

will not obtain a RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProjectSecurityGroups<Common request parameters>{"ProjectId": "11954","Product": "redis"}

Output Example{"Response": {"Total": 1,"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A1","Groups": [{"Outbound": [],"SecurityGroupName": "CDB","Inbound": [],"ProjectId": 0,©2013-2022 Tencent Cloud. All rights reserved.

Page 385 of 500

TencentDB for Redis"SecurityGroupId": "sg-ajr1jzgj","SecurityGroupRemark": "","CreateTime": "2017-04-13 15:00:06"}]}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error Code
FailedOperation.AddInstanceInfoFailed
FailedOperation.AssociateSecurityGroupsFailed
FailedOperation.ClearInstanceInfoFailed©2013-2022 Tencent Cloud. All rights reserved.

Description
Failed to add the security group information of theinstance.
Failed to associate the security group.
Failed to clear the security group information of theinstance.

Page 386 of 500

TencentDB for Redis

FailedOperation.DisassociateSecurityGroupsFailed
FailedOperation.DtsStatusAbnormal

Failed to unbind the security group.
This operation is not allowed under the current DTS
status.

FailedOperation.FlowNotExists

No process exists.

InvalidParameter.ActionNotFoundThe corresponding API was not found.

InvalidParameter.IllegalParameterError

Invalid parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

©2013-2022 Tencent Cloud. All rights reserved.

Page 387 of 500

TencentDB for Redis

DisassociateSecurityGroups：

Last updated 2024-04-03 11:32:46

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to unbind a security group from instances in batches.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

Product

Yes

StringDatabase engine name, which is redis for this API.

SecurityGroupId

YesStringSecurity group ID

InstanceIds.N

Yes

Array of
StringList of instance IDs, which is an array of one or more instanceIDs.

Description
Common Params. The value used for this API:
DisassociateSecurityGroups.

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 388 of 500

TencentDB for Redis

Parameter
Name

RequestId

Type

Description

String

The unique request ID, generated by the server, will be returned for every request (if therequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DisassociateSecurityGroups<Common request parameters>{"Product": "redis","SecurityGroupId": "sg-ajr1jzgj","InstanceIds": ["crs-eb2w7dto"]}

Output Example{"Response": {"RequestId": "1a42feb9-82087f71-6a0031ac-699a92a1"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to callAPIs.

©2013-2022 Tencent Cloud. All rights reserved.

Page 389 of 500

TencentDB for Redis

Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.AddInstanceInfoFailed

Failed to add the security group information of theinstance.

FailedOperation.AssociateSecurityGroupsFailed

Failed to associate the security group.

FailedOperation.ClearInstanceInfoFailed

Failed to clear the security group information of theinstance.

FailedOperation.DisassociateSecurityGroupsFailed

Failed to unbind the security group.

InternalError.InstanceOperatePermissionError

You do not have the operation permission.

InternalError.ListInstancesError

An error occurred while obtaining the list of instances.
Try again later.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

ResourceNotFound.InstanceNotFoundThe instance was not found.

©2013-2022 Tencent Cloud. All rights reserved.

Page 390 of 500

TencentDB for Redis

ModifyDBInstanceSecurityGroups：

Last updated 2024-04-03 11:32:45

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to modify the security groups bound to an instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

Product

Yes

StringDatabase engine name, which is redis for this API.

Yes

Array
of

SecurityGroupIds.N

StringDescription
Common Params. The value used for this API:
ModifyDBInstanceSecurityGroups.

List of IDs of security groups to be modified, which is an array of
one or more security group IDs.
Instance ID in the format of cdb-c1nl9rpv or cdbro-c1nl9rpv. It is

InstanceId

Yes

String©2013-2022 Tencent Cloud. All rights reserved.

the same as the instance ID displayed in the TencentDB
console.

Page 391 of 500

TencentDB for Redis

3. Output Parameters
Parameter
Name

Type

Description
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDBInstanceSecurityGroups<Common request parameters>{"InstanceId": "crs-eb2w7dto","Product": "redis","SecurityGroupIds": ["sg-ajr1jzgj"]}

Output Example{"Response": {"RequestId": "1a42feb9-82087f71-6a0031ac-699a92a1"}}

5. Developer Resources
SDK©2013-2022 Tencent Cloud. All rights reserved.

Page 392 of 500

TencentDB for Redis

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.AddInstanceInfoFailed

Failed to add the security group information of theinstance.

FailedOperation.AssociateSecurityGroupsFailed

Failed to associate the security group.

FailedOperation.ClearInstanceInfoFailed

Failed to clear the security group information of theinstance.

FailedOperation.DisassociateSecurityGroupsFailed

Failed to unbind the security group.

FailedOperation.GetSecurityGroupDetailFailed

Failed to query the security group details. Try again later.

FailedOperation.SetRuleLocationFailed

Failed to set the rule.

FailedOperation.UpdateInstanceInfoFailed

Failed to update the security group information of theinstance.

FailedOperation.UpdateSecurityGroupsFailed

Failed to update the security group.

InternalError.InstanceOperatePermissionError

You do not have the operation permission.

InternalError.ListInstancesError

An error occurred while obtaining the list of instances.

©2013-2022 Tencent Cloud. All rights reserved.

Page 393 of 500

TencentDB for Redis

Try again later.
InvalidParameter.InstanceSGOverLimitError

The security groups of the instance exceeds the limit.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

©2013-2022 Tencent Cloud. All rights reserved.

Page 394 of 500

TencentDB for Redis

SwitchInstanceVip：

Last updated 2024-04-03 11:32:45

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to swap the VIPs of instances for instance disaster recovery switch in scenarios where cross-AZ
disaster recovery is supported through DTS. After the VIPs of the source and target instances are swapped, the target
instance can be written into and the DTS sync task between them will be disconnected.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: SwitchInstanceVip.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

SrcInstanceId

Yes

StringSource instance ID

DstInstanceId

Yes

StringTarget instance ID

Name

The time that lapses in seconds since DTS is disconnected between
TimeDelay

No

Integerthe source instance and the target instance. If the DTS disconnection
time period is greater than TimeDelay, the VIP will not be switched.
We recommend you set an acceptable value based on the actual
business conditions.

©2013-2022 Tencent Cloud. All rights reserved.

Page 395 of 500

TencentDB for Redis

ForceSwitch

No

Integer

Whether to force the switch when DTS is disconnected. 1: yes; 0: no.

SwitchTime

No

Stringnow: switch now; syncComplete: switch after sync is completed

3. Output Parameters
Parameter
Name

Type

Description

TaskIdInteger

Task ID

String

The unique request ID, generated by the server, will be returned for every request (ifthe request fails to reach the server for other reasons, the request will not obtain a

RequestId

RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
Input Example
https://redis.tencentcloudapi.com/?Action=SwitchInstanceVip&SrcInstanceId=crs-5a4py64p&DstInstanceId=crs-1kl0iy0v&ForceSwitch=1&<Common request parameters>

Output Example{"Response": {"RequestId": "9a6bd110-20fc-4e08-b77b-a5656cb6150c","TaskId": 18491}}

5. Developer Resources
SDK©2013-2022 Tencent Cloud. All rights reserved.

Page 396 of 500

TencentDB for Redis

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.DtsStatusAbnormal

This operation is not allowed under the current DTS status.

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InternalError.DbOperationFailed

Internal system error with the database operation, which may
be update, insert, select, etc.

InternalError.InternalError

Internal error.

InvalidParameter.InvalidParameter

Invalid service parameter.

InvalidParameterValue.UnSupportedType

The instance type is not supported.

ResourceUnavailable.InstanceStateError

Instance status error.

ResourceUnavailable.InstanceStatusAbnormal

The Redis status is exceptional, and the corresponding
process cannot be executed.

©2013-2022 Tencent Cloud. All rights reserved.

Page 397 of 500

TencentDB for Redis

Region APIs
DescribeProductInfo：

Last updated 2024-04-03 11:32:37

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query purchasable TencentDB for Redis specifications in all regions.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeProductInfo.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

3. Output Parameters
Parameter
Name

Type

Description

RegionSet

Array of

Sale information of a region.

©2013-2022 Tencent Cloud. All rights reserved.

Page 398 of 500

TencentDB for Redis

RegionConf
The unique request ID, generated by the server, will be returned for every request
RequestId

String(if the request fails to reach the server for other reasons, the request will not
obtain a RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProductInfo<Common request parameters>{}

Output Example{"Response": {"RegionSet": [{"RegionId": "ap-guangzhou","RegionName": "Guangzhou","RegionShortName": "GZ","Area": "South China","ZoneSet": [{"ZoneId": "ap-guangzhou-2","ZoneName": "Guangzhou Zone 2","IsSaleout": false,"IsDefault": false,"OldZoneId": 0,"NetWorkType": ["basenet","vpcnet"],"ProductSet": [{"Type": 7,©2013-2022 Tencent Cloud. All rights reserved.

Page 399 of 500

TencentDB for Redis"TypeName": "Redis Cluster Edition","MinBuyNum": 1,"MaxBuyNum": 10,"Saleout": false,"Engine": "Redis Community Edition","Version": "Redis 4.0","TotalSize": [
"12",
"20",
"32",
"64",
"96",
"128","256","384","512","768","1024","2048","3072","4096"],"ShardSize": [
"4",
"8",
"12",
"16",
"20",
"24",
"32"
],
"ReplicaNum": [
"1",
"2",
"3",
"4",
"5"
],
"ShardNum": [
"3",
"5",
"8",
"12",
"16",
"24",
"32",
"40",

©2013-2022 Tencent Cloud. All rights reserved.

Page 400 of 500

TencentDB for Redis

"48",
"64",
"80",
"96",
"128"
],
"PayMode": "1","EnableRepicaReadOnly": true},{
"Type": 4,"TypeName": "CKV Cluster Edition","MinBuyNum": 1,"MaxBuyNum": 10,"Saleout": false,"Engine": "Tencent Cloud CKV","Version": "Redis 3.2","TotalSize": [
"12",
"20",
"32",
"64",
"96",
"128","256","384","512","768","1024","2048","3072","4096"],"ShardSize": [
"4",
"8",
"16",
"24",
"32",
"48",
"64",
"80",
"96",
"128","160","192","256",©2013-2022 Tencent Cloud. All rights reserved.

Page 401 of 500

TencentDB for Redis"320","384"],"ReplicaNum": [
"1",
"2",
"3",
"4",
"5"
],
"ShardNum": [
"3",
"5",
"8",
"12",
"16",
"24",
"32",
"40",
"48",
"64",
"80",
"96",
"128"
],
"PayMode": "1","EnableRepicaReadOnly": false},{"Type": 2,"TypeName": "Redis Master-Replica Edition","MinBuyNum": 1,"MaxBuyNum": 10,"Saleout": false,"Engine": "Redis Community Edition","Version": "Redis 2.8","TotalSize": [
"1",
"2",
"4",
"8",
"12",
"16",
"20",
"24",
"32",
"40",

©2013-2022 Tencent Cloud. All rights reserved.

Page 402 of 500

TencentDB for Redis

"48",
"60",
"0.25"],"ShardSize": [
"1",
"2",
"4",
"8",
"12",
"16",
"20",
"24",
"32",
"40",
"48",
"60",
"0.25"],"ReplicaNum": ["1"],"ShardNum": ["1"],"PayMode": "1","EnableRepicaReadOnly": false},{"Type": 5,"TypeName": "Redis Standalone Edition","MinBuyNum": 1,"MaxBuyNum": 10,"Saleout": false,"Engine": "Redis Community Edition","Version": "Redis 2.8","TotalSize": [
"1",
"2",
"4",
"8",
"12",
"16",
"20",
"24",
"32",
"40",

©2013-2022 Tencent Cloud. All rights reserved.

Page 403 of 500

TencentDB for Redis

"48",
"60"
],
"ShardSize": [
"1",
"2",
"4",
"8",
"12",
"16",
"20",
"24",
"32",
"40",
"48",
"60"
],
"ReplicaNum": ["0"],"ShardNum": ["1"],"PayMode": "1","EnableRepicaReadOnly": false},{"Type": 2,"TypeName": "Redis Master-Replica Edition","MinBuyNum": 1,"MaxBuyNum": 10,"Saleout": false,"Engine": "Redis Community Edition","Version": "Redis 2.8","TotalSize": [
"1",
"2",
"4",
"8",
"12",
"16",
"20",
"24",
"32",
"40",
"48",
"60"

©2013-2022 Tencent Cloud. All rights reserved.

Page 404 of 500

TencentDB for Redis],"ShardSize": [
"1",
"2",
"4",
"8",
"12",
"16",
"20",
"24",
"32",
"40",
"48",
"60"
],
"ReplicaNum": ["1"],"ShardNum": ["1"],"PayMode": "0","EnableRepicaReadOnly": false},{"Type": 3,"TypeName": "CKV Standalone Edition","MinBuyNum": 1,"MaxBuyNum": 10,"Saleout": false,"Engine": "Tencent Cloud CKV","Version": "Redis 3.2","TotalSize": [
"4",
"8",
"16",
"24",
"32",
"48",
"64",
"80",
"96",
"128","160","192","256","320",©2013-2022 Tencent Cloud. All rights reserved.

Page 405 of 500

TencentDB for Redis

"384"
],
"ShardSize": [
"4",
"8",
"16",
"24",
"32",
"48",
"64",
"80",
"96",
"128","160","192","256","320","384"],"ReplicaNum": ["0"],"ShardNum": ["1"],"PayMode": "1","EnableRepicaReadOnly": false
}
]
}
]
}
],
"RequestId": "3c5730c6-02f2-46fd-8bf1-725b8b608fb9"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python©2013-2022 Tencent Cloud. All rights reserved.

Page 406 of 500

TencentDB for Redis

Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InternalError.InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameter.EmptyParam

The parameter is empty.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

©2013-2022 Tencent Cloud. All rights reserved.

Page 407 of 500

TencentDB for Redis

Monitoring and Management APIs
DescribeInstanceMonitorBigKey：

Last updated 2024-04-03 11:32:53

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
The API for querying big keys of a TencentDB for Redis instance was disused on October 31, 2022. For more
information, see API for Querying Instance Big Key Will Be Disused.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeInstanceMonitorBigKey.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID

ReqType

Yes

IntegerRequest type. 1: string type; 2: all types

Date

Yes

StringTime, such as "20190219"

Name©2013-2022 Tencent Cloud. All rights reserved.

Page 408 of 500

TencentDB for Redis

3. Output Parameters
Parameter
Name
Data

RequestId

Type

Description

Array of
BigKeyInfo

Big key details

String

The unique request ID, generated by the server, will be returned for every request(if the request fails to reach the server for other reasons, the request will not obtaina RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
Sample request
Input Example
POST / HTTP/1.1Host: redis.tencentcloudapi.comContent-Type: application/jsonX-TCAction: DescribeInstanceMonitorBigKey<Common request parameters>{ "InstanceId":"crs-5a4py64p", "Date": "20191101", "ReqType": "1"}Output Example{"Response": {"Data": [{"DB": 0,"Key": "abc","Type": "abc","Size": 0,"Updatetime": 0}],"RequestId": "abc"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 409 of 500

TencentDB for Redis

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.RedoFlowFailed

No exact description for this error code for the time being.

©2013-2022 Tencent Cloud. All rights reserved.

Page 410 of 500

TencentDB for Redis

DescribeInstanceMonitorBigKeySizeDist：

Last updated 2024-04-03 11:32:53

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
The API for querying big keys of a TencentDB for Redis instance was disused on October 31, 2022. For more
information, see API for Querying Instance Big Key Will Be Disused.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeInstanceMonitorBigKeySizeDist.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID

Date

Yes

StringTime, such as "20190219"

Name

3. Output Parameters
Parameter

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 411 of 500

TencentDB for Redis

Name
Data

RequestId

Array of
DelayDistribution

StringBig key size distribution details
The unique request ID, generated by the server, will be returned for every
request (if the request fails to reach the server for other reasons, the request
will not obtain a RequestId). RequestId is required for locating a problem.

4. Example
Example1 Querying the delay distribution details of big keys of an instanceThis example shows you how to query the delay distribution details of big keys of an instance.
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceMonitorBigKeySizeDist<Common request parameters>{"InstanceId": "crs-5a4py64p","Date": "2019-11-07"}

Output Example{"Response": {"Data": [{"Ladder": 0,"Size": 0,"Updatetime": 0}],"RequestId": "0e728fa9-c2e5-4bf8-8d6b-c1c4fab7b6db"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 412 of 500

TencentDB for Redis

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.RedoFlowFailed

No exact description for this error code for the time being.

©2013-2022 Tencent Cloud. All rights reserved.

Page 413 of 500

TencentDB for Redis

DescribeInstanceMonitorBigKeyTypeDist：

Last updated 2024-04-03 11:32:52

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
The API for querying big keys of a TencentDB for Redis instance was disused on October 31, 2022. For more
information, see API for Querying Instance Big Key Will Be Disused.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID

Date

Yes

StringTime, such as "20190219"

Description
Common Params. The value used for this API:
DescribeInstanceMonitorBigKeyTypeDist.

3. Output Parameters
Parameter

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 414 of 500

TencentDB for Redis

Name
Data

Array of
BigKeyTypeInfo

RequestId

StringBig key type distribution details
The unique request ID, generated by the server, will be returned for every
request (if the request fails to reach the server for other reasons, the request
will not obtain a RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
Sample request
Input Example
POST / HTTP/1.1Host: redis.tencentcloudapi.comContent-Type: application/jsonX-TCAction: DescribeInstanceMonitorBigKeyTypeDist<Common request parameters>{ "Instan
ceId": "crs-r34wkc1d", "Date": "2019-11-07"}

Output Example{"Response": {"Data": [{"Count": 0,"Size": 0,"Type": "string","Updatetime": 0},{"Count": 0,"Size": 0,"Type": "list","Updatetime": 0},{"Count": 0,"Size": 0,"Type": "set","Updatetime": 0},©2013-2022 Tencent Cloud. All rights reserved.

Page 415 of 500

TencentDB for Redis{"Count": 0,"Size": 0,"Type": "zset","Updatetime": 0},{"Count": 0,"Size": 0,"Type": "hash","Updatetime": 0}],"RequestId": "e903f105-241c-4557-ae99-d4b5bbc015d8"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.

©2013-2022 Tencent Cloud. All rights reserved.

Page 416 of 500

TencentDB for Redis

Error CodeDescription

FailedOperation.RedoFlowFailed

No exact description for this error code for the time being.

©2013-2022 Tencent Cloud. All rights reserved.

Page 417 of 500

TencentDB for Redis

DescribeInstanceMonitorHotKey：

Last updated 2024-04-03 11:32:51

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the hot key of an instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID

SpanType

Yes

Integer

Time span. 1: real time; 2: past 30 minutes; 3: past 6 hours; 4: past
24 hours

Description
Common Params. The value used for this API:
DescribeInstanceMonitorHotKey.

3. Output Parameters
Parameter

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 418 of 500

TencentDB for Redis

Name
Data

Array of
HotKeyInfo

Hot key details
The unique request ID, generated by the server, will be returned for every request

RequestId

String(if the request fails to reach the server for other reasons, the request will not obtaina RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
Input Example
https://redis.tencentcloudapi.com/?Action=DescribeInstanceMonitorHotKey&InstanceId=crs-r34wkc1d&SpanType=4&<Common request parameters>

Output Example{"Response": {"Data": [{"Key": "haha","Type": "string","Count": 123}],"RequestId": "20d64b80-cbac-49a0-8771-42e326db5c45"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to callAPIs.

©2013-2022 Tencent Cloud. All rights reserved.

Page 419 of 500

TencentDB for Redis

Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.RedoFlowFailed

No exact description for this error code for the time being.

©2013-2022 Tencent Cloud. All rights reserved.

Page 420 of 500

TencentDB for Redis

DescribeInstanceMonitorSIP：

Last updated 2024-04-03 11:32:51

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the access source information of an instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeInstanceMonitorSIP.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID

3. Output Parameters
Parameter
Name

Type

Description

Data

Array ofAccess source information©2013-2022 Tencent Cloud. All rights reserved.

Page 421 of 500

TencentDB for Redis

SourceInfo

RequestId

String

The unique request ID, generated by the server, will be returned for every request(if the request fails to reach the server for other reasons, the request will not obtaina RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
Input Example
https://redis.tencentcloudapi.com/?Action=DescribeInstanceMonitorSIP&InstanceId=crs-5a4py64p&<Common request parameters>

Output Example{"Response": {"Data": [{"Ip": "127.0.0.1","Conn": 10,"Cmd": 10}],"RequestId": "8c455eaf-383d-4b16-86cf-ccfc705c9107"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP©2013-2022 Tencent Cloud. All rights reserved.

Page 422 of 500

TencentDB for Redis

Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.RedoFlowFailed

No exact description for this error code for the time being.

©2013-2022 Tencent Cloud. All rights reserved.

Page 423 of 500

TencentDB for Redis

DescribeInstanceMonitorTookDist：

Last updated 2024-04-03 11:32:50

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the distribution of instance access duration.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID

Date

Yes

StringTime, such as "20190219"

SpanType

Yes

Integer

Description
Common Params. The value used for this API:
DescribeInstanceMonitorTookDist.

Time span. 1: real time; 2: last 30 minutes; 3: last 6 hours; 4: last 24hours

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 424 of 500

TencentDB for Redis

Parameter
Name
Data

Type

Description

Array of
DelayDistribution

Latency distribution information
The unique request ID, generated by the server, will be returned for every

RequestId

Stringrequest (if the request fails to reach the server for other reasons, the request
will not obtain a RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
Input Example
https://redis.tencentcloudapi.com/?Action=DescribeInstanceMonitorTookDist&InstanceId=crs-5a4py64p&Date=2019-11-07&SpanType=4&<Common request parameters>

Output Example{"Response": {"Data": [{"Ladder": -1,"Size": 0},{"Ladder": 5,"Size": 0},{"Ladder": 10,"Size": 0},{"Ladder": 1,"Size": 178942},{©2013-2022 Tencent Cloud. All rights reserved.

Page 425 of 500

TencentDB for Redis"Ladder": 50,"Size": 0},{"Ladder": 200,
"Size": 0}],"RequestId": "6f6441b4-884e-40b0-8503-5e5f5e6b6714"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.RedoFlowFailed

No exact description for this error code for the time being.

©2013-2022 Tencent Cloud. All rights reserved.

Page 426 of 500

TencentDB for Redis

DescribeInstanceMonitorTopNCmd：

Last updated 2024-04-03 11:32:49

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query an instance access command.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeInstanceMonitorTopNCmd.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID

SpanType

Yes

Integer

Time span. 1: real time; 2: last 30 minutes; 3: last 6 hours; 4: last 24hours

3. Output Parameters
Parameter

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 427 of 500

TencentDB for Redis

Name
Data

Array of
SourceCommand

RequestId

StringAccess command information
The unique request ID, generated by the server, will be returned for every
request (if the request fails to reach the server for other reasons, the request
will not obtain a RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
Input Example
https://redis.tencentcloudapi.com/?Action=DescribeInstanceMonitorTopNCmd&InstanceId=crs-5a4py64p&SpanType=4&<Common request parameters>

Output Example{"Response": {"Data": [{"Cmd": "ping","Count": 179562}],"RequestId": "f5ce4f15-bf90-4958-95ca-97fa086ace28"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python©2013-2022 Tencent Cloud. All rights reserved.

Page 428 of 500

TencentDB for Redis

Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.RedoFlowFailed

No exact description for this error code for the time being.

©2013-2022 Tencent Cloud. All rights reserved.

Page 429 of 500

TencentDB for Redis

DescribeInstanceMonitorTopNCmdTook：

Last updated 2024-04-03 11:32:49

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the instance CPU time.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

String

Instance ID

SpanType

Yes

Integer

Time span. 1: real time; 2: last 30 minutes; 3: last 6 hours; 4: last 24
hours

Name

Description
Common Params. The value used for this API:
DescribeInstanceMonitorTopNCmdTook.

3. Output Parameters
Parameter

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 430 of 500

TencentDB for Redis

Name
Data

Array ofCommandTake

Duration details
The unique request ID, generated by the server, will be returned for every

RequestId

Stringrequest (if the request fails to reach the server for other reasons, the request
will not obtain a RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
Input Example
https://redis.tencentcloudapi.com/?Action=DescribeInstanceMonitorTopNCmdTook&InstanceId=crs-r34wkc1d&SpanType=4&<Common request parameters>

Output Example{"Response": {"Data": [{"Cmd": "ping","Took": 4688000}],"RequestId": "95308f10-19d9-4313-bedf-cb65a846826f"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python©2013-2022 Tencent Cloud. All rights reserved.

Page 431 of 500

TencentDB for Redis

Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.RedoFlowFailed

No exact description for this error code for the time being.

©2013-2022 Tencent Cloud. All rights reserved.

Page 432 of 500

TencentDB for Redis

Backup and Restoration APIs
DescribeBackupDownloadRestriction：

Last updated 2024-04-03 11:33:37

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the download address for a database backup file in the current region.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

Description
Common Params. The value used for this API:
DescribeBackupDownloadRestriction.

3. Output Parameters
Parameter NameType

Description

LimitType

StringType of the network restrictions for downloading backup
files. Valid values:©2013-2022 Tencent Cloud. All rights reserved.

Page 433 of 500

TencentDB for Redis- NoLimit : Backup files can be downloaded over bothpublic and private networks.
- LimitOnlyIntranet : Backup files can be
downloaded only at private network addresses autoassigned by Tencent Cloud.
- Customize : Backup files can be downloaded only inthe customized VPC.
Only In can be passed in for this parameter, indicating
VpcComparisonSymbol

Stringthat backup files can be downloaded in the custom
LimitVpc .
Whether backups can be downloaded at the custom
LimitIp address.

IpComparisonSymbol

String- In : Download is allowed for the custom IP.
- NotIn : Download is not allowed for the custom IP.

LimitVpc

LimitIp

Array of

VPC ID of the custom backup file download address, which

BackupLimitVpcItem

will be displayed if LimitType is Customize .

Array of String

Custom VPC IP address for downloading backup files.
This parameter is displayed when the LimitTypeparameter is set to Customize.
The unique request ID, generated by the server, will be

RequestId

Stringreturned for every request (if the request fails to reach theserver for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Querying the restrictions for downloading a backup file in the current region.
This example shows you how to query the restrictions for downloading a backup file in the current region.
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupDownloadRestriction<Common request parameters>©2013-2022 Tencent Cloud. All rights reserved.

Page 434 of 500

TencentDB for Redis{}

Output Example{"Response": {"IpComparisonSymbol": "NotIn","LimitIp": ["10.1.0.13"],"LimitType": "Customize","LimitVpc": [{"Region": "ap-guangzhou","VpcList": ["vpc-5og4fwm9","vpc-03dsikyx"]}],"RequestId": "785b6c5f-999f-43ef-9906-14f4c24b8040","VpcComparisonSymbol": "In"}}5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface©2013-2022 Tencent Cloud. All rights reserved.

Page 435 of 500

TencentDB for Redis

Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InternalError.DbOperationFailed

Internal system error with the database operation, which may be
update, insert, select, etc.

InternalError.InternalError

Internal error.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

©2013-2022 Tencent Cloud. All rights reserved.

Page 436 of 500

TencentDB for Redis

DescribeBackupUrl：

Last updated 2024-04-03 11:33:36

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the download address of a backup RDB file.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this
API: DescribeBackupUrl.

VersionYes

StringRegionNo

StringCommon Params. This parameter is not
required for this API.

InstanceId

Yes

String

Instance ID

BackupId

Yes

StringLimitTypeNo

StringCommon Params. The value used for this
API: 2018-04-12.

Backup ID, which can be obtained throughthe RedisBackupSet parameter
returned by the DescribeInstanceBackups
API.
Type of the network restriction for
downloading backup files. If this parameter is
not configured, the user-defined configuration©2013-2022 Tencent Cloud. All rights reserved.

Page 437 of 500

TencentDB for Redis

will be used.
- NoLimit : Backup files can be
downloaded over both public and private
networks.
- LimitOnlyIntranet : Backup files canbe downloaded only at private network
addresses auto-assigned by Tencent Cloud.
- Customize : Backup files can be
downloaded only in the customized VPC.
Only In can be passed in for this
VpcComparisonSymbol

No

Stringparameter, indicating that backup files can be
downloaded in the custom LimitVpc .
Whether backups can be downloaded at thecustom LimitIp address.

IpComparisonSymbol

No

String- In (default value): Download is allowed
for the custom IP.
- NotIn : Download is not allowed for thecustom IP.

LimitVpc.N

No

Array of
BackupLimitVpcItem

VPC ID of the custom backup file download
address, which is required if LimitType
is Customize .
VPC IP of the custom backup file download

LimitIp.N

No

Array of String

address, which is required if LimitType
is Customize .

3. Output Parameters
Parameter NameType

Description

DownloadUrl

Array of String

Public network download address (valid for six hours). This field
will be disused soon.

InnerDownloadUrl

Array of String

Filenames

Array of String

Private network download address (valid for six hours). This field
will be disused soon.
Filename. This field will be disused soon.
Note: This field may return null, indicating that no valid values
can be obtained.

©2013-2022 Tencent Cloud. All rights reserved.

Page 438 of 500

TencentDB for Redis

BackupInfos

Array of
BackupDownloadInfo

List of backup file information.
Note: This field may return null, indicating that no valid values
can be obtained.
The unique request ID, generated by the server, will be returned

RequestId

Stringfor every request (if the request fails to reach the server for otherreasons, the request will not obtain a RequestId). RequestId isrequired for locating a problem.

4. Example
Example1 Querying the download address of a backup RDB file
This example shows you how to query the download address of a backup RDB file.
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupUrl<Common request parameters>{"InstanceId": "crs-4y9t57vt","BackupId": "678362566696298532848117"}

Output Example{"Response": {"Filenames": ["9527208-4633789-redis-server-4.0.8-1001463-ignore-1-ignore.rdb","9527208-4633789-redis-server-4.0.8-1001463-ignore-2-ignore.rdb","9527208-4633789-redis-server-4.0.8-1001463-ignore-3-ignore.rdb","9527208-4633789-redis-server-4.0.8-1001463-ignore-4-ignore.rdb","9527208-4633789-redis-server-4.0.8-1001463-ignore-5-ignore.rdb"],"DownloadUrl": ["https://redis-database-backup-1251937656.cos.ap-chengdu.myqcloud.com/251005863/r
edis/1001463/data/2019-03-07/-9527208-4633789-redis-server-4.0.8-1001463-ignore-1-ignore.rdb?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKID21teFeP99yb1FI94vqutgJkFoQ1©2013-2022 Tencent Cloud. All rights reserved.

Page 439 of 500

TencentDB for Redis

eBpKg%26q-sign-time%3D1551952863%3B1551974523%26q-key-time%3D1551952863%3B1551974
523%26q-header-list%3D%26q-url-param-list%3D%26q-signature%3D28cc6edebf7f9d8e34aa
3daf19d30ec521c03b5b","https://redis-database-backup-1251937656.cos.ap-chengdu.myqcloud.com/251005863/r
edis/1001463/data/2019-03-07/-9527208-4633789-redis-server-4.0.8-1001463-ignore-2-ignore.rdb?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKID21teFeP99yb1FI94vqutgJkFoQ1
eBpKg%26q-sign-time%3D1551952863%3B1551974523%26q-key-time%3D1551952863%3B1551974
523%26q-header-list%3D%26q-url-param-list%3D%26q-signature%3D2b081fdb65c591f8e000
ed55625af24049b15795","https://redis-database-backup-1251937656.cos.ap-chengdu.myqcloud.com/251005863/r
edis/1001463/data/2019-03-07/-9527208-4633789-redis-server-4.0.8-1001463-ignore-3-ignore.rdb?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKID21teFeP99yb1FI94vqutgJkFoQ1
eBpKg%26q-sign-time%3D1551952864%3B1551974524%26q-key-time%3D1551952864%3B1551974
524%26q-header-list%3D%26q-url-param-list%3D%26q-signature%3D87eda5611679fb9bc252
9631ae97b218317e9598","https://redis-database-backup-1251937656.cos.ap-chengdu.myqcloud.com/251005863/r
edis/1001463/data/2019-03-07/-9527208-4633789-redis-server-4.0.8-1001463-ignore-4-ignore.rdb?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKID21teFeP99yb1FI94vqutgJkFoQ1
eBpKg%26q-sign-time%3D1551952864%3B1551974524%26q-key-time%3D1551952864%3B1551974
524%26q-header-list%3D%26q-url-param-list%3D%26q-signature%3Db17a8297bf5637f0ce7d
db970ffd566b484a5063","https://redis-database-backup-1251937656.cos.ap-chengdu.myqcloud.com/251005863/r
edis/1001463/data/2019-03-07/-9527208-4633789-redis-server-4.0.8-1001463-ignore-5-ignore.rdb?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKID21teFeP99yb1FI94vqutgJkFoQ1
eBpKg%26q-sign-time%3D1551952865%3B1551974525%26q-key-time%3D1551952865%3B1551974
525%26q-header-list%3D%26q-url-param-list%3D%26q-signature%3De69f614cffd54c1be7d6
09e05d20be15eb82fc13"],"InnerDownloadUrl": ["https://redis-database-backup-1251937656.cos.ap-chengdu.myqcloud.com/251005863/r
edis/1001463/data/2019-03-07/-9527208-4633789-redis-server-4.0.8-1001463-ignore-1-ignore.rdb?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKID21teFeP99yb1FI94vqutgJkFoQ1
eBpKg%26q-sign-time%3D1551952863%3B1551974523%26q-key-time%3D1551952863%3B1551974
523%26q-header-list%3D%26q-url-param-list%3D%26q-signature%3D28cc6edebf7f9d8e34aa
3daf19d30ec521c03b5b","https://redis-database-backup-1251937656.cos.ap-chengdu.myqcloud.com/251005863/r
edis/1001463/data/2019-03-07/-9527208-4633789-redis-server-4.0.8-1001463-ignore-2-ignore.rdb?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKID21teFeP99yb1FI94vqutgJkFoQ1
eBpKg%26q-sign-time%3D1551952863%3B1551974523%26q-key-time%3D1551952863%3B1551974
523%26q-header-list%3D%26q-url-param-list%3D%26q-signature%3D2b081fdb65c591f8e000
ed55625af24049b15795","https://redis-database-backup-1251937656.cos.ap-chengdu.myqcloud.com/251005863/r
edis/1001463/data/2019-03-07/-9527208-4633789-redis-server-4.0.8-1001463-ignore-3-ignore.rdb?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKID21teFeP99yb1FI94vqutgJkFoQ1
eBpKg%26q-sign-time%3D1551952864%3B1551974524%26q-key-time%3D1551952864%3B1551974
524%26q-header-list%3D%26q-url-param-list%3D%26q-signature%3D87eda5611679fb9bc252
9631ae97b218317e9598",©2013-2022 Tencent Cloud. All rights reserved.

Page 440 of 500

TencentDB for Redis"https://redis-database-backup-1251937656.cos.ap-chengdu.myqcloud.com/251005863/r
edis/1001463/data/2019-03-07/-9527208-4633789-redis-server-4.0.8-1001463-ignore-4-ignore.rdb?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKID21teFeP99yb1FI94vqutgJkFoQ1
eBpKg%26q-sign-time%3D1551952864%3B1551974524%26q-key-time%3D1551952864%3B1551974
524%26q-header-list%3D%26q-url-param-list%3D%26q-signature%3Db17a8297bf5637f0ce7d
db970ffd566b484a5063","https://redis-database-backup-1251937656.cos.ap-chengdu.myqcloud.com/251005863/r
edis/1001463/data/2019-03-07/-9527208-4633789-redis-server-4.0.8-1001463-ignore-5-ignore.rdb?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKID21teFeP99yb1FI94vqutgJkFoQ1
eBpKg%26q-sign-time%3D1551952865%3B1551974525%26q-key-time%3D1551952865%3B1551974
525%26q-header-list%3D%26q-url-param-list%3D%26q-signature%3De69f614cffd54c1be7d6
09e05d20be15eb82fc13"],"BackupInfos": [{"FileName": "9527208-4633789-redis-server-4.0.8-1001463-ignore-1-ignore.rdb","FileSize": 1264547,"DownloadUrl": "https://redis-database-backup-1251937656.cos.ap-chengdu.myqcloud.
com/251005863/redis/1001463/data/2019-03-07/-9527208-4633789-redis-server-4.0.8-1
001463-ignore-1-ignore.rdb?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKID21teFeP99yb1
FI94vqutgJkFoQ1eBpKg%26q-sign-time%3D1551952863%3B1551974523%26q-key-time%3D15519
52863%3B1551974523%26q-header-list%3D%26q-url-param-list%3D%26q-signature%3D28cc6
edebf7f9d8e34aa3daf19d30ec521c03b5b","InnerDownloadUrl": "https://redis-database-backup-1251937656.cos.ap-chengdu.myqc
loud.com/251005863/redis/1001463/data/2019-03-07/-9527208-4633789-redis-server-4.
0.8-1001463-ignore-1-ignore.rdb?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKID21teFeP
99yb1FI94vqutgJkFoQ1eBpKg%26q-sign-time%3D1551952863%3B1551974523%26q-key-time%3D
1551952863%3B1551974523%26q-header-list%3D%26q-url-param-list%3D%26q-signature%3D
28cc6edebf7f9d8e34aa3daf19d30ec521c03b5b"},{"FileName": "9527208-4633789-redis-server-4.0.8-1001463-ignore-2-ignore.rdb","FileSize": 1278586,"DownloadUrl": "https://redis-database-backup-1251937656.cos.ap-chengdu.myqcloud.
com/251005863/redis/1001463/data/2019-03-07/-9527208-4633789-redis-server-4.0.8-1
001463-ignore-2-ignore.rdb?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKID21teFeP99yb1
FI94vqutgJkFoQ1eBpKg%26q-sign-time%3D1551952863%3B1551974523%26q-key-time%3D15519
52863%3B1551974523%26q-header-list%3D%26q-url-param-list%3D%26q-signature%3D2b081
fdb65c591f8e000ed55625af24049b15795","InnerDownloadUrl": "https://redis-database-backup-1251937656.cos.ap-chengdu.myqc
loud.com/251005863/redis/1001463/data/2019-03-07/-9527208-4633789-redis-server-4.
0.8-1001463-ignore-2-ignore.rdb?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKID21teFeP
99yb1FI94vqutgJkFoQ1eBpKg%26q-sign-time%3D1551952863%3B1551974523%26q-key-time%3D
1551952863%3B1551974523%26q-header-list%3D%26q-url-param-list%3D%26q-signature%3D
2b081fdb65c591f8e000ed55625af24049b15795"},{©2013-2022 Tencent Cloud. All rights reserved.

Page 441 of 500

TencentDB for Redis"FileName": "9527208-4633789-redis-server-4.0.8-1001463-ignore-3-ignore.rdb","FileSize": 1467647,"DownloadUrl": "https://redis-database-backup-1251937656.cos.ap-chengdu.myqcloud.
com/251005863/redis/1001463/data/2019-03-07/-9527208-4633789-redis-server-4.0.8-1
001463-ignore-3-ignore.rdb?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKID21teFeP99yb1
FI94vqutgJkFoQ1eBpKg%26q-sign-time%3D1551952864%3B1551974524%26q-key-time%3D15519
52864%3B1551974524%26q-header-list%3D%26q-url-param-list%3D%26q-signature%3D87eda
5611679fb9bc2529631ae97b218317e9598","InnerDownloadUrl": "https://redis-database-backup-1251937656.cos.ap-chengdu.myqc
loud.com/251005863/redis/1001463/data/2019-03-07/-9527208-4633789-redis-server-4.
0.8-1001463-ignore-3-ignore.rdb?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKID21teFeP
99yb1FI94vqutgJkFoQ1eBpKg%26q-sign-time%3D1551952864%3B1551974524%26q-key-time%3D
1551952864%3B1551974524%26q-header-list%3D%26q-url-param-list%3D%26q-signature%3D
87eda5611679fb9bc2529631ae97b218317e9598"},{"FileName": "9527208-4633789-redis-server-4.0.8-1001463-ignore-4-ignore.rdb","FileSize": 1264987,"DownloadUrl": "https://redis-database-backup-1251937656.cos.ap-chengdu.myqcloud.
com/251005863/redis/1001463/data/2019-03-07/-9527208-4633789-redis-server-4.0.8-1
001463-ignore-4-ignore.rdb?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKID21teFeP99yb1
FI94vqutgJkFoQ1eBpKg%26q-sign-time%3D1551952864%3B1551974524%26q-key-time%3D15519
52864%3B1551974524%26q-header-list%3D%26q-url-param-list%3D%26q-signature%3Db17a8
297bf5637f0ce7ddb970ffd566b484a5063","InnerDownloadUrl": "https://redis-database-backup-1251937656.cos.ap-chengdu.myqc
loud.com/251005863/redis/1001463/data/2019-03-07/-9527208-4633789-redis-server-4.
0.8-1001463-ignore-4-ignore.rdb?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKID21teFeP
99yb1FI94vqutgJkFoQ1eBpKg%26q-sign-time%3D1551952864%3B1551974524%26q-key-time%3D
1551952864%3B1551974524%26q-header-list%3D%26q-url-param-list%3D%26q-signature%3D
b17a8297bf5637f0ce7ddb970ffd566b484a5063"},{"FileName": "9527208-4633789-redis-server-4.0.8-1001463-ignore-5-ignore.rdb","FileSize": 1268499,"DownloadUrl": "https://redis-database-backup-1251937656.cos.ap-chengdu.myqcloud.
com/251005863/redis/1001463/data/2019-03-07/-9527208-4633789-redis-server-4.0.8-1
001463-ignore-5-ignore.rdb?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKID21teFeP99yb1
FI94vqutgJkFoQ1eBpKg%26q-sign-time%3D1551952865%3B1551974525%26q-key-time%3D15519
52865%3B1551974525%26q-header-list%3D%26q-url-param-list%3D%26q-signature%3De69f6
14cffd54c1be7d609e05d20be15eb82fc13","InnerDownloadUrl": "https://redis-database-backup-1251937656.cos.ap-chengdu.myqc
loud.com/251005863/redis/1001463/data/2019-03-07/-9527208-4633789-redis-server-4.
0.8-1001463-ignore-5-ignore.rdb?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKID21teFeP
99yb1FI94vqutgJkFoQ1eBpKg%26q-sign-time%3D1551952865%3B1551974525%26q-key-time%3D
1551952865%3B1551974525%26q-header-list%3D%26q-url-param-list%3D%26q-signature%3D
e69f614cffd54c1be7d609e05d20be15eb82fc13"}©2013-2022 Tencent Cloud. All rights reserved.

Page 442 of 500

TencentDB for Redis],"RequestId": "f1b5aabe-806a-4886-b839-9907baa24c85"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error Code
FailedOperation.SystemError

Description
Internal system error, which is irrelevant to thebusiness.

InternalError.DbOperationFailed

Internal system error with the database
operation, which may be update, insert,
select, etc.

InternalError.InternalError

Internal error.

InvalidParameter.InvalidParameter

Invalid service parameter.

©2013-2022 Tencent Cloud. All rights reserved.

Page 443 of 500

TencentDB for Redis

InvalidParameter.PermissionDenied

The API has no CAM permissions.

InvalidParameterValue.BackupNotExists

The backup does not exist.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

ResourceUnavailable.BackupStatusInvalid

Backup is not supported when the instance is
not in the “Running” status.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

UnauthorizedOperation.UserNotInWhiteList

The user is not in the allowlist.

UnsupportedOperation.ClusterInstanceAccessedDeny

The Redis cluster edition is not allowed toconnect to a security group.

UnsupportedOperation.IsAutoRenewError

There is an error with the auto-renewal flag.

UnsupportedOperation.OnlyClusterInstanceCanExportBackup©2013-2022 Tencent Cloud. All rights reserved.

Only Cluster Edition instances support
backup exporting.

Page 444 of 500

TencentDB for Redis

DescribeInstanceBackups：

Last updated 2024-04-03 11:33:35

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the backup list of an instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeInstanceBackups.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

Limit

No

Integer

OffsetNo

Integer

InstanceId

No

StringNumber of backups returned per page. Default value: 20 .
Maximum value: 100 .
Pagination offset, which is an integral multiple of Limit .
offset = limit * (page number - 1).
ID of the instance to be operated on, which can be obtained throughthe InstanceId field in the return value of the
DescribeInstance API.

BeginTimeNo

String©2013-2022 Tencent Cloud. All rights reserved.

Start time in the format of yyyy-MM-dd HH:mm:ss, such as 2017-02-

Page 445 of 500

TencentDB for Redis

08 16:46:34. This parameter is used to query the list of instancebackups started during the [beginTime, endTime] range.
End time in the format of yyyy-MM-dd HH:mm:ss, such as 2017-02EndTime

No

String08 19:09:26. This parameter is used to query the list of instancebackups started during the [beginTime, endTime] range.
Backup task status:
1 : The backup is in the process.

Status.N

No

Array

2 : The backup is normal.

ofInteger

3 : The backup is being converted to an RDB file.
4 : Conversion to RDB has been completed.
-1 : The backup expired.
-2 : The backup has been deleted.

InstanceName

No

String

Instance name, which can be fuzzily searched.

3. Output Parameters
Parameter
Name

Type

Description

TotalCount

Integer

Total number of backups.

BackupSet

RequestId

Array of
RedisBackupSet

StringArray of instance backups.
The unique request ID, generated by the server, will be returned for every
request (if the request fails to reach the server for other reasons, the request
will not obtain a RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample 1
This example shows you how to query the backup list of the instance crs-c7nuafdt .
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json©2013-2022 Tencent Cloud. All rights reserved.

Page 446 of 500

TencentDB for Redis

X-TC-Action: DescribeInstanceBackups<Common request parameters>{"Status": ["2"],"InstanceId": "crs-c7nuafdt","Limit": "10","Offset": "0"}

Output Example{"Response": {"BackupSet": [{"BackupId": "154572601-1165734322-153731238","BackupSize": 191,
"BackupType": "0","EndTime": "2022-12-23 16:25:18","ExpireTime": "2022-12-30 16:24:41","FileType": "RDB-Redis 4.0","FullBackup": 0,"InstanceId": "crs-c7nuafdt","InstanceName": "Backup test","InstanceType": 6,"Locked": 0,"Region": "ap-guangzhou","Remark": "test001","StartTime": "2022-12-23 16:24:41","Status": 2}],"RequestId": "2a95bfa4-ac8c-43cd-b7b1-5a93817d8de2","TotalCount": 1}}

5. Developer Resources
SDK©2013-2022 Tencent Cloud. All rights reserved.

Page 447 of 500

TencentDB for Redis

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InternalError.DbOperationFailed

Internal system error with the database operation, which may be
update, insert, select, etc.

InternalError.InternalError

Internal error.

InvalidParameter.InvalidParameter

Invalid service parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

UnsupportedOperation

The operation is not supported.

©2013-2022 Tencent Cloud. All rights reserved.

Page 448 of 500

TencentDB for Redis

ManualBackupInstance：

Last updated 2024-04-03 11:33:35

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to manually back up a Redis instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

StringID of a specified instance, such as "crs-xjhsdj****" Log in to the Redis
console and copy the instance ID in the instance list.

RemarkNo

StringRemarks for manual backup task

Description
Common Params. The value used for this API:
ManualBackupInstance.

Retention period of backup data in days. Default value: 7 days. Value
range: [0,1825]. If the value exceeds 7 days, submit a ticket for
StorageDays

No

Integer

application. - If this parameter is not configured, it will set to be thesame as the period of automatic backup retention. - If automatic
backup is not set, the default value will be 7 days.

©2013-2022 Tencent Cloud. All rights reserved.

Page 449 of 500

TencentDB for Redis

3. Output Parameters
Parameter
Name

Type

Description

TaskIdInteger

Task ID

String

The unique request ID, generated by the server, will be returned for every request (ifthe request fails to reach the server for other reasons, the request will not obtain a

RequestId

RequestId). RequestId is required for locating a problem.

4. Example
Example1 Sample request
This example shows you how to manually back up an instance.
Input Example
https://redis.tencentcloudapi.com/?Action=ManualBackupInstance&InstanceId=crs-5a4
p****&Remark=xxxx&<Common request parameters>

Output Example{"Response": {"TaskId": "6954227","RequestId": "4daddc97-0005-45d8-b5b8-38514ec1e97c"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java©2013-2022 Tencent Cloud. All rights reserved.

Page 450 of 500

TencentDB for Redis

Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.CommitFlowError

Failed to submit the task.

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InternalError.InternalError

Internal error.

InvalidParameter.InvalidParameter

Invalid service parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

ResourceUnavailable.InstanceLockedError

Redis has been locked by another process.

ResourceUnavailable.InstanceStateError

Instance status error.

ResourceUnavailable.InstanceStatusAbnormal

The Redis status is exceptional, and the corresponding
process cannot be executed.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

©2013-2022 Tencent Cloud. All rights reserved.

Page 451 of 500

TencentDB for Redis

ModifyBackupDownloadRestriction：

Last updated 2024-04-03 11:33:34

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to modify the network information and address for downloading a backup file.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

ActionYes

String

VersionYes

StringRegionNo

StringLimitType

Yes

StringDescription
Common Params. The value used for this
API: ModifyBackupDownloadRestriction.
Common Params. The value used for this
API: 2018-04-12.
Common Params. This parameter is not
required for this API.
Type of the network restrictions fordownloading backup files. Valid values:- NoLimit : Backup files can be
downloaded over both public and private
networks.
- LimitOnlyIntranet : Backup files canbe downloaded only at private network
addresses auto-assigned by Tencent Cloud.

©2013-2022 Tencent Cloud. All rights reserved.

Page 452 of 500

TencentDB for Redis- Customize : Backup files can be
downloaded only in the customized VPC.
Only In can be passed in for this
VpcComparisonSymbol

No

Stringparameter, indicating that backup files can be
downloaded in the custom LimitVpc .
Whether backups can be downloaded at thecustom LimitIp address.

IpComparisonSymbol

No

String- In : Download is allowed for the custom
IP.
- NotIn : Download is not allowed for thecustom IP.

LimitVpc.N

No

Array of
BackupLimitVpcItem

VPC ID of the custom backup file download
address, which is required if LimitType
is Customize .
VPC IP of the custom backup file download

LimitIp.N

No

Array of String

address, which is required if LimitType
is Customize .

3. Output Parameters
Parameter
Name

RequestId

Type

Description

String

The unique request ID, generated by the server, will be returned for every request (if therequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Modifying the download address for a backup file
This example shows you how to modify the custom network and address of a backup file in the current region.
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com©2013-2022 Tencent Cloud. All rights reserved.

Page 453 of 500

TencentDB for Redis

Content-Type: application/json
X-TC-Action: ModifyBackupDownloadRestriction<Common request parameters>{"LimitType": "Customize","VpcComparisonSymbol": "In","IpComparisonSymbol": "NotIn","LimitVpc": [{"VpcList": ["vpc-5og4fwm9","vpc-03dsikyx"],"Region": "ap-guangzhou"}],"LimitIp": ["10.1.0.13"]}

Output Example{"Response": {"RequestId": "489f7bc7-e0e0-4e6f-a5c4-97c5fcf7ea8b"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET

©2013-2022 Tencent Cloud. All rights reserved.

Page 454 of 500

TencentDB for Redis

Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InternalError.DbOperationFailed

Internal system error with the database operation, which may be
update, insert, select, etc.

InvalidParameter.InvalidParameter

Invalid service parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

©2013-2022 Tencent Cloud. All rights reserved.

Page 455 of 500

TencentDB for Redis

RestoreInstance：

Last updated 2024-04-03 11:33:33

1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to restore a Redis instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: RestoreInstance.

VersionYes

StringCommon Params. The value used for this API: 2018-04-12.

RegionNo

StringCommon Params. This parameter is not required for this API.

StringID of the instance to be operated on, which can be obtained through theInstanceId field in the return value of the DescribeInstances

InstanceId

Yes

API.
BackupId

Yes

StringPassword

No

StringBackup ID, which can be obtained through the backupId field in the
return value of the GetRedisBackupList API.
Instance password, which needs to be validated during instancerestoration (this parameter is not required for password-free instances)©2013-2022 Tencent Cloud. All rights reserved.

Page 456 of 500

TencentDB for Redis

3. Output Parameters
Parameter
Name

Type

Description

TaskIdInteger

Task ID, which can be used to query the task execution status through the
DescribeTaskInfo API.
The unique request ID, generated by the server, will be returned for every request (ifRequestId

Stringthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Restoring a Redis Instance
Input Example
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RestoreInstance<Common request parameters>{"InstanceId": "crs-5a4py64p","BackupId": "678362566696298532848117","Password": "mypassword"}

Output Example{"Response": {"TaskId": "6954227","RequestId": "4daddc97-0005-45d8-b5b8-38514ec1e97c"}}

5. Developer Resources©2013-2022 Tencent Cloud. All rights reserved.

Page 457 of 500

TencentDB for Redis

SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.SystemError

Internal system error, which is irrelevant to the business.

InternalError.InternalError

Internal error.

InvalidParameter.InvalidParameter

Invalid service parameter.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

InvalidParameterValue.BackupNotExists

The backup does not exist.

InvalidParameterValue.PasswordError

Password verification error due to incorrect password.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

ResourceUnavailable.BackupLockedError

The backup has been locked by another task, and theoperation cannot be performed temporarily.

ResourceUnavailable.BackupSpecError

Backup and recovery specifications are not supported.

ResourceUnavailable.BackupStatusAbnormal

Backup status exception. The operation cannot be performed
temporarily. The backup may have expired or been deleted.

©2013-2022 Tencent Cloud. All rights reserved.

Page 458 of 500

TencentDB for Redis

ResourceUnavailable.InstanceLockedError

Redis has been locked by another process.

ResourceUnavailable.InstanceStateError

Instance status error.

ResourceUnavailable.InstanceStatusAbnormal

The Redis status is exceptional, and the corresponding
process cannot be executed.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

©2013-2022 Tencent Cloud. All rights reserved.

Page 459 of 500

TencentDB for Redis

Data Types：

Last updated 2024-04-15 11:08:47

Account
Sub-account information
Used by actions: DescribeInstanceAccount.
Name

Type

Description

InstanceId

StringAccountName

StringNote: This field may return null, indicating that no valid values can beobtained.

RemarkStringNote: This field may return null, indicating that no valid values can beobtained.

Privilege

StringReadonlyPolicy

Array of
StringNote: This field may return null, indicating that no valid values can beobtained.

StatusInteger

Note: This field may return null, indicating that no valid values can beobtained.

CreateTime

StringNote: This field may return null, indicating that no valid values can beobtained.

Note: This field may return null, indicating that no valid values can beobtained.

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

BackupDownloadInfo
Backup download information
Used by actions: DescribeBackupUrl.
Name

Type

Description

FileName

StringBackup file name©2013-2022 Tencent Cloud. All rights reserved.

Page 460 of 500

TencentDB for Redis

FileSize

Integer

Backup file size in bytes. If the parameter value is 0 , the backup file size isunknown.

DownloadUrl

StringInnerDownloadUrl

StringAddress (valid for six hours) used to download the backup file over the public
network
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

RegionStringYes

The region of the VPC that corresponds to the download address ofthe backup file

VpcListArray of
StringYes

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

StringBig keyType

StringType

Size

IntegerSize

Updatetime

Integer

Data timestamp

BigKeyTypeInfo©2013-2022 Tencent Cloud. All rights reserved.

Page 461 of 500

TencentDB for Redis

Big key type distribution details
Used by actions: DescribeInstanceMonitorBigKeyTypeDist.
Name

Type

Description

Type

String

Type

Count

Integer

Count

Size

IntegerSize

Updatetime

Integer

Timestamp

CommandTake
Command duration
Used by actions: DescribeInstanceMonitorTopNCmdTook.
Name

Type

Description

Cmd

StringCommandTook

Integer

Duration

DelayDistribution
Delay distribution details
Used by actions: DescribeInstanceMonitorBigKeySizeDist, DescribeInstanceMonitorTookDist.
Name

Type

Description
The delay distribution. The mapping between delay range and Ladder value is as

LadderIntegerfollows: - 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©2013-2022 Tencent Cloud. All rights reserved.

Page 462 of 500

TencentDB for Redis

DescribeInstanceDTSInstanceInfo
Details of instances in the DTS task
Used by actions: DescribeInstanceDTSInfo.
Name

Type

Description

RegionId

Integer

InstanceId

String

SetId

Integer

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

ZoneIdInteger

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

Type

Integer

InstanceName

String

Instance nameNote: This field may return null, indicating that no valid values can be obtained.

Vip

String

Instance access address
Note: This field may return null, indicating that no valid values can be obtained.

StatusInteger

Region ID
Note: This field may return null, indicating that no valid values can be obtained.
Instance ID
Note: This field may return null, indicating that no valid values can be obtained.

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

StatusNote: This field may return null, indicating that no valid values can be obtained.

GroupsReplication group info
Used by actions: DescribeReplicationGroup.
Name

Type

AppId

Integer

RegionId

Integer

Description
User APPID, which is the unique application ID that matches an account.
Some Tencent Cloud products use this APPID.
Region ID. Valid values:- 1 : Guangzhou©2013-2022 Tencent Cloud. All rights reserved.

Page 463 of 500

TencentDB for Redis- 4 : Shanghai- 5 : Hong Kong (China)- 6 : Toronto- 7 : Shanghai Finance- 8 : Beijing- 9 : Singapore- 11 : Shenzhen Finance- 15 : Silicon Valley (West US)- 16 : Chengdu- 17 : Germany- 18 : South Korea- 19 : Chongqing- 21 : India- 22 : Virginia (East US)- 23 : Thailand- 25 : Japan
GroupId

StringReplication group ID in the format of "crs-rpl-deind****"

GroupName

StringReplication group nameNote: This field may return null, indicating that no valid values can be obtained.
Status of replication group- 37 : Associating replication group

StatusInteger- 38 : Reconnecting to replication group- 51 : Disassociating replication group- 52 : Switching with master instance in replication group- 53 : Modifying the roles

InstanceCount

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

RemarkStringRemarks
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©2013-2022 Tencent Cloud. All rights reserved.

Page 464 of 500

TencentDB for Redis

Key

String

The name of the hot key.

Type

String

Key type.

Count

IntegerNumber of accesses for the hot key in a specified time period.

InboundSecurity group inbound rule
Used by actions: DescribeDBSecurityGroups, DescribeProjectSecurityGroups.
Name

Type

Description

ActionStringPolicy. Valid values: ACCEPT, DROP.

AddressModule

String

All the addresses that the address group ID represents.

CidrIpStringSource IP or IP address range, such as 192.168.0.0/16.

Desc

StringDescription.

IpProtocol

StringNetwork 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

StringNode name

RunId

StringID of the runtime node of an instanceRole

Integer

Cluster role. Valid values: - 0 (master) - 1 (replica)©2013-2022 Tencent Cloud. All rights reserved.

Page 465 of 500

TencentDB for Redis

StatusInteger

Node status. Valid values: - 0 (read/write) - 1 (read) - 2 (backup)

Connected

Integer

Service status. Valid values: 0 (down), 1 (on).

CreateTime

StringNode creation time

DownTime

StringNode elimination time

Slots

StringNode 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 nodeInteger

The role of a shard node
- 0 : Master node.

Role- 1 : Replica node.
Keys

IntegerNumber of keys

Slots

StringSlot information

Storage

Integer

Used Capacity

StorageSlope

Float

Capacity slope

Runid

StringThis field is recommended to use the RunId instead due to spelling inconsistency.
Meaning: The node ID during instance runtime.

©2013-2022 Tencent Cloud. All rights reserved.

Page 466 of 500

TencentDB for Redis

RunId

String

The node ID during instance runtime.
Service status

Connected

Integer- 0 : Down.
- 1 : On.

InstanceEnumParam
Description of the instance parameter in Enum type
Used by actions: DescribeInstanceParams.
Name

Type

Description

ParamName

StringParameter name

ValueType

StringParameter type, such as Enum .

NeedRestart

StringWhether to restart the database after modifying the parameters. Valid values: true (required) - false (not required)

DefaultValue

StringDefault value of the parameter

CurrentValue

StringCurrent value

Tips

StringDescription

EnumValue
StatusArray of
StringInteger

Acceptable values for the parameter
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

StringParameter name

ValueType

StringParameter type: Integer©2013-2022 Tencent Cloud. All rights reserved.

Page 467 of 500

TencentDB for Redis

NeedRestart

StringWhether restart is required after a modification is made. Valid values: true, false

DefaultValue

StringDefault value of the parameter

CurrentValue

StringCurrent value

Tips

StringParameter description

Min

StringMinimum value of the parameter

Max

StringMaximum value of the parameter

StatusIntegerParameter status. 1: modifying; 2: modified

Unit

StringParameter 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

StringParameter name

ValueType

StringParameter Type such as MULTI

NeedRestart

StringWhether to restart the database after modifying the parameter. Valid values: true (required) - false (not required)

DefaultValue

StringDefault value of the parameter

CurrentValue

StringCurrent value

Tips

StringDescription

EnumValue

Array of
StringDescription

StatusIntegerParameter modification status. Valid values: - 1 (modifying) - 2 (modified)

InstanceNode©2013-2022 Tencent Cloud. All rights reserved.

Page 468 of 500

TencentDB for Redis

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

StringYes

Parameter name, such as “timeout”. For supported custom parameters, see
Setting Instance Parameters
Current parameter value. For example, if you set the current value of “timeout”

Value

StringYes

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

StringParameter name

PreValue

String

The value of the parameter before modification

NewValue

String

The value of the parameter after modification

StatusIntegerParameter configuration status- 1 : The parameter configuration is being modified.
- 2 : The parameter configuration has been modified successfully.
- 3 : Failed to modify the parameter configuration.

©2013-2022 Tencent Cloud. All rights reserved.

Page 469 of 500

TencentDB for Redis

ModifyTime

StringModification time

InstanceProxySlowlogDetail
Proxy slow query details
Used by actions: DescribeProxySlowLog.
Name

Type

Description

Duration

Integer

Slow query duration in milliseconds

ClientStringClient address

Command

StringSlow query command

CommandLine

String

Detailed command line information of slow query

ExecuteTime

StringExecution time

InstanceSecurityGroupDetailSecurity group information of the instance
Used by actions: DescribeInstanceSecurityGroup.
Name

Type

Description

InstanceId

String

Instance ID

SecurityGroupDetails

Array of
SecurityGroupDetailSecurity group information, which includes security group ID,
name, outbound and inbound rules.

InstanceSet
List of instance details
Used by actions: DescribeInstances.
Name

Type

©2013-2022 Tencent Cloud. All rights reserved.

Description

Page 470 of 500

TencentDB for Redis

InstanceName

String

Instance nameInstanceId

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
Region IDs.
1: Guangzhou.
4: Shanghai.
5: Hong Kong, China.
6: Toronto.
8: Beijing.
9: Singapore.

RegionId

Integer

15: West US (Silicon Valley).
16: Chengdu.
17: Frankfurt.
18: Seoul.
19: Chongqing.
21: Mumbai.
22: East US (Virginia).
23: Bangkok.
25: Tokyo.

ZoneIdInteger

Region ID

VpcId

Integer

VPC ID, such as 75101 .

SubnetId

IntegerSubnet ID, such as 46315 .
Current instance status.
0 : To be initialized.
1 : In the process.

StatusInteger

2 : Running.
-2 : Isolated.
-3 : To be deleted.

WanIp

String

Instance VIPPort

Integer

Port number of an instance

Createtime

String

Instance creation time in the format of "2020-01-15
10:20:00"©2013-2022 Tencent Cloud. All rights reserved.

Page 471 of 500

TencentDB for Redis

Size

Float

Instance memory capacity in MB (1 MB = 1024 KB)

SizeUsed

Float

This field has been disused. You can use the TCOP
GetMonitorData API to query the capacity used by the
instance.
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).

Type

Integer- 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).
Whether to set the auto-renewal flag for an instance.
1 : Auto-renewal set.

AutoRenewFlag

Integer

DeadlineTime

String

The time when a monthly subscribed instance expires

EngineStringEngine: Redis community edition, Tencent Cloud CKV

0 : Auto-renewal not set.

Product type.
standalone : Standard edition.

ProductType

String

UniqVpcId

String

VPC ID, such as vpc-fk33jsf43kgv.

UniqSubnetId

String

VPC subnet ID, such as subnet-fd3j6l35mm0.

BillingMode

Integer

Billing mode. Only pay-as-you-go billing is supported.

InstanceTitle

StringDescription of an instance status, such as "Running".

cluster : Cluster edition.

The default termination time for isolated instances in the
OfflineTime

Stringformat of "2020-02-15 10:20:00". By default, a pay-as-yougo instance will be terminated after two hours of isolation,
and a monthly subscribed instance will be terminated after
seven days by default.

©2013-2022 Tencent Cloud. All rights reserved.

Page 472 of 500

TencentDB for Redis

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

IntegerNumber of shards

RedisReplicasNum

IntegerNumber of replicas

PriceId

Integer

Billing ID

CloseTime

String

The time when an instance start to be isolated

SlaveReadWeight

Integer

Read weight of a replica node

Array ofNote: This field may return null, indicating that no valid

InstanceTagInfo

values can be obtained.

ProjectName

StringNote: This field may return null, indicating that no valid
values can be obtained.

NoAuthBooleanNote: This field may return null, indicating that no valid
values can be obtained.

ClientLimit

Integer

DtsStatus

Integer

NetLimit

Integer

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

PasswordFree

Integer

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

Vip6

StringIPv6

StringNote: This field may return null, indicating that no valid
values can be obtained.

ReadOnly

Integer

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

InstanceTags©2013-2022 Tencent Cloud. All rights reserved.

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

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

Page 473 of 500

TencentDB for Redis

RemainBandwidthDuration

StringNote: This field may return null, indicating that no valid
values can be obtained.

DiskSize

Integer

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

MonitorVersion

StringNote: This field may return null, indicating that no valid
values can be obtained.

ClientLimitMin

Integer

ClientLimitMax

Integer

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

NodeSetArray of
RedisNodeInfo

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

RegionStringWanAddress

StringPolarisServer

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

CurrentProxyVersion

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

CurrentRedisVersion

StringUpgradeProxyVersion

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

UpgradeRedisVersion

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

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

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

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

InstanceSlowlogDetail
Slow log details
Used by actions: DescribeSlowLog.
Name

Type

©2013-2022 Tencent Cloud. All rights reserved.

Description

Page 474 of 500

TencentDB for Redis

Duration

Integer

Slow log duration

ClientStringClient address

Command

StringCommandCommandLine

StringCommand line details

ExecuteTime

StringExecution duration

Node

StringNode ID

InstanceTagInfo
Instance tag information
Used by actions: DescribeInstances.
Name

Type

Required

Description

TagKeyStringYes

Tag key

TagValue

StringYes

Tag value

InstanceTextParam
Description of instance parameter in Char type
Used by actions: DescribeInstanceParams.
Name

Type

Description

ParamName

StringParameter name

ValueType

StringParameter type such as Text .

NeedRestart

StringDefaultValue

StringDefault value of the parameter

CurrentValue

StringCurrent value

Tips

StringDescription

Whether to restart the database after modifying the parameter. Valid values: true (required) - false (not required)©2013-2022 Tencent Cloud. All rights reserved.

Page 475 of 500

TencentDB for Redis

TextValue

Array of
StringAcceptable values of the parameter

StatusIntegerParameter 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 nameRegion ID.
1 : Guangzhou.
4 : Shanghai.
5 : Hong Kong (China).
6 : Toronto.

RegionId

Integer

7 : Shanghai Finance.
8 : Beijing.
9 : Singapore.
11 : Shenzhen Finance.
15 : West US (Silicon Valley).

ZoneIdInteger

Region ID

RedisReplicasNum

IntegerNumber of replicas

RedisShardNum

IntegerNumber of shards

RedisShardSize

Integer

Shard memory size.

Integer

Instance disk size
Note: This field may return null, indicating that no valid values can be

DiskSizeobtained.
EngineStringEngine: Redis Community Edition, Tencent Cloud CKV.

©2013-2022 Tencent Cloud. All rights reserved.

Page 476 of 500

TencentDB for Redis

Read-write permission of the instance.
Role

StringVip

String

Vip6

Stringrw : Read/Write.
r : Read-only.

Instance VIPDue to the naming irregularity of this parameter, it is recommended to use theparameter IPv6 instead. Internal parameters, which can be ignored by users.
Note: This field may return null, indicating that no valid values can beobtained.

IPv6

StringInternal parameters, which can be ignored by users.
Note: This field may return null, indicating that no valid values can beobtained.

VpcID

Integer

VPC ID, such as 75101 .

VPort

Integer

Instance port
Instance status.
0 : Uninitialized.
1 : In the process.

StatusInteger

2 : Running.
-2 : Isolated.
-3 : To be deleted.

GrocerySysId

Integer

Repository ID
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)

ProductType

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

©2013-2022 Tencent Cloud. All rights reserved.

Page 477 of 500

TencentDB for Redis

OutboundSecurity group outbound rule
Used by actions: DescribeDBSecurityGroups, DescribeProjectSecurityGroups.
Name

Type

Description

ActionStringPolicy. Valid values: ACCEPT, DROP.

AddressModule

String

All the addresses that the address group ID represents.

CidrIpStringSource IP or IP address range, such as 192.168.0.0/16.

Desc

StringDescription.

IpProtocol

StringNetwork 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

StringParameter template ID

NameStringParameter template name

Description

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

©2013-2022 Tencent Cloud. All rights reserved.

Page 478 of 500

TencentDB for Redis- 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

StringParameter nameParamType

StringParameter TypeDefault

StringDefault value of the parameter

Description

StringParameter description

CurrentValue

StringCurrent value of the parameter
Whether to restart the database for the modified parameters to take effect

NeedReboot

Integer- 0 : No restart.
- 1 : Restart required.

Max

StringMaximum value of the parameter
Note: This field may return null, indicating that no valid values can beobtained.
Minimum value of the parameter

Min

EnumValue

StringArray of
StringNote: This field may return null, indicating that no valid values can beobtained.
Enumerated values of the parameter. It is null if the parameter is nonenumerated
Note: This field may return null, indicating that no valid values can beobtained.

ProductConf
Product information©2013-2022 Tencent Cloud. All rights reserved.

Page 479 of 500

TencentDB for Redis

Used by actions: DescribeProductInfo.
Name

Type

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

Type

Integer- 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).
Product names, including Redis Master-Replica Edition, Redis

TypeName

StringStandalone Edition, Redis 4.0 Cluster Edition, CKV Master-Replica
Edition, and CKV Standalone Edition.

MinBuyNum

Integer

Minimum purchasable quantity

MaxBuyNum

IntegerMaximum purchasable quantity

BooleanWhether a product is sold out- true : Sold out.

Saleout- false : Not sold out.
EngineStringProduct engines, including Tencent Cloud CKV and Redis Community
Edition.

VersionStringCompatible versions, including Redis 2.8, 3.2, 4.0, 5.0, and 6.2.

TotalSize

Array of
StringTotal capacity in GB

ShardSize

Array of
StringShard size in GB

ReplicaNum

Array of
StringQuantity of replicas

ShardNum
PayModeArray of
StringStringQuantity of shards
Supported billing modes- 1 : Monthly subscription.

©2013-2022 Tencent Cloud. All rights reserved.

Page 480 of 500

TencentDB for Redis- 0 : Pay-as-you-go.
Due to spelling inconsistency in this parameter name, it isEnableRepicaReadOnly

Booleanrecommended to use the EnableReplicaReadOnly parameter
instead. Its meaning refers to whether the Read-Only Replica issupported.
- true: Supported.
- false: Not supported.
Whether the Read-Only Replica is supported.
- true: Supported.

EnableReplicaReadOnly

Boolean- false: Not supported.
Note: This field may return null, indicating that no valid value can beobtained.

ProxyNodes
Proxy node information
Used by actions: DescribeInstanceNodeInfo.
Name

Type

Description

NodeIdStringZoneIdInteger

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

StringBackup start time

BackupId

StringBackup task ID

BackupType

StringBackup type. Valid values: 1 (Automatic backup in the early morning initiated by
the system.) 0 : Manual backup initiated by the user.

©2013-2022 Tencent Cloud. All rights reserved.

Page 481 of 500

TencentDB for Redis

StatusInteger

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.

RemarkStringBackup remarks

LockedInteger

Whether the backup is locked. Valid values: - 0 (no) - 1 (yes)BackupSize

IntegerInternal field, which can be ignored.
Note: This field may return null, indicating that no valid values can be obtained.

FullBackup

IntegerInternal field, which can be ignored.
Note: This field may return null, indicating that no valid values can be obtained.

InstanceType

Integer

InstanceId

String

Instance ID

InstanceName

String

Instance nameRegionString

The region where the local backup resides.

EndTimeStringBackup end time

FileType

StringBackup file type

ExpireTime

StringBackup file expiration time

Internal field, which can be ignored.
Note: This field may return null, indicating that no valid values can be obtained.

RedisCommonInstanceList
Instance information
Used by actions: DescribeCommonDBInstances.
Name

Type

Description

InstanceName

String

Instance nameInstanceId

String

Instance ID

AppId

Integer

ProjectId

Integer

User APPID, which is the unique application ID that matches an account. Some
Tencent Cloud products use this APPID.
Project ID of the instance©2013-2022 Tencent Cloud. All rights reserved.

Page 482 of 500

TencentDB for Redis

RegionString

Instance region

Zone

String

Instance AZ

VpcId

String

Instance VPC ID

SubnetId

String

VPC subnet ID
Instance status information- 1 : Task running.

Status- 2 : Instance running.

String- -2 : Instance isolated.
- -3 : Instance being eliminated.
- -4 : Instance eliminated.

Vips

Array of
StringPrivate network IP address of an instance

Vport

Integer

Instance network port

Createtime

String

Instance creation timeBilling type

PayModeInteger- 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
Event ID.

ID

Integer

InstanceId

StringNote: This field may return null, indicating that no valid values can beobtained.
Instance ID.Note: This field may return null, indicating that no valid values
can be obtained.

©2013-2022 Tencent Cloud. All rights reserved.

Page 483 of 500

TencentDB for Redis

InstanceName

Type

StringString

Instance name.Note: This field may return null, indicating that no valid
values can be obtained.
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.
Event levels are divided into Critical, High, Medium, and Low events
according to the severity and urgency.- Critical

Grade

String- High- Middle- Low
Note: This field may return null, indicating that no valid values can beobtained.
Scheduled event execution date.Note: This field may return null, indicating

ExecutionDate

StringStartTime

StringScheduled start time of event execution.Note: This field may return null,indicating that no valid values can be obtained.

EndTimeStringScheduled end time of event execution.Note: This field may return null,indicating that no valid values can be obtained.

that no valid values can be obtained.

The latest execution date of the operations event. Event execution must be
LatestExecutionDate

Stringcompleted before this date. Otherwise, the business may be affected.Note:
This field may return null, indicating that no valid values can be obtained.
Current event status.- Waiting: The event is waiting for execution on theexecution date or during the operations period.- Running: The event is being

StatusStringexecuted during the operations period.- Finished: Execution of the event
operations is completed.- Canceled: Execution of the event iscanceled.Note: This field may return null, indicating that no valid values canbe obtained.

TaskEndTime

StringCompletion time of the event execution task.
Note: This field may return null, indicating that no valid values can beobtained.

EffectInfo

String

InitialExecutionDate

String

Impact of the event.Note: This field may return null, indicating that no valid
values can be obtained.
Initial scheduled execution date of the event.Note: This field may return null,indicating that no valid values can be obtained.

©2013-2022 Tencent Cloud. All rights reserved.

Page 484 of 500

TencentDB for Redis

RedisNode
Running information of Redis nodes
Used by actions: DescribeInstanceZoneInfo.
Name

Type

Description

Keys

IntegerNumber of keys on Redis nodes

Slot

StringSlot distribution range for Redis node. Value range: 0-5460.

NodeIdStringNode sequence ID

StatusStringNode status

Role

StringNode role

RedisNodeInfo
Master or replica node information of the TencentDB for Redis instance.
Used by actions: CloneInstances, CreateInstances, DescribeInstances, ModifyInstanceAvailabilityZones,
UpgradeInstance.
Name

NodeType

Type

Integer

RequiredYes

Description
Node type.
0 : Master node.
1 : Replica node.

ID of the master or replica nodeThis parameter is optional when the CreateInstances API is used tocreate a TencentDB for Redis instance, but it is required when the
UpgradeInstance API is used to adjust the configuration of an

NodeIdIntegerNo

ZoneIdIntegerNo

ID of the AZ of the master or replica node

ZoneName

StringNo

Name of the AZ of the master or replica node

instance by deleting a replica.
You can use the DescribeInstances API to get the node ID of integertype.

©2013-2022 Tencent Cloud. All rights reserved.

Page 485 of 500

TencentDB for Redis

RedisNodes
Redis node information
Used by actions: DescribeInstanceNodeInfo.
Name

Type

Description

NodeIdStringNode ID

NodeRole

StringNode role

ClusterId

Integer

Shard ID

ZoneIdInteger

AZ ID

RegionConf
Region information
Used by actions: DescribeProductInfo.
Name

Type

Description

RegionId

StringRegion ID

RegionName

StringRegion nameRegionShortName

StringRegion abbreviation

Area

StringName of the area where a region is locatedZoneSetArray of ZoneCapacityConf

AZ information

ReplicaGroup
Information of the instance node group
Used by actions: DescribeInstanceZoneInfo.
Name

Type

Description

GroupId

Integer

Node group ID©2013-2022 Tencent Cloud. All rights reserved.

Page 486 of 500

TencentDB for Redis

GroupName

StringNode group name, which is empty for the master node

ZoneIdStringNode AZ ID, such as ap-guangzhou-1

Role

StringNode group type. Valid values: master (master node group); replica (replica
node group)

RedisNodes

Array of

List of nodes in the node group

RedisNode

ResourceTag
Tag bound to the instance purchased via API
Used by actions: CloneInstances, CreateInstances.
Name

Type

Required

Description

TagKeyStringYes

Tag key

TagValue

StringYes

The value corresponding to the tag key

SecurityGroup
Security group rules
Used by actions: DescribeDBSecurityGroups, DescribeProjectSecurityGroups.
Name

Type

Description

CreateTime

StringCreation time in the format of yyyy-mm-dd hh:mm:ss.

ProjectId

Integer

Project ID.

SecurityGroupId

StringSecurity group ID.

SecurityGroupName

StringSecurity group name.

SecurityGroupRemark

StringSecurity group remarks.

OutboundArray of OutboundOutbound rule.

Inbound

Array of InboundInbound rule.

©2013-2022 Tencent Cloud. All rights reserved.

Page 487 of 500

TencentDB for Redis

SecurityGroupDetailSecurity group details
Used by actions: DescribeInstanceSecurityGroup, DescribeProjectSecurityGroup.
Name

Type

Description

ProjectId

Integer

Project ID

CreateTime

StringSecurity group creation time

SecurityGroupId

StringSecurity group ID

SecurityGroupName

StringSecurity group nameSecurityGroupRemark

StringSecurity group remarks

InboundRule

Array of
SecurityGroupsInboundAndOutboundInbound 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

ActionStringIdentify whether the IP and port for accessing the database are allowed

Ip

StringIP address for accessing the database

Port

String

Port number

Proto

StringProtocol type

SourceCommand
Access command©2013-2022 Tencent Cloud. All rights reserved.

Page 488 of 500

TencentDB for Redis

Used by actions: DescribeInstanceMonitorTopNCmd.
Name

Type

Description

Cmd

StringCommandCount

IntegerNumber of executions

SourceInfo
Access source information
Used by actions: DescribeInstanceMonitorSIP.
Name

Type

Description

Ip

StringSource IP

Conn

IntegerNumber of connections

Cmd

Integer

Command

TaskInfoDetail
Task details
Used by actions: DescribeTaskList.
Name

Type

Description

TaskIdInteger

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

StartTime

StringTask start time
Note: This field may return null, indicating that no valid values can be obtained.

TaskType

StringTask type. Valid values: - FLOW_CREATE : Create an instance. FLOW_MODIFYCONNECTIONCONFIG : Adjust the number of bandwidthconnections. - FLOW_MODIFYINSTANCEPASSWORDFREE : Modify the processof password-free access. - FLOW_CLEARNETWORK : Returning VPC FLOW_SETPWD : Set the access password. - FLOW_EXPORSHR : Expand or
reduce the capacity. - FLOW_UpgradeArch : Upgrade the instancearchitecture. - FLOW_MODIFYINSTANCEPARAMS : Modify the instance©2013-2022 Tencent Cloud. All rights reserved.

Page 489 of 500

TencentDB for Redis

parameters. - FLOW_MODIFYINSTACEREADONLY : Modify read-only process. FLOW_CLOSE : Disable the instance. - FLOW_DELETE : Delete the instance. FLOW_OPEN_WAN : Enable the public network. - FLOW_FLOW_CLEAN : Clear
the instance. - FLOW_MODIFYINSTANCEACCOUNT : Modify the instanceaccount. - FLOW_ENABLEINSTANCE_REPLICATE : Enable the replica readonly feature. - FLOW_DISABLEINSTANCE_REPLICATE : Disable the replica
read-only feature. - FLOW_SWITCHINSTANCEVIP : Swap the VIPs of instances.
- FLOW_CHANGE_REPLICA_TO_MSTER: Promote the replica node to themater node. Backup instance
Note: This field may return null, indicating that no valid values can be obtained.
InstanceName

String

Instance nameNote: 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

Progress

Float

EndTimeStringProject ID
Note: This field may return null, indicating that no valid values can be obtained.
Task progress
Note: This field may return null, indicating that no valid values can be obtained.
Task end time
Note: This field may return null, indicating that no valid values can be obtained.
Task execution status. Valid values: - 0 (initilized) - 1 (executing) - 2

ResultInteger(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

NodeIdStringNode ID

NodeRole

StringNode role

TendisSlowLogDetail©2013-2022 Tencent Cloud. All rights reserved.

Page 490 of 500

TencentDB for Redis

Tendis slow query details
Used by actions: DescribeTendisSlowLog.
Name

Type

Description

ExecuteTime

StringExecution time

Duration

Integer

Duration of the slow query (ms)Command

StringCommandCommandLine

StringCommand line details

Node

StringNode ID

TradeDealDetail
Order transaction information
Used by actions: DescribeInstanceDealDetail.
Name

Type

Description

DealIdStringOrder ID, which is used when a TencentCloud API is called.

DealName

StringLong order ID, which is used when an order issue is submitted for assistance.

ZoneIdInteger

AZ ID

GoodsNum

IntegerNumber of instances associated with the order

CreaterStringCreator UIN

CreatTime

StringOrder creation time

OverdueTime

StringOrder timeout period

EndTimeStringOrder completion time

StatusInteger

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: orderinvalidated; 10: product invalidated; 11: requested payment rejected; 12: paying

Description

StringOrder status description

PriceInteger

Actual total price of the order in 0.01 CNY©2013-2022 Tencent Cloud. All rights reserved.

Page 491 of 500

TencentDB for Redis

InstanceIds

Array

Instance ID

ofString

ZoneCapacityConf
Product information in the availability zone
Used by actions: DescribeProductInfo.
Name

Type

Description

ZoneIdStringAZ ID, such as ap-guangzhou-3

ZoneName

String

AZ nameIsSaleout

BooleanWhether a product is sold out in an AZ

IsDefault

BooleanWhether 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©2013-2022 Tencent Cloud. All rights reserved.

Page 492 of 500

TencentDB for Redis

Error Codes：

Last updated 2024-04-15 11:08:47

Feature Description
If there is an Error field in the response, it means that the API call failed. For example:{"Response": {"Error": {"Code": "AuthFailure.SignatureFailure","Message": "The provided credentials could not be validated. Please check your si
gnature is correct."},"RequestId": "ed93f3cb-f35e-473f-b9f3-0d451b8b79c6"}}
Code in Error indicates the error code, and Message indicates the specific information of the error.

Error Code List
Common Error Codes
Error CodeDescription

ActionOffline

This API has been deprecated.

AuthFailure.InvalidAuthorization

Authorization in the request header is invalid.

AuthFailure.InvalidSecretId

Invalid key (not a TencentCloud API key type).

AuthFailure.MFAFailure

MFA failed.
Key does not exist. Check if the key has been

AuthFailure.SecretIdNotFound

AuthFailure.SignatureExpire

deleted or disabled in the console, and if not, checkif the key is correctly entered. Note that whitespaces
should not exist before or after the key.
Signature expired. Timestamp and server timecannot differ by more than five minutes. Please©2013-2022 Tencent Cloud. All rights reserved.

Page 493 of 500

TencentDB for Redis

ensure your current local time matches the standard
time.
Invalid signature. Signature calculation error. Please
AuthFailure.SignatureFailure

AuthFailure.TokenFailure
AuthFailure.UnauthorizedOperation

ensure you’ve followed the signature calculation
process described in the Signature API
documentation.
Token error.
The request is not authorized. For more information,
see the CAM documentation.

DryRunOperation

DryRun Operation. It means that the request would
have succeeded, but the DryRun parameter wasused.

FailedOperation

Operation failed.

InternalError

Internal error.

InvalidAction

The API does not exist.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Invalid parameter value.

InvalidRequest

The multipart format of the request body is incorrect.

IpInBlacklist

Your IP is in uin IP blacklist.

IpNotInWhitelistYour IP is not in uin IP whitelist.

LimitExceeded

Quota limit exceeded.

MissingParameter

A parameter is missing.

NoSuchProduct

The product does not exist.

NoSuchVersion

The API version does not exist.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

RequestLimitExceeded.GlobalRegionUinLimitExceeded

Uin exceeds the frequency limit.

RequestLimitExceeded.IPLimitExceeded
RequestLimitExceeded.UinLimitExceeded©2013-2022 Tencent Cloud. All rights reserved.

The number of ip requests exceeds the frequency
limit.
The number of uin requests exceeds the frequency

Page 494 of 500

TencentDB for Redis

limit.
RequestSizeLimitExceeded

The request size exceeds the upper limit.

ResourceInUse

Resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceUnavailable

Resource is unavailable.

ResponseSizeLimitExceeded

The response size exceeds the upper limit.

ServiceUnavailable

Service is unavailable now.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

UnsupportedProtocol

HTTP(S) request protocol error; only GET and
POST requests are supported.

UnsupportedRegion

API does not support the requested region.

Service Error Codes
Error CodeDescription

AuthFailure

CAM signature/authentication error.

FailedOperation.AddInstanceInfoFailed
FailedOperation.AssociateSecurityGroupsFailed
FailedOperation.ClearInstanceInfoFailed

Failed to add the security group information of
the instance.
Failed to associate the security group.
Failed to clear the security group informationof the instance.

FailedOperation.CommitFlowError

Failed to submit the task.

FailedOperation.DisassociateSecurityGroupsFailed

Failed to unbind the security group.

FailedOperation.DtsStatusAbnormal

This operation is not allowed under the current
DTS status.

FailedOperation.FlowNotExists

No process exists.

©2013-2022 Tencent Cloud. All rights reserved.

Page 495 of 500

TencentDB for Redis

FailedOperation.GetSecurityGroupDetailFailed

Failed to query the security group details. Tryagain later.

FailedOperation.PayFailed

Payment failed.

FailedOperation.RedoFlowFailed

No exact description for this error code for thetime being.

FailedOperation.SetRuleLocationFailed

Failed to set the rule.

FailedOperation.SystemError

Internal system error, which is irrelevant to thebusiness.

FailedOperation.UnSupportError

The instance does not support this API.

FailedOperation.Unknown

Invalid data is entered for weekday.

FailedOperation.UpdateInstanceInfoFailed

Failed to update the security group
information of the instance.

FailedOperation.UpdateSecurityGroupsFailed

Failed to update the security group.

InternalError.CamAuthOssResponseReturnCodeError

A CAM authentication error occurred.

InternalError.DbOperationFailed

Internal system error with the database
operation, which may be update, insert,
select, etc.

InternalError.ExecHttpRequestError

Failed to execute the HTTP request. Try again
later.

InternalError.InstanceOperatePermissionError

You do not have the operation permission.

InternalError.InternalError

Internal error.

InternalError.ListInstancesError

An error occurred while obtaining the list of
instances. Try again later.

InternalError.NetWorkErr

A network error occurred.

InvalidParameter.ActionNotFoundThe corresponding API was not found.

InvalidParameter.EmptyParam

The parameter is empty.

InvalidParameter.IllegalParameterError

Invalid parameter.

InvalidParameter.InstanceSGOverLimitError

The security groups of the instance exceeds
the limit.

©2013-2022 Tencent Cloud. All rights reserved.

Page 496 of 500

TencentDB for Redis

InvalidParameter.InvalidParameter

Invalid service parameter.

InvalidParameter.IsNotVpcInstance

The instance is not in a VPC.

InvalidParameter.NotSupported

The operation is unsupported due to incorrect
parameters.

InvalidParameter.OnlyVPCOnSpecZoneId

Only VPCs are provided in the Shanghai
Finance AZ.

InvalidParameter.Period

The time format or time range is invalid.

InvalidParameter.PermissionDenied

The API has no CAM permissions.

InvalidParameterValue.BackupNotExists

The backup does not exist.

InvalidParameterValue.BaseNetWorkAccessDeny

The instance is not in a VPC.

InvalidParameterValue.CheckNotPass

Business verification failed

InvalidParameterValue.InstanceNameRuleError

A renaming rule error occurred.

InvalidParameterValue.InvalidInstanceTypeId

InvalidParameterValue.InvalidSubnetId

The type of instances requested for purchaseis incorrect (TypeId - 1: Cluster Edition; 2:Master-Replica Edition, i.e., the legacy
Master-Replica Edition).
The vpcid or subnet ID in the VPC isinvalid.

InvalidParameterValue.MemSizeNotInRange

The requested capacity is out of thepurchasable capacity range.

InvalidParameterValue.NotRepeatBind

The instance has already been bound.

InvalidParameterValue.PasswordEmpty

The password is empty.

InvalidParameterValue.PasswordError

Password verification error due to incorrect
password.

InvalidParameterValue.PasswordFreeDenied

Tencent internal accounts are not allowed touse password-free instances.
When the password is set, the old password

InvalidParameterValue.PasswordRuleError

passed in by MC does not match thepreviously set password.

InvalidParameterValue.ReduceCapacityNotAllowed

The request capacity is too small. Capacity
reduction is not supported.

©2013-2022 Tencent Cloud. All rights reserved.

Page 497 of 500

TencentDB for Redis

InvalidParameterValue.ReplicationGroupNotExists
InvalidParameterValue.SecurityGroupIdsNotExists

The global replication group doesn’t exist.
The request parameter or security group ID isincorrect.

InvalidParameterValue.SpecNotExist

The instance specification doesn’t exist.

InvalidParameterValue.UnSupportedType

The instance type is not supported.

InvalidParameterValue.UnVpcIdNotExists
InvalidParameterValue.WeekDaysIsInvalid
LimitExceeded.ExceedUpperLimit

The uniqVpcId or subnet ID in the VPC isinvalid.
Invalid data is entered for weekday .
The number of bound instances exceeds theupper limit.

LimitExceeded.InstanceNotEmpty

The bound instance must not be specified.

LimitExceeded.InvalidMemSize

The requested capacity is out of thepurchasable specification range ( memSize
should be an integer multiple of 1,024 in MB).
The number of instances requested for

LimitExceeded.InvalidParameterGoodsNumNotInRange

LimitExceeded.MemSizeNotInRange

purchase at a time is out of the purchasable
quantity range.
The requested capacity is out of thepurchasable capacity range.
The requested length of purchase is more

LimitExceeded.PeriodExceedMaxLimit

LimitExceeded.PeriodLessThanMinLimit

LimitExceeded.ReachTheAmountLimit

than three years and exceeds the maximum
value.
The length of purchase is invalid. It must be atleast one month.
The quantity of requested TencentDB for
Redis instances falls out of the limit range.

LimitExceeded.ReplicationGroupLocked

Replication group locked

ResourceInUse.InstanceBeenLocked

The instance is locked by another process.

ResourceNotFound.AccountDoesNotExists

The UIN value is empty.

ResourceNotFound.InstanceNotExists

No Redis instance is found by the serialId.

©2013-2022 Tencent Cloud. All rights reserved.

Page 498 of 500

TencentDB for Redis

ResourceNotFound.InstanceNotFoundThe instance was not found.

ResourceUnavailable.AccountBalanceNotEnoughThe request order number does not exist.

ResourceUnavailable.BackupLockedError

The backup has been locked by another task,
and the operation cannot be performed
temporarily.

ResourceUnavailable.BackupSpecError

ResourceUnavailable.BackupStatusAbnormal

Backup and recovery specifications are notsupported.
Backup status exception. The operation
cannot be performed temporarily. The backup
may have expired or been deleted.

ResourceUnavailable.BackupStatusInvalid

Backup is not supported when the instance is
not in the “Running” status.

ResourceUnavailable.CallOssError

Failed to call the backend API.

ResourceUnavailable.GetSecurityError

Failed to get the security group information.

ResourceUnavailable.InstanceConfError

An instance configuration error occurred.

ResourceUnavailable.InstanceDeleted

The instance has already been repossessed.

ResourceUnavailable.InstanceIsolated

The instance has expired.

ResourceUnavailable.InstanceLockedError

Redis has been locked by another process.

ResourceUnavailable.InstanceNoDeal

The order does not exist.

ResourceUnavailable.InstanceNotSupportOperation

Instances in this status do not support theoperation.

ResourceUnavailable.InstanceStateError

Instance status error.

ResourceUnavailable.InstanceStatusAbnormal

The Redis status is exceptional, and thecorresponding process cannot be executed.

ResourceUnavailable.InstanceStatusError

Operation unsupported: the instance is
exceptional.

ResourceUnavailable.InstanceUnLockedError

The instance has been locked by anotherprocess.

ResourceUnavailable.NoEnoughVipInVPCThe IP resources in the VPC are insufficient.

ResourceUnavailable.NoRedisService

The requested region currently does not©2013-2022 Tencent Cloud. All rights reserved.

Page 499 of 500

TencentDB for Redis

provide the Redis service.
ResourceUnavailable.NoServiceAvailableForThisZoneId

ResourceUnavailable.NoTypeIdRedisService

ResourceUnavailable.SaleOut

ResourceUnavailable.SecurityGroupNotSupported

The requested zoneId doesn’t provide
Redis service.
The requested region currently does notprovide the requested type of Redis service.
Resources of the specified type in the region
are sold out.
The product has not been connected to any
security group.

UnauthorizedOperation.NoCAMAuthed

No CAM permissions.

UnauthorizedOperation.UserNotInWhiteList

The user is not in the allowlist.

UnsupportedOperation.ClusterInstanceAccessedDeny

The Redis cluster edition is not allowed toconnect to a security group.

UnsupportedOperation.Inspection

Inspecting replication group

UnsupportedOperation.InstanceNotOperation

Unsupported operation

UnsupportedOperation.IsAutoRenewError

There is an error with the auto-renewal flag.

UnsupportedOperation.LimitProxyVersion

The instance version is too low.

UnsupportedOperation.OnlyClusterInstanceCanExportBackup©2013-2022 Tencent Cloud. All rights reserved.

Only Cluster Edition instances support
backup exporting.

Page 500 of 500