tencent cloud

APIs

ドキュメントAPIsTencent Cloud Distributed Cache (Redis OSS-Compatible)Data Types

Data Types

Download
フォーカスモード
フォントサイズ
最終更新日: 2026-08-14 16:53:29

Account

Sub-account information

Used by actions: DescribeInstanceAccount.

Name Type Description
InstanceId String

Instance ID.
AccountName String

Account name.
Remark String

Account description.
Privilege String

Read/write permission policy. - r: read-only. - w: write-only. - rw: read-write.
ReadonlyPolicy Array of String

Read-only Routing Policy. - master: Master node. - replication: Replica node.
Status Integer

Sub-account status. - 1: Account change in progress. - 2: Valid. - 4: Deleted.
CreateTime String

Account creation time.

If the parameter is an empty string, the account was created in an earlier version where the recording feature was not supported.
PasswordLastModifiedTime String

The time when the account last changed the password.

If the parameter is an empty string, it means the account was created in an earlier version that did not support the password modification time recording feature.

AvailableRegion

Available region information.

Used by actions: DescribeGlobalReplicationArea.

Name Type Description
Region String Region
AvailableZones Array of String AZ information

BackupDownloadInfo

Backup download information

Used by actions: DescribeBackupUrl.

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

BackupLimitVpcItem

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

Used by actions: DescribeBackupDownloadRestriction, DescribeBackupUrl, ModifyBackupDownloadRestriction.

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

BigKeyInfo

Big key details

Used by actions: DescribeInstanceMonitorBigKey.

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

BigKeyTypeInfo

Big key type distribution details

Used by actions: DescribeInstanceMonitorBigKeyTypeDist.

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

CDCResource

Details of the dedicated Redis cluster.

Used by actions: DescribeRedisClusters.

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

CommandTake

Command duration

Used by actions: DescribeInstanceMonitorTopNCmdTook.

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

DelayDistribution

Delay distribution details

Used by actions: DescribeInstanceMonitorBigKeySizeDist, DescribeInstanceMonitorTookDist.

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

DeliverSummary

Shipping information

Used by actions: DescribeLogInstanceList.

Name Type Required Description
DeliverType String No

Delivery Type, store (storage class), mq (message channel)
DeliverSubType String No

Delivery subtype: cls, ckafka.
DeliverConsumer String No

Subscriber
DeliverConsumerName String No

Subscriber name
DeliverError String No

Delivery

DescribeInstanceDTSInstanceInfo

Details of instances in the DTS task

Used by actions: DescribeInstanceDTSInfo.

Name Type Description
RegionId Integer Region ID.
InstanceId String Instance ID.
SetId Integer Repository ID.
ZoneId Integer AZ ID.
Type Integer Instance type.
InstanceName String Instance name.
Vip String Instance access address.
Status Integer Status.

ExportFile

export file

Used by actions: DescribeExportTasks.

Name Type Required Description
FileName String No

File name.
Status String No

Status value.

Enumeration values:

  • creating: File creation in progress,
  • success: File generated,
  • failed: File generation failed,
  • deleted: File deleted.
FileSize Integer No

File size. Measurement unit: byte.
CreateTime String No

File creation time.
DownloadUrl String No

Download link.
ErrMsg String No

Error information of the exported file.
Progress Integer No

Progress of the exported file.
FinishTime String No

Completion time of the exported file.
AsyncRequestId Integer No

Asynchronous request ID.

FailedInstance

Switch failed instance info

Used by actions: ModifyInstanceChargeType.

Name Type Description
InstanceId String

Failed instance ID
Message String

Failure information

Filter

Instance filter parameters on the business side

Used by actions: DescribeLogInstanceList.

Name Type Required Description
Name String Yes

Filter field.

Enumeration value:

  • InstanceId: Instance ID.
  • InstanceName: Instance name.
  • TagKey: Tag key.
  • InstanceTags: Instance tag key-value, tag key & tag value.
Values Array of String Yes

Value of the filter field.
ExactMatch Boolean No

Exact match switch.

  • false: Turn off.
  • true: Turn on.

Groups

Replication group info

Used by actions: DescribeReplicationGroup.

