tencentcloud-sdk-nodejs-redis 4.1.108 → 4.1.115
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json
CHANGED
|
@@ -65,7 +65,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
65
65
|
*/
|
|
66
66
|
ModifyBackupDownloadRestriction(req: ModifyBackupDownloadRestrictionRequest, cb?: (error: string, rep: ModifyBackupDownloadRestrictionResponse) => void): Promise<ModifyBackupDownloadRestrictionResponse>;
|
|
67
67
|
/**
|
|
68
|
-
* 本接口(ModifyInstanceAccount
|
|
68
|
+
* 本接口(ModifyInstanceAccount)用于修改实例账号。
|
|
69
69
|
*/
|
|
70
70
|
ModifyInstanceAccount(req: ModifyInstanceAccountRequest, cb?: (error: string, rep: ModifyInstanceAccountResponse) => void): Promise<ModifyInstanceAccountResponse>;
|
|
71
71
|
/**
|
|
@@ -115,7 +115,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
115
115
|
return this.request("ModifyBackupDownloadRestriction", req, cb);
|
|
116
116
|
}
|
|
117
117
|
/**
|
|
118
|
-
* 本接口(ModifyInstanceAccount
|
|
118
|
+
* 本接口(ModifyInstanceAccount)用于修改实例账号。
|
|
119
119
|
*/
|
|
120
120
|
async ModifyInstanceAccount(req, cb) {
|
|
121
121
|
return this.request("ModifyInstanceAccount", req, cb);
|
|
@@ -236,11 +236,11 @@ export interface ModifyAutoBackupConfigResponse {
|
|
|
236
236
|
*/
|
|
237
237
|
export interface RestoreInstanceRequest {
|
|
238
238
|
/**
|
|
239
|
-
* 待操作的实例ID,可通过 DescribeInstances 接口返回值中的 InstanceId 获取。
|
|
239
|
+
* 待操作的实例ID,可通过 [DescribeInstances](https://cloud.tencent.com/document/product/239/20018) 接口返回值中的 InstanceId 获取。
|
|
240
240
|
*/
|
|
241
241
|
InstanceId: string;
|
|
242
242
|
/**
|
|
243
|
-
* 备份ID,可通过
|
|
243
|
+
* 备份ID,可通过 [DescribeInstanceBackups](https://cloud.tencent.com/document/product/239/20011) 接口返回的参数 RedisBackupSet 获取。
|
|
244
244
|
*/
|
|
245
245
|
BackupId: string;
|
|
246
246
|
/**
|
|
@@ -435,6 +435,10 @@ export interface CreateInstancesRequest {
|
|
|
435
435
|
- 若不配置该参数,则绑定默认告警策略。默认告警策略具体信息,请登录[腾讯云可观测平台-告警管理-策略管理](https://console.cloud.tencent.com/monitor/alarm/policy)查看。
|
|
436
436
|
*/
|
|
437
437
|
AlarmPolicyList?: Array<string>;
|
|
438
|
+
/**
|
|
439
|
+
* 是否加密密码
|
|
440
|
+
*/
|
|
441
|
+
EncryptPassword?: boolean;
|
|
438
442
|
}
|
|
439
443
|
/**
|
|
440
444
|
* CreateReplicationGroup请求参数结构体
|
|
@@ -1103,6 +1107,10 @@ export interface ClearInstanceRequest {
|
|
|
1103
1107
|
- 密码认证:必须配置。字符个数为[8,64],至少包含小写字母、大写字母、数字和字符 ()`~!@#$%^&*-+=_|{}[]:;<>,.?/ 中的2种,不能以"/"开头。
|
|
1104
1108
|
*/
|
|
1105
1109
|
Password?: string;
|
|
1110
|
+
/**
|
|
1111
|
+
* 是否加密密码
|
|
1112
|
+
*/
|
|
1113
|
+
EncryptPassword?: boolean;
|
|
1106
1114
|
}
|
|
1107
1115
|
/**
|
|
1108
1116
|
* UpgradeInstanceVersion请求参数结构体
|
|
@@ -2063,7 +2071,7 @@ export interface DescribeInstanceDTSInfoRequest {
|
|
|
2063
2071
|
*/
|
|
2064
2072
|
export interface CreateParamTemplateRequest {
|
|
2065
2073
|
/**
|
|
2066
|
-
*
|
|
2074
|
+
* 参数模板名称。字符长度要求为[2,64]。
|
|
2067
2075
|
*/
|
|
2068
2076
|
Name: string;
|
|
2069
2077
|
/**
|
|
@@ -2072,7 +2080,6 @@ export interface CreateParamTemplateRequest {
|
|
|
2072
2080
|
Description?: string;
|
|
2073
2081
|
/**
|
|
2074
2082
|
* 产品类型。
|
|
2075
|
-
- 2:Redis 2.8 内存版(标准架构)。
|
|
2076
2083
|
- 6:Redis 4.0 内存版(标准架构)。
|
|
2077
2084
|
- 7:Redis 4.0 内存版(集群架构)。
|
|
2078
2085
|
- 8:Redis 5.0 内存版(标准架构)。
|
|
@@ -2131,36 +2138,42 @@ export interface ModifyInstanceAccountRequest {
|
|
|
2131
2138
|
*/
|
|
2132
2139
|
InstanceId: string;
|
|
2133
2140
|
/**
|
|
2134
|
-
*
|
|
2141
|
+
* 指定需修改的账号。
|
|
2142
|
+
- root:指在创建 Redis 数据库实例时自动生成的账号。用户无法修改其读写权限,仅可修改其请求路由策略。
|
|
2143
|
+
- 自定义的账号:用户在实例创建成功后手动创建的账号。用户可以随时修改其读写权限与请求路由策略。
|
|
2135
2144
|
*/
|
|
2136
2145
|
AccountName: string;
|
|
2137
2146
|
/**
|
|
2138
|
-
*
|
|
2147
|
+
* 指定所修改账号访问的密码。
|
|
2139
2148
|
*/
|
|
2140
2149
|
AccountPassword?: string;
|
|
2141
2150
|
/**
|
|
2142
|
-
*
|
|
2151
|
+
* 账号描述信息
|
|
2143
2152
|
*/
|
|
2144
2153
|
Remark?: string;
|
|
2145
2154
|
/**
|
|
2146
|
-
*
|
|
2147
|
-
- master
|
|
2148
|
-
- replication
|
|
2155
|
+
* 指定所修改账号读写请求路由的策略。
|
|
2156
|
+
- master:表示读写请求路由至主节点。
|
|
2157
|
+
- replication:表示读写请求路由至从节点。
|
|
2149
2158
|
*/
|
|
2150
2159
|
ReadonlyPolicy?: Array<string>;
|
|
2151
2160
|
/**
|
|
2152
|
-
*
|
|
2161
|
+
* 指定所修改账号的读写权限。
|
|
2153
2162
|
- r:只读。
|
|
2154
2163
|
- w:只写。
|
|
2155
2164
|
- rw:读写。
|
|
2156
2165
|
*/
|
|
2157
2166
|
Privilege?: string;
|
|
2158
2167
|
/**
|
|
2159
|
-
*
|
|
2160
|
-
- true
|
|
2161
|
-
- false
|
|
2168
|
+
* 指定是否将默认账号(root)设置为免密账号。自定义账号不支持免密访问。
|
|
2169
|
+
- true:默认账号(root)设置为免密账号。
|
|
2170
|
+
- false:默认账号(root)不设置为免密账号。
|
|
2162
2171
|
*/
|
|
2163
2172
|
NoAuth?: boolean;
|
|
2173
|
+
/**
|
|
2174
|
+
* 指定所修改的账号是否加密密码
|
|
2175
|
+
*/
|
|
2176
|
+
EncryptPassword?: boolean;
|
|
2164
2177
|
}
|
|
2165
2178
|
/**
|
|
2166
2179
|
* ModifyMaintenanceWindow请求参数结构体
|
|
@@ -2442,13 +2455,17 @@ export interface ResetPasswordRequest {
|
|
|
2442
2455
|
- true:切换为免密码实例。默认 false。
|
|
2443
2456
|
*/
|
|
2444
2457
|
NoAuth?: boolean;
|
|
2458
|
+
/**
|
|
2459
|
+
* 是否加密密码
|
|
2460
|
+
*/
|
|
2461
|
+
EncryptPassword?: boolean;
|
|
2445
2462
|
}
|
|
2446
2463
|
/**
|
|
2447
2464
|
* ModifyInstanceAccount返回参数结构体
|
|
2448
2465
|
*/
|
|
2449
2466
|
export interface ModifyInstanceAccountResponse {
|
|
2450
2467
|
/**
|
|
2451
|
-
* 任务ID
|
|
2468
|
+
* 任务ID。
|
|
2452
2469
|
*/
|
|
2453
2470
|
TaskId?: number;
|
|
2454
2471
|
/**
|
|
@@ -2888,15 +2905,15 @@ export interface DescribeInstanceLogDeliveryResponse {
|
|
|
2888
2905
|
*/
|
|
2889
2906
|
export interface DescribeInstanceParamRecordsRequest {
|
|
2890
2907
|
/**
|
|
2891
|
-
* 实例
|
|
2908
|
+
* 实例 ID 。请登录 [Redis 控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
|
|
2892
2909
|
*/
|
|
2893
2910
|
InstanceId: string;
|
|
2894
2911
|
/**
|
|
2895
|
-
*
|
|
2912
|
+
* 分页大小。默认为100,最大值为 200。
|
|
2896
2913
|
*/
|
|
2897
2914
|
Limit?: number;
|
|
2898
2915
|
/**
|
|
2899
|
-
* 偏移量,取Limit
|
|
2916
|
+
* 偏移量,取Limit整数倍,默认值为0。计算公式:offset=limit*(页码-1)。
|
|
2900
2917
|
*/
|
|
2901
2918
|
Offset?: number;
|
|
2902
2919
|
}
|
|
@@ -3270,6 +3287,10 @@ export interface CloneInstancesRequest {
|
|
|
3270
3287
|
|
|
3271
3288
|
*/
|
|
3272
3289
|
CloneTime?: string;
|
|
3290
|
+
/**
|
|
3291
|
+
* 是否加密密码
|
|
3292
|
+
*/
|
|
3293
|
+
EncryptPassword?: boolean;
|
|
3273
3294
|
}
|
|
3274
3295
|
/**
|
|
3275
3296
|
* ApplyParamsTemplate返回参数结构体
|
|
@@ -3393,7 +3414,7 @@ export interface ModifyNetworkConfigRequest {
|
|
|
3393
3414
|
*/
|
|
3394
3415
|
export interface DescribeInstanceSecurityGroupRequest {
|
|
3395
3416
|
/**
|
|
3396
|
-
* 实例 ID 列表,数组长度限制[0,100]
|
|
3417
|
+
* 实例 ID 列表,数组长度限制[0,100]。请登录 [Redis 控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。
|
|
3397
3418
|
*/
|
|
3398
3419
|
InstanceIds: Array<string>;
|
|
3399
3420
|
}
|
|
@@ -3680,14 +3701,18 @@ export interface CreateInstanceAccountRequest {
|
|
|
3680
3701
|
ReadonlyPolicy: Array<string>;
|
|
3681
3702
|
/**
|
|
3682
3703
|
* 账户读写权限,支持选择只读与读写权限。
|
|
3683
|
-
- r
|
|
3684
|
-
- rw:
|
|
3704
|
+
- r:只读。
|
|
3705
|
+
- rw: 读写。
|
|
3685
3706
|
*/
|
|
3686
3707
|
Privilege: string;
|
|
3687
3708
|
/**
|
|
3688
|
-
*
|
|
3709
|
+
* 账号备注描述信息,长度为[0,64] 字节,支持中文。
|
|
3689
3710
|
*/
|
|
3690
3711
|
Remark?: string;
|
|
3712
|
+
/**
|
|
3713
|
+
* 是否加密密码
|
|
3714
|
+
*/
|
|
3715
|
+
EncryptPassword?: boolean;
|
|
3691
3716
|
}
|
|
3692
3717
|
/**
|
|
3693
3718
|
* RemoveReplicationInstance请求参数结构体
|
|
@@ -3736,6 +3761,7 @@ export interface ModifyInstanceRequest {
|
|
|
3736
3761
|
- rename:表示实例重命名。
|
|
3737
3762
|
- modifyProject:修改实例所属项目。
|
|
3738
3763
|
- modifyAutoRenew:修改实例续费标记。
|
|
3764
|
+
- modifyDeleteProtectionSwitch:修改实例删除保护。
|
|
3739
3765
|
*/
|
|
3740
3766
|
Operation: string;
|
|
3741
3767
|
/**
|
|
@@ -3757,6 +3783,10 @@ export interface ModifyInstanceRequest {
|
|
|
3757
3783
|
- 2:明确不自动续费。
|
|
3758
3784
|
*/
|
|
3759
3785
|
AutoRenews?: Array<number | bigint>;
|
|
3786
|
+
/**
|
|
3787
|
+
* 删除保护开关。- 0:默认状态,指关闭。- 1:开关打开。
|
|
3788
|
+
*/
|
|
3789
|
+
DeleteProtectionSwitches?: Array<number | bigint>;
|
|
3760
3790
|
/**
|
|
3761
3791
|
* 目前在废弃中,存量用户还可以使用,建议新用户使用 InstanceIds。
|
|
3762
3792
|
* @deprecated
|
|
@@ -3913,12 +3943,14 @@ export interface ModifyConnectionConfigRequest {
|
|
|
3913
3943
|
InstanceId: string;
|
|
3914
3944
|
/**
|
|
3915
3945
|
* 附加带宽,大于0,单位MB。
|
|
3946
|
+
**说明**:Bandwidth 和 ClientLimit 参数不能同时为空,您必须至少选择其中一个进行配置。
|
|
3916
3947
|
*/
|
|
3917
3948
|
Bandwidth?: number;
|
|
3918
3949
|
/**
|
|
3919
3950
|
* 单分片的总连接数。
|
|
3920
3951
|
- 未开启副本只读时,下限为10000,上限为40000。
|
|
3921
3952
|
- 开启副本只读时,下限为10000,上限为10000×(只读副本数+3)。
|
|
3953
|
+
**说明**:Bandwidth 和 ClientLimit 参数不能同时为空,您必须至少选择其中一个进行配置。
|
|
3922
3954
|
*/
|
|
3923
3955
|
ClientLimit?: number;
|
|
3924
3956
|
}
|
|
@@ -4464,6 +4496,10 @@ export interface ModfiyInstancePasswordRequest {
|
|
|
4464
4496
|
- 至少包含小写字母a - z、大写字母A - Z、数字0 - 9、特殊字符 ()~!@#$%^&*-+=_|{}[]:;<>,.?/中的两项。
|
|
4465
4497
|
*/
|
|
4466
4498
|
Password: string;
|
|
4499
|
+
/**
|
|
4500
|
+
* 是否加密密码
|
|
4501
|
+
*/
|
|
4502
|
+
EncryptPassword?: boolean;
|
|
4467
4503
|
}
|
|
4468
4504
|
/**
|
|
4469
4505
|
* DescribeSlowLog请求参数结构体
|
|
@@ -4785,7 +4821,7 @@ export interface InstanceSet {
|
|
|
4785
4821
|
*/
|
|
4786
4822
|
InstanceId?: string;
|
|
4787
4823
|
/**
|
|
4788
|
-
* 用户
|
|
4824
|
+
* 用户AppId。AppId是与账号ID有唯一对应关系的应用 ID,部分腾讯云产品会使用此 AppId。
|
|
4789
4825
|
|
|
4790
4826
|
*/
|
|
4791
4827
|
Appid?: number;
|
|
@@ -5034,6 +5070,10 @@ export interface InstanceSet {
|
|
|
5034
5070
|
* 备份模式:- SecondLevelBackup 秒级备份- NormalLevelBackup 普通备份
|
|
5035
5071
|
*/
|
|
5036
5072
|
BackupMode?: string;
|
|
5073
|
+
/**
|
|
5074
|
+
* 删除保护开关,0关闭,1开启
|
|
5075
|
+
*/
|
|
5076
|
+
DeleteProtectionSwitch?: number;
|
|
5037
5077
|
}
|
|
5038
5078
|
/**
|
|
5039
5079
|
* ReleaseWanAddress请求参数结构体
|
|
@@ -5437,7 +5477,7 @@ export interface DescribeInstanceSupportFeatureResponse {
|
|
|
5437
5477
|
*/
|
|
5438
5478
|
export interface DescribeInstanceLogDeliveryRequest {
|
|
5439
5479
|
/**
|
|
5440
|
-
* 实例ID。
|
|
5480
|
+
* 实例ID。请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance)在实例列表复制实例 ID。
|
|
5441
5481
|
*/
|
|
5442
5482
|
InstanceId: string;
|
|
5443
5483
|
}
|
|
@@ -5916,7 +5956,7 @@ export interface InstanceEnumParam {
|
|
|
5916
5956
|
*/
|
|
5917
5957
|
export interface CreateInstanceAccountResponse {
|
|
5918
5958
|
/**
|
|
5919
|
-
* 任务ID
|
|
5959
|
+
* 任务ID。
|
|
5920
5960
|
*/
|
|
5921
5961
|
TaskId?: number;
|
|
5922
5962
|
/**
|