History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
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: primary node. - replication: replica node. |
| Status | Integer | Sub-account status. - 1: account under modification. - 2: valid account. - 4: account deleted. |
| CreateTime | String | Creation time |
Available region information.
Used by actions: DescribeGlobalReplicationArea.
| Name | Type | Description |
|---|---|---|
| Region | String | Region |
| AvailableZones | Array of String | AZ information |
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 |
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 |
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 |
Big key type distribution details
Used by actions: DescribeInstanceMonitorBigKeyTypeDist.
| Name | Type | Description |
|---|---|---|
| Type | String | Type |
| Count | Integer | Count |
| Size | Integer | Size |
| Updatetime | Integer | Timestamp |
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. |
Command duration
Used by actions: DescribeInstanceMonitorTopNCmdTook.
| Name | Type | Description |
|---|---|---|
| Cmd | String | Command name. |
| Took | Integer | Time consumed. Unit: ms. |
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 |
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. |
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. |
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. |
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. |
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 |
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. |
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) |
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. |
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) |
Instance node
Used by actions: DescribeInstances.
| Name | Type | Description |
|---|---|---|
| Id | Integer | Instance ID |
| InstanceClusterNode | Array of InstanceClusterNode | Node details |
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 |
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 |
Proxy slow query details
Used by actions: DescribeProxySlowLog.
| Name | Type | Description |
|---|---|---|
| Duration | Integer | Slow query duration in milliseconds |
| Client | String | Client address |
| Command | String | Slow query command |
| CommandLine | String | Detailed command line information of slow query |
| ExecuteTime | String | Execution time |
| RecvClientEnd | Integer | Duration of receiving client requests (ms). |
| SendClientEnd | Integer | Duration of sending client requests (ms). |
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. |
List of instance details
Used by actions: DescribeInstances.
| Name | Type | Description |
|---|---|---|
| InstanceName | String | Instance name. |
| InstanceId | String | Instance ID. |
| Appid | Integer | App ID of a user, which is an application ID that uniquely corresponds to the account ID. Certain Tencent Cloud products use this app ID. |
| ProjectId | Integer | Project ID. |
| RegionId | Integer | Region ID.
|
| ZoneId | Integer | Zone ID. |
| VpcId | Integer | VPC ID, for example, 75101. |
| SubnetId | Integer | ID of the subnet under VPC, for example, 46315. |
| Status | Integer | Current instance status.
|
| 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. - 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). - 200: Memcached 1.6 memory edition (cluster architecture). |
| AutoRenewFlag | Integer | Whether the automatic renewal flag is set for an instance.
|
| 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.
|
| UniqVpcId | String | VPC ID, for example, vpc-fk33jsf43kgv. |
| UniqSubnetId | String | ID of the subnet under VPC, for example, subnet-fd3j6l35mm0. |
| BillingMode | Integer | Billing mode. Only pay-as-you-go billing is supported. |
| InstanceTitle | String | Description of the instance running status, for example, running. |
| OfflineTime | String | Default termination time of isolated instances, for example, in the format of 2020-02-15 10:20:00. By default, a pay-as-you-go instance will be terminated after 2 hours of isolation, and a monthly subscription instance will be terminated after 7 days. |
| SubStatus | Integer | Sub-status returned for the instance in the process. - 0: disk read-write status. - 1: disk read-only status because the upper limit is exceeded. |
| Tags | Array of String | Anti-affinity tag. |
| InstanceNode | Array of InstanceNode | Instance node information. |
| RedisShardSize | Integer | Shard size. |
| RedisShardNum | Integer | Number of shards. |
| RedisReplicasNum | Integer | Number of replicas. |
| PriceId | Integer | Billing ID. |
| CloseTime | String | Time when an instance starts to be isolated. |
| SlaveReadWeight | Integer | Read weight of a secondary node. - 0: disable read-only replicas. - 100: enable read-only replicas. |
| InstanceTags | Array of InstanceTagInfo | Information on tags associated with the instance. |
| ProjectName | String | Project name |
| NoAuth | Boolean | Whether the instance is password-free.
|
| ClientLimit | Integer | Number of client connections. |
| DtsStatus | Integer | DTS status. (Internal parameter, which can be ignored.) |
| NetLimit | Integer | Shard bandwidth limit. Unit: MB. |
| PasswordFree | Integer | Password-free instance flag. (Internal parameter, which can be ignored.) |
| 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. |
| ReadOnly | Integer | Instance read-only flag. (Internal parameter, which can be ignored.) |
| RemainBandwidthDuration | String | Internal parameter, which can be ignored. |
| DiskSize | Integer | For TencentDB 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 | Node details of the instance. It is returned only for multi-AZ instances. |
| Region | String | Region information on the instance. For example, ap-guangzhou. |
| WanAddress | String | Public network address. |
| PolarisServer | String | Polaris service address for internal use. |
| RedisClusterId | String | CDC cluster ID of TencentDB for Redis®. |
| DedicatedClusterId | String | CDC cluster ID. |
| ProductVersion | String | Product edition.
|
| CurrentProxyVersion | String | Current proxy version of the instance. |
| CurrentRedisVersion | String | Current cache minor version of the instance. If the instance is added to a global replication group, the global replication kernel version is displayed. |
| UpgradeProxyVersion | String | Upgradable proxy version for the instance. |
| UpgradeRedisVersion | String | Upgradable cache minor version for the instance. |
| BackupMode | String | Backup mode. - SecondLevelBackup: second-level backup. - NormalLevelBackup: ordinary backup. |
| DeleteProtectionSwitch | Integer | Deletion protection switch. 0: disabled; 1: enabled. |
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 |
Instance tag information
Used by actions: DescribeInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| TagKey | String | Yes | Tag key |
| TagValue | String | Yes | Tag value |
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 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.
|
| 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.
|
| 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.
|
| 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. |
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 |
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. |
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). |
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. |
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. |
Proxy node information
Used by actions: DescribeInstanceNodeInfo.
| Name | Type | Description |
|---|---|---|
| NodeId | String | Node ID. |
| ZoneId | Integer | AZ ID. |
Array of instance backups
Used by actions: DescribeInstanceBackups.
| Name | Type | Description |
|---|---|---|
| StartTime | String | Backup start time |
| BackupId | String | Backup task ID |
| BackupType | String | Backup type. Valid values: 1 (Automatic backup in the early morning initiated by the system.) 0: Manual backup initiated by the user. |
| Status | Integer | Backup status. Valid values: - 1: The backup is locked by another process. - 2: The backup is normal and not locked by any process. - -1: The backup is expired. - 3: The backup is being exported. - 4: Exported the backup successfully. |
| Remark | String | Backup remarks |
| Locked | Integer | Whether the backup is locked. Valid values: - 0 (no) - 1 (yes) |
| BackupSize | Integer | Internal field, which can be ignored. |
| 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 | The region where the local backup resides. |
| EndTime | String | Backup end time |
| FileType | String | Backup file type |
| ExpireTime | String | Backup file expiration time |
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. |
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. |
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 |
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.
|
| NodeId | Integer | No | ID of the master or replica node
|
| 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 |
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 |
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 |
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 |
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. |
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 |
Timestamp range within which second-level backup is missing
Used by actions: DescribeSecondLevelBackupInfo.
| Name | Type | Description |
|---|---|---|
| StartTimeStamp | Integer | Start timestamp. |
| EndTimeStamp | Integer | End timestamp. |
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. |
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 |
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 |
Access command
Used by actions: DescribeInstanceMonitorTopNCmd.
| Name | Type | Description |
|---|---|---|
| Cmd | String | Command name. |
| Count | Integer | Number of executions. |
Access source information
Used by actions: DescribeInstanceMonitorSIP.
| Name | Type | Description |
|---|---|---|
| Ip | String | Source IP |
| Conn | Integer | Number of connections |
| Cmd | Integer | Command |
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. |
Tendis node information
Used by actions: DescribeInstanceNodeInfo.
| Name | Type | Description |
|---|---|---|
| NodeId | String | Node ID |
| NodeRole | String | Node role |
| ZoneId | Integer | AZ ID. |
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 |
Order transaction information
Used by actions: DescribeInstanceDealDetail.
| Name | Type | Description |
|---|---|---|
| DealId | String | Order ID, which is used when a TencentCloud API is called. |
| DealName | String | Long order ID, which is used when an order issue is submitted for assistance. |
| ZoneId | Integer | AZ ID |
| GoodsNum | Integer | Number of instances associated with the order |
| Creater | String | Creator UIN |
| CreatTime | String | Order creation time |
| OverdueTime | String | Order timeout period |
| EndTime | String | Order completion time |
| Status | Integer | Order status. 1: unpaid; 2: paid but not delivered; 3: In delivery; 4: successfully delivered; 5: delivery failed; 6: refunded; 7: order closed; 8: order expired; 9: order invalidated; 10: product invalidated; 11: requested payment rejected; 12: paying |
| Description | String | Order status description |
| Price | Integer | Order actual total price (in cents) |
| InstanceIds | Array of String | Instance ID |
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 |
피드백