Name Type Description
AppId Integer User APPID, which is the unique application ID that matches an account. Some Tencent Cloud products use this APPID.
RegionId Integer Region ID.
- 1: Guangzhou.
- 4: Shanghai.
- 5: Hong Kong (China).
- 7: Shanghai Finance.
- 8: Beijing.
- 9: Singapore.
- 11: Shenzhen Finance.
- 15: Western US (Silicon Valley).
- 16: Chengdu.
- 17: Germany.
- 18: South Korea.
- 19: Chongqing.
- 22: Eastern US (Virginia).
- 23: Thailand.
- 25: Japan.
GroupId String Replication group ID in the format of "crs-rpl-deind****"
GroupName String Replication group name.
Status Integer Status of replication group
- 37: Associating replication group
- 38: Reconnecting to replication group
- 51: Disassociating replication group
- 52: Switching with master instance in replication group
- 53: Modifying the roles
InstanceCount Integer Number of replication groups
Instances Array of Instances Instance information on the replication group.
Remark String Remark information.

HotKeyInfo

Hot key details

Used by actions: DescribeInstanceMonitorHotKey.

Name Type Description
Key String The name of the hot key.
Type String Key type.
Count Integer Number of accesses for the hot key in a specified time period.

Inbound

Security group inbound rule

Used by actions: DescribeDBSecurityGroups, DescribeProjectSecurityGroups.

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

InstanceClusterNode

Instance node type

Used by actions: DescribeInstances.

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

InstanceClusterShard

Information list of instance shards

Used by actions: DescribeInstanceShards.

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

InstanceEnumParam

Description of the instance parameter in Enum type

Used by actions: DescribeInstanceParams.

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

InstanceInfo

Instance information

Used by actions: DescribeLogInstanceList.

Name Type Required Description
InstanceName String No

Instance name.
ProjectId Integer No

Project ID
Status Integer No

Instance status
SubStatus Integer No

Substatus of the instance in process returned.

Enumeration value:

  • 0: Read-only disk.
Region String No

Region.
Zone String No

Zone
DegradeStrategy Integer No

Degradation policy, measurement unit: ms. After the instance P99 reaches the degradation policy, audit data is automatically discarded to prioritize business availability. Default value: 500 ms. Range value: 300-1000 ms.
InstanceTags Array of InstanceTagInfo No

Tag information
Type Integer No

Architecture edition

InstanceIntegerParam

Description of the instance parameter in Integer type

Used by actions: DescribeInstanceParams.

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

InstanceMultiParam

Description of the instance parameter in Multi type

Used by actions: DescribeInstanceParams.

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

InstanceNode

Instance node

Used by actions: DescribeInstances.

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

InstanceParam

Instance parameter

Used by actions: CreateParamTemplate, ModifyInstanceParams, ModifyParamTemplate.

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

InstanceParamHistory

History of instance parameter modifications

Used by actions: DescribeInstanceParamRecords.

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

InstanceProxySlowlogDetail

Proxy slow query details

Used by actions: DescribeProxySlowLog.

Name Type Description
Duration Integer

Slow query duration. Measurement unit: ms.
Client String

Client address.
Command String

Slow query command.
CommandLine String

Slow query command line information.
ExecuteTime String

Execution time.
RecvClientEnd Integer

Duration of receiving client requests (ms)
SendClientEnd Integer

Duration of sending client requests (ms)
Node String

Proxy node ID.

InstanceSecurityGroupDetail

Security group information of the instance

Used by actions: DescribeInstanceSecurityGroup.

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

InstanceSet

List of instance details

Used by actions: DescribeInstances.

Name Type Description
InstanceName String

Instance name.
InstanceId String

Instance ID.
Appid Integer

User AppId. AppId is an application ID with a one-to-one correspondence to the account ID. Some Tencent Cloud products use this AppId.
ProjectId Integer

Project ID.
RegionId Integer

Region ID.

  • 1: Guangzhou.
  • 4: Shanghai.
  • 5: Hong Kong (China).
  • 7: Shanghai Finance.
  • 8: Beijing.
  • 9: Singapore.
  • 11: Shenzhen Finance.
  • 15: Western US (Silicon Valley).
  • 16: Chengdu.
  • 17: Frankfurt.
  • 18: Seoul.
  • 19: Chongqing.
  • 22: Eastern US (Virginia).
  • 23: Bangkok.
  • 25: Tokyo.
ZoneId Integer

Region ID.
VpcId Integer

vpc network ID, such as 75101.
SubnetId Integer

Subnet ID under vpc, for example: 46315.
Status Integer

Current instance status.

  • 0: to be initialized;
  • 1: in process;
  • 2: running;
  • -2: isolated;
  • -3: to be deleted.
WanIp String

Instance VIP.
Port Integer

Instance port number.
Createtime String

Instance creation time, for example, in the format of 2020-01-15 10:20:00.
Size Float

Instance memory capacity. Unit: MB (1 MB = 1024 KB).
Type Integer

Instance type.

Enumeration value:

  • 2: Redis 2.8 memory edition (standard architecture).
  • 3: CKV 3.2 memory edition (standard architecture).
  • 4: CKV 3.2 memory edition (cluster architecture).
  • 5: Redis 2.8 memory edition (standalone).
  • 6: Redis 4.0 memory edition (standard architecture).
  • 7: Redis 4.0 memory edition (cluster architecture).
  • 8: Redis 5.0 memory edition (standard architecture).
  • 9: Redis 5.0 memory edition (cluster architecture).
  • 15: Redis 6.2 memory edition (standard architecture).
  • 16: Redis 6.2 memory edition (cluster architecture).
  • 17: Redis 7.0 memory edition (standard architecture).
  • 18: Redis 7.0 memory edition (cluster architecture).
  • 19: Valkey 8.0 memory edition (standard architecture).
  • 20: Valkey 8.0 memory edition (cluster architecture).
  • 21: Valkey 8.0 memory edition (standard architecture).
  • 22: Valkey 8.0 memory edition (cluster architecture).
  • 200: Memcached 1.6 memory edition (cluster architecture).
AutoRenewFlag Integer

Whether the automatic renewal flag is set for an instance.

  • 1: set auto-renewal.
  • 0: automatic renewal flag not set.
DeadlineTime String

Expiration time of a monthly subscription instance.
Engine String

Engine. Valid values: Redis Community Edition and Tencent Cloud CKV.
ProductType String

Product type.

  • standalone: standard version.
  • cluster: cluster version.
UniqVpcId String

vpc Network id, such as vpc-fk33jsf43kgv.
UniqSubnetId String

subnet id under vpc, for example: subnet-fd3j6l35mm0.
BillingMode Integer

Billing mode.

  • 0: Pay-As-You-Go.
  • 1: Monthly Subscription.
InstanceTitle String

Description of instance running status: for example "instance running".
OfflineTime String

Default termination time of isolated instances. Pay-as-you-go instance offline after isolation. Monthly Subscription instance offline after 7 days. In the format of: 2020-02-15 10:20:00.
SubStatus Integer

Substatus of the instance in process returned.

  • 0: Read and write status of the disk.
  • 1: Read-only status of the disk due to exceeding limit.
Tags Array of String

Anti-affinity tag.
InstanceNode Array of InstanceNode

Instance node information.
RedisShardSize Integer

Shard size.
RedisShardNum Integer

Number of shards.
RedisReplicasNum Integer

Number of replicas.
PriceId Integer

Billing ID.
CloseTime String

Time when an instance starts to be isolated.
SlaveReadWeight Integer

Read weight of the secondary node.

  • 0: means disable read-only replica.
  • 100: means enable read-only replica.
InstanceTags Array of InstanceTagInfo

Tag information associated with an instance.
ProjectName String

Project name.
NoAuth Boolean

Whether an instance is a password-free instance.

  • true: yes;
  • false: no.
ClientLimit Integer

Number of client connections.
DtsStatus Integer

DTS status (internal parameter, can be ignored by users).
NetLimit Integer

Upper limit of the shard bandwidth. Unit: MB.
PasswordFree Integer

Password-free instance flag (internal parameter, which can be ignored).
Vip6 String

Internal parameter, which can be ignored. This parameter is not properly named. It is recommended to use the IPv6 parameter to replace it.
IPv6 String

Internal parameter, which can be ignored.
ReadOnly Integer

Instance read-only flag (internal parameter, which can be ignored).
RemainBandwidthDuration String

Internal parameter, which can be ignored.
DiskSize Integer

For Redis instances, ignore this parameter.
MonitorVersion String

Monitoring version.
ClientLimitMin Integer

Minimum value that can be set for the maximum number of client connections.
ClientLimitMax Integer

Maximum value that can be set for the maximum number of client connections.
NodeSet Array of RedisNodeInfo

Detailed node information of the instance.
Only multi-AZ instances will be returned.
Region String

Region information of an instance, for example, ap-guangzhou.
WanAddress String

Public network address.
PolarisServer String

Polaris service address for internal use.
RedisClusterId String

CDC Redis cluster ID.
DedicatedClusterId String

CDC cluster ID.
ProductVersion String

Product edition.

  • local: local disk;
  • cloud: cloud disk;
  • cdc: CDC cluster edition.
CurrentProxyVersion String

Current Proxy version of the instance.
CurrentRedisVersion String

Current Cache minor version of an instance. If the instance joins a global replication group, the kernel version of the global replication group will be displayed.
UpgradeProxyVersion String

Upgradable Proxy version of an instance.
UpgradeRedisVersion String

Upgradable Cache minor version of an instance.
BackupMode String

Backup mode.

  • SecondLevelBackup: second-level backup.
  • NormalLevelBackup: normal backup.
DeleteProtectionSwitch Integer

Instance destruction protection switch.

  • 0: disabled.
  • 1: enabled.

InstanceSlowlogDetail

Slow log details

Used by actions: DescribeSlowLog.

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

InstanceTagInfo

Instance tag information

Used by actions: DescribeInstances, DescribeLogInstanceList.

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

InstanceTextParam

Description of instance parameter in Char type

Used by actions: DescribeInstanceParams.

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

Instances

Instances in replication group

Used by actions: DescribeReplicationGroup.

Name Type Description
AppId Integer User APPID, which is the unique application ID that matches an account. Some Tencent Cloud products use this APPID.
InstanceId String Instance ID
InstanceName String Instance name
RegionId Integer Region ID.
  • 1: Guangzhou;
  • 4: Shanghai;
  • 5: Hong Kong (China);
  • 7: Shanghai Finance;
  • 8: Beijing;
  • 9: Singapore;
  • 11: Shenzhen Finance;
  • 15: Western United States (Silicon Valley).
ZoneId Integer Region ID
RedisReplicasNum Integer Number of replicas
RedisShardNum Integer Number of shards
RedisShardSize Integer Shard memory size.
DiskSize Integer Instance disk size.
Engine String Engine: Redis Community Edition, Tencent Cloud CKV.
Role String Read-write permission of the instance.
  • rw: Read/Write.
  • r: Read-only.
Vip String Instance VIP
Vip6 String This parameter encounters a naming issue. It is recommended to use the parameter IPv6 instead. It is an internal parameter and can be ignored.
IPv6 String Internal parameter, which can be ignored.
VpcID Integer VPC ID, such as 75101.
VPort Integer Instance port
Status Integer Instance status.
  • 0: Uninitialized.
  • 1: In the process.
  • 2: Running.
  • -2: Isolated.
  • -3: To be deleted.
GrocerySysId Integer Repository ID
ProductType Integer Instance type
- 2: Redis 2.8 Memory Edition (Standard Architecture).
- 3: CKV 3.2 Memory Edition (Standard Architecture).
- 4: CKV 3.2 Memory Edition (Cluster Architecture)
- 5: Redis 2.8 Memory Edition (Standalone)
- 6: Redis 4.0 Memory Edition (Standard Architecture).
- 7: Redis 4.0 Memory Edition (Cluster Architecture)
- 8: Redis 5.0 Memory Edition (Standard Architecture).
- 9: Redis 5.0 Memory Edition (Cluster Architecture)
- 15: Redis 6.2 Memory Edition (Standard Architecture).
- 16: Redis 6.2 Memory Edition (Cluster Architecture)
CreateTime String The time when the instance was added to the replication group.
UpdateTime String The time when instances in the replication group were updated.

LogDeliveryInfo

Log shipping information.

Used by actions: DescribeInstanceLogDelivery.

Name Type Required Description
Enabled Boolean No Enabling status of log shipping. true: enabled; false: disabled.
LogsetId String No Log set ID.
TopicId String No Log topic ID.
LogRegion String No Logset region

LogFilter

log filter criteria

Used by actions: CreateExportTask, DescribeLogs.

Name Type Required Description
Type String No

Filter criterion name.

Enumeration value:

  • Timestamp: Creation time (format: 2006-01-02 15:04:05.000)
  • UserName: User name
  • CacheCode: Cache code, backend redis node
  • ClientAddr: Client IP address
  • CommandDetail: Command details
  • CommandLatency: Command delay (ms)
  • CommandType: Command type
  • DBId: Database ID
  • ErrMsg: Error information
Compare String No

Condition match type.

Enumeration value:

  • INC: Include, multiple values have a || relationship before
  • EXC: Exclude, multiple values have a || relationship before
  • EQS: Equal, multiple values have a || relationship before
  • NEQ: Not equal, multiple values have a && relationship before
  • RA: Range
Value Array of String No

Matching value of the filter condition. When Compare=RA, for example: ["1-100","200-300"].

LogInstance

Instance

Used by actions: DescribeLogInstanceList.

Name Type Description
InstanceId String

Instance ID.
Status String

Log status, create: creating; normal: enabled; close: turning off.
EnableQuery String

Is it possible to switch log query - Value: yes - allowed, no - not allowed. This parameter mainly controls migration of existing logs to the log platform for query usage. Only when the status is yes can you call the log API.
CreateAt String

Start time
HighLogExpireDay Integer

High frequency storage days
LowLogExpireDay Integer

Infrequent storage days
LogExpireDay Integer

Total storage duration
HighStorage Float

High-frequency storage volume (in MB)
LowStorage Float

Infrequent access storage, unit: MB
LogStorage Float

Total storage
Deliver String

Whether to enable delivery: ON, OFF
DeliverSummary Array of DeliverSummary

Log shipping information
InstanceInfo InstanceInfo

Instance-related information on the business side varies according to business and returns different information.
LogSubType String

Audit sub-type.

LogResult

log result

Used by actions: DescribeLogs.

Name Type Required Description
DBId Integer No

Database ID
CommandLatency Integer No

Command delay (ms)
Timestamp String No

Creation time (Format: 2006-01-02 15:04:05.000)
ClientAddr String No

client address
UserName String No

Username.
CommandType String No

Command type
CacheCode String No

Cache code, backend redis node
CommandDetail String No

Command details
ErrMsg String No

Error information

Outbound

Security group outbound rule

Used by actions: DescribeDBSecurityGroups, DescribeProjectSecurityGroups.

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

ParamTemplateInfo

Parameter template information

Used by actions: DescribeParamTemplates.

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

ParameterDetail

Details of the parameters in the parameter template

Used by actions: DescribeParamTemplateInfo.

Name Type Description
Name String Parameter name
ParamType String Parameter Type
Default String Default value of the parameter
Description String Parameter description
CurrentValue String Current value of the parameter
NeedReboot Integer Whether to restart the database for the modified parameters to take effect
- 0: No restart.
- 1: Restart required.
Max String Maximum parameter value allowed.
Min String Minimum parameter value allowed.
EnumValue Array of String Optional enumeration values of a parameter. For non-enumeration parameters, it is empty.

PasswordPolicy

Password complexity of a Redis instance

Used by actions: CloneInstances, CreateInstances.

Name Type Required Description
Enabled Boolean Yes

Whether to enable the instance-level password complexity policy.

  • true: Enable. ALL password changes (create/reset) must pass the complexity verification defined below.
  • false: Disable. No complexity filtering is performed.

Default value: false
MinLetterCount Integer No

Minimum number of uppercase and lowercase letters.

  • Value ranges from 1 to 16.
  • Default value: 1.
MinDigitCount Integer No

Minimum number of numeric characters.

  • Value ranges from 1 to 16.
  • Default value: 1.
MinSpecialCount Integer No

Minimum number of special characters.

  • Value ranges from 1 to 16.
  • Default value: 1.
MinLength Integer No

Minimum total length of the password (number of characters).

  • Value ranges from 8 to 64.
  • Default value: 8.
  • Constraints and limitations: The minimum total length of the password must be at least the sum of three parameters: MinLetterCount, MinDigitCount, and MinSpecialCount.

ProductConf

Product information

Used by actions: DescribeProductInfo.

Name Type Description
Type Integer Product type
- 2: Redis 2.8 Memory Edition (Standard Architecture).
- 3: CKV 3.2 Memory Edition (Standard Architecture).
- 4: CKV 3.2 Memory Edition (Cluster Architecture).
- 5: Redis 2.8 Memory Edition (Standalone).
- 6: Redis 4.0 Memory Edition (Standard Architecture).
- 7: Redis 4.0 Memory Edition (Cluster Architecture).
- 8: Redis 5.0 Memory Edition (Standard Architecture).
- 9: Redis 5.0 Memory Edition (Cluster Architecture).
- 15: Redis 6.2 Memory Edition (Standard Architecture).
- 16: Redis 6.2 Memory Edition (Cluster Architecture).
TypeName String Product names, including Redis Master-Replica Edition, Redis Standalone Edition, Redis 4.0 Cluster Edition, CKV Master-Replica Edition, and CKV Standalone Edition.
MinBuyNum Integer Minimum purchasable quantity
MaxBuyNum Integer Maximum purchasable quantity
Saleout Boolean Whether a product is sold out
- true: Sold out.
- false: Not sold out.
Engine String Product engine. Valid values: Redis and CKV.
Version String Compatible versions, including Redis 2.8, 3.2, 4.0, 5.0, and 6.2.
TotalSize Array of String Total capacity in GB
ShardSize Array of String Shard size in GB
ReplicaNum Array of String Quantity of replicas
ShardNum Array of String Quantity of shards
PayMode String Supported billing modes
- 1: Monthly subscription.
- 0: Pay-as-you-go.
EnableReplicaReadOnly Boolean Whether read-only replica is supported.
- true: read-only replica supported.
- false: not supported.

ProxyNodes

Proxy node information

Used by actions: DescribeInstanceNodeInfo.

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

RedisBackupSet

Array of instance backups

Used by actions: DescribeInstanceBackups.

Name Type Description
StartTime String

Backup start time.
BackupId String

Backup task ID.
BackupType String

Backup type.

  • 1: Automatic backup initiated by the system in the wee hours.
  • 0: Manual backup initiated by the user.
Status Integer

Backup status.

  • 1: Backup is locked by other processes.
  • 2: Backup is normal, not locked by any processes.
  • -1: Backup has expired.
  • 3: Backup is being exported.
  • 4: Backup export successful.
Remark String

Backup remarks.
Locked Integer

Backup lock status.

  • 0: Unlocked.
  • 1: Has been locked.
BackupSize Integer

Internal field, which can be ignored.
FullBackup Integer

Internal field, which can be ignored.
InstanceType Integer

Internal field, which can be ignored.
InstanceId String

Instance ID.
InstanceName String

Instance name.
Region String

Local backup region.
EndTime String

Backup end time.
FileType String

Backup file type.
ExpireTime String

Backup file expiration time.
Encrypted Boolean

Whether the backup file is encrypted

RedisCommonInstanceList

Instance information

Used by actions: DescribeCommonDBInstances.

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

RedisInstanceEvent

Instance event information.

Used by actions: DescribeInstanceEvents.

Name Type Description
ID Integer Event ID.
InstanceId String Instance ID.
InstanceName String Instance name.
Type String Event type. Currently, the type can only be related to instance migration, resource movement, and IDC deletion. This parameter can be set only to InstanceMigration.
Grade String Event level. The levels are divided into critical, important, medium, and general based on severity and urgency.
- Critical: critical.
- High: important.
- Middle: medium.
- Low.
ExecutionDate String Scheduled event execution date.
StartTime String Start date of scheduled event execution.
EndTime String End date of scheduled event execution.
LatestExecutionDate String Latest execution date of the Ops event. The event should be completed before this date. Otherwise, the business may be affected.
Status String Current event status.
- Waiting: event not reached the execution date or not within the maintenance window.
- Running: event within the maintenance window and under maintenance execution.
- Finished: event with maintenance completed.
- Canceled: Execution of the event is canceled.
TaskEndTime String Completion time of the event execution task.
EffectInfo String Event impact information.
InitialExecutionDate String Initial scheduled event execution date.

RedisNode

Running information of Redis nodes

Used by actions: DescribeInstanceZoneInfo.

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

RedisNodeInfo

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

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

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

RedisNodes

Redis node information

Used by actions: DescribeInstanceNodeInfo.

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

RegionConf

Region information

Used by actions: DescribeProductInfo.

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

ReplicaGroup

Information of the instance node group

Used by actions: DescribeInstanceZoneInfo.

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

ResourceBundle

Dedicated Redis cluster resource package.

Used by actions: DescribeRedisClusters.

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

ResourceTag

Tag bound to the instance purchased via API

Used by actions: CloneInstances, CreateInstances.

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

SecondLevelBackupMissingTimestamps

Timestamp range within which second-level backup is missing

Used by actions: DescribeSecondLevelBackupInfo.

Name Type Description
StartTimeStamp Integer Start timestamp.
EndTimeStamp Integer End timestamp.

SecurityGroup

Security group rules

Used by actions: DescribeDBSecurityGroups, DescribeProjectSecurityGroups.

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

SecurityGroupDetail

Security group details

Used by actions: DescribeInstanceSecurityGroup, DescribeProjectSecurityGroup.

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

SecurityGroupsInboundAndOutbound

Security group inbound/outbound rules

Used by actions: DescribeInstanceSecurityGroup, DescribeProjectSecurityGroup.

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

SourceCommand

Access command

Used by actions: DescribeInstanceMonitorTopNCmd.

Name Type Description
Cmd String Command name.
Count Integer Number of executions.

SourceInfo

Access source information

Used by actions: DescribeInstanceMonitorSIP.

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

TaskInfoDetail

Task details

Used by actions: DescribeTaskList.

Name Type Description
TaskId Integer Task ID.
StartTime String Task start time.
TaskType String Task type.

- FLOW_CREATE: "001", indicating instance creation.
- FLOW_RESIZE: "002", indicating configuration modification.
- FLOW_CLOSE: "003", indicating instance disabling.
- FLOW_CLEAN: "004", indicating instance cleanup.
- FLOW_STARTUP: "005", indicating instance enabling.
- FLOW_DELETE: "006", indicating instance deletion.
- FLOW_SETPWD: "007", indicating password reset.
- FLOW_EXPORTBACKUP: "009", indicating backup file export.
- FLOW_RESTOREBACKUP: "010", indicating backup restoration.
- FLOW_BACKUPINSTANCE: "012", indicating instance backup.
- FLOW_MIGRATEINSTANCE: "013", indicating instance migration.
- FLOW_DELBACKUP: "014", indicating backup deletion.
- FLOW_EXCHANGEINSTANCE: "016", indicating instance switch.
- FLOW_AUTOBACKUP: "017", indicating automatic instance backup.
- FLOW_MIGRATECHECK: "022", indicating migration parameter verification.
- FLOW_MIGRATETASK: "023", indicating that data migration is in progress.
- FLOW_CLEANDB: "025", indicating database cleanup.
- FLOW_CLONEBACKUP: "026": indicating backup cloning.
- FLOW_CHANGEVIP: "027", indicating VIP address modification.
- FLOW_EXPORSHR: "028", indicating scaling.
- FLOW_ADDNODES: "029", indicating node addition (removal).
- FLOW_CHANGENET: "031", indicating network type modification.
- FLOW_MODIFYINSTACEREADONLY: "033": indicating read-only policy modification.
- FLOW_MODIFYINSTANCEPARAMS: "034", indicating instance parameter modification.
- FLOW_MODIFYINSTANCEPASSWORDFREE: "035", indicating password-free access settings.
- FLOW_SWITCHINSTANCEVIP: "036", indicating instance VIP address switch.
- FLOW_MODIFYINSTANCEACCOUNT: "037", indicating instance account modification.
- FLOW_MODIFYINSTANCEBANDWIDTH: "038", indicating instance bandwidth modification.
- FLOW_ENABLEINSTANCE_REPLICATE: "039", indicating enabling of read-only replica.
- FLOW_DISABLEINSTANCE_REPLICATE: "040", indicating disabling of read-only replica.
- FLOW_UpgradeArch: "041", indicating instance architecture upgrade from the standard architecture to the cluster architecture.
- FLOW_DowngradeArch: "042", indicating instance architecture downgrade from the cluster architecture to the standard architecture.
- FLOW_UpgradeVersion: "043", indicating version upgrade.
- FLOW_MODIFYCONNECTIONCONFIG: "044", indicating adjustment of the bandwidth and the number of connections.
- FLOW_CLEARNETWORK: "045", indicating network change.
- FLOW_REMOVE_BACKUP_FILE: "046", indicating backup deletion.
- FLOW_UPGRADE_SUPPORT_MULTI_AZ: "047", indicating instance upgrade to multi-AZ deployment.
- FLOW_SHUTDOWN_MASTER: "048", indicating fault simulation.
- FLOW_CHANGE_REPLICA_TO_MASTER: "049", indicating manual promotion to the primary node.
- FLOW_CODE_ADD_REPLICATION_INSTANCE: "050", indicating replication group addition.
- FLOW_OPEN_WAN: "052", indicating enabling of public network access.
- FLOW_CLOSE_WAN: "053", indicating disabling of public network access.
- FLOW_CODE_DELETE_REPLICATION_INSTANCE: "055", indicating replication group unbinding.
- FLOW_CODE_CHANGE_MASTER_INSTANCE: "056", indicating switching a replication group instance to the primary instance.
- FLOW_CODE_CHANGE_INSTANCE_ROLE: "057", indicating modification of the replication group instance role.
- FLOW_MIGRATE_NODE: "058", indicating node migration.
- FLOW_SWITCH_NODE: "059", indicating node switch.
- FLOW_UPGRADE_SMALL_VERSION: "060", indicating Redis version upgrade.
- FLOW_UPGRADE_PROXY_VERSION: "061", indicating proxy version upgrade.
- FLOW_MODIFY_INSTANCE_NETWORK: "062", indicating instance network modification.
- FLOW_MIGRATE_PROXY_NODE: "063", indicating proxy node migration.
- FLOW_MIGRATION_INSTANCE_ZONE: "066", indicating that instance migration to another AZ is in progress.
- FLOW_UPGRADE_INSTANCE_CACHE_AND_PROXY: "067", indicating that instance version upgrade is in progress.
- FLOW_MODIFY_PROXY_NUM: "069", indicating proxy node addition (removal).
- FLOW_MODIFYBACKUPMOD: "070", indicating instance backup mode modification.
InstanceName String Instance name.
InstanceId String Instance ID.
ProjectId Integer Project ID.
Progress Float Task progress.
EndTime String Task execution end time.
Result Integer Task execution status.



0: initializing the task.
1: executing.
2. completed.
4: failed.

TendisNodes

Tendis node information

Used by actions: DescribeInstanceNodeInfo.

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

TendisSlowLogDetail

Tendis slow query details

Used by actions: DescribeTendisSlowLog.

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

TradeDealDetail

Order transaction information

Used by actions: DescribeInstanceDealDetail.

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

ZoneCapacityConf

Product information in the availability zone

Used by actions: DescribeProductInfo.

Name Type Description
ZoneId String AZ ID, such as ap-guangzhou-3
ZoneName String Availability zone name.
IsSaleout Boolean Whether the AZ is sold out.
IsDefault Boolean Whether the default AZ is used.
NetWorkType Array of String Network type.

- basenet: basic network.
- vpcnet: VPC.
ProductSet Array of ProductConf Information of an AZ, such as product specifications in it
OldZoneId Integer AZ ID, such as 100003
前の記事へ: CloseLog次の記事へ: Error Codes

ヘルプとサポート

この記事はお役に立ちましたか？

フィードバック