tencentcloud-sdk-nodejs-mongodb 4.1.122 → 4.1.125
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/README.md
CHANGED
|
@@ -62,6 +62,8 @@ npm install tencentcloud-sdk-slim-nodejs --save
|
|
|
62
62
|
|
|
63
63
|
1. clone 代码到本地:
|
|
64
64
|
```
|
|
65
|
+
git clone https://cnb.cool/tencent/cloud/api/sdk/tencentcloud-sdk-nodejs
|
|
66
|
+
# 或者
|
|
65
67
|
git clone https://github.com/tencentcloud/tencentcloud-sdk-nodejs
|
|
66
68
|
# 或者
|
|
67
69
|
git clone https://gitee.com/tencentcloud/tencentcloud-sdk-nodejs
|
|
@@ -135,7 +137,7 @@ const CvmClient = tencentcloud.cvm.v20170312.Client
|
|
|
135
137
|
// ...
|
|
136
138
|
```
|
|
137
139
|
|
|
138
|
-
实例化 `Client` 的入参支持 `clientConfig`,数据结构和说明详见 [ClientConfig](
|
|
140
|
+
实例化 `Client` 的入参支持 `clientConfig`,数据结构和说明详见 [ClientConfig](src/common/interface.ts)。
|
|
139
141
|
|
|
140
142
|
## Common Client
|
|
141
143
|
|
|
@@ -143,17 +145,17 @@ const CvmClient = tencentcloud.cvm.v20170312.Client
|
|
|
143
145
|
|
|
144
146
|
**注意,您必须明确知道您调用的接口所需参数,否则可能会调用失败。**
|
|
145
147
|
|
|
146
|
-
详细使用请参阅示例:[使用 Common Client 进行调用](
|
|
148
|
+
详细使用请参阅示例:[使用 Common Client 进行调用](examples/common)
|
|
147
149
|
|
|
148
150
|
## 更多示例
|
|
149
151
|
|
|
150
|
-
请参考 [examples](
|
|
152
|
+
请参考 [examples](examples) 目录。
|
|
151
153
|
|
|
152
154
|
# 相关配置
|
|
153
155
|
|
|
154
156
|
## 代理
|
|
155
157
|
|
|
156
|
-
如果是有代理的环境下,需要配置代理,请在创建 Client 时传入 [profile.httpProfile.proxy](
|
|
158
|
+
如果是有代理的环境下,需要配置代理,请在创建 Client 时传入 [profile.httpProfile.proxy](src/common/interface.ts#L78) 参数,或设置系统环境变量 `http_proxy` ,否则可能无法正常调用,抛出连接超时的异常。
|
|
157
159
|
|
|
158
160
|
# 凭证管理
|
|
159
161
|
|
package/package.json
CHANGED
|
@@ -56,7 +56,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
56
56
|
*/
|
|
57
57
|
DescribeDBBackups(req: DescribeDBBackupsRequest, cb?: (error: string, rep: DescribeDBBackupsResponse) => void): Promise<DescribeDBBackupsResponse>;
|
|
58
58
|
/**
|
|
59
|
-
*
|
|
59
|
+
* 本接口(DescribeDetailedSlowLogs)用于查询实例慢日志详情。
|
|
60
60
|
*/
|
|
61
61
|
DescribeDetailedSlowLogs(req: DescribeDetailedSlowLogsRequest, cb?: (error: string, rep: DescribeDetailedSlowLogsResponse) => void): Promise<DescribeDetailedSlowLogsResponse>;
|
|
62
62
|
/**
|
|
@@ -68,7 +68,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
68
68
|
*/
|
|
69
69
|
InquirePriceModifyDBInstanceSpec(req: InquirePriceModifyDBInstanceSpecRequest, cb?: (error: string, rep: InquirePriceModifyDBInstanceSpecResponse) => void): Promise<InquirePriceModifyDBInstanceSpecResponse>;
|
|
70
70
|
/**
|
|
71
|
-
*
|
|
71
|
+
* 本接口(RestartNodes)用于批量重启数据库节点。
|
|
72
72
|
*/
|
|
73
73
|
RestartNodes(req: RestartNodesRequest, cb?: (error: string, rep: RestartNodesResponse) => void): Promise<RestartNodesResponse>;
|
|
74
74
|
/**
|
|
@@ -111,7 +111,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
111
111
|
*/
|
|
112
112
|
DropDBInstanceParamTpl(req: DropDBInstanceParamTplRequest, cb?: (error: string, rep: DropDBInstanceParamTplResponse) => void): Promise<DropDBInstanceParamTplResponse>;
|
|
113
113
|
/**
|
|
114
|
-
* 本接口(ModifyDBInstanceSpec)用于调整MongoDB云数据库实例配置。接口支持的售卖规格,可从查询云数据库的售卖规格(DescribeSpecInfo)获取。
|
|
114
|
+
* 本接口(ModifyDBInstanceSpec)用于调整MongoDB云数据库实例配置。接口支持的售卖规格,可从查询云数据库的售卖规格([DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567))获取。
|
|
115
115
|
*/
|
|
116
116
|
ModifyDBInstanceSpec(req: ModifyDBInstanceSpecRequest, cb?: (error: string, rep: ModifyDBInstanceSpecResponse) => void): Promise<ModifyDBInstanceSpecResponse>;
|
|
117
117
|
/**
|
|
@@ -148,11 +148,11 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
148
148
|
*/
|
|
149
149
|
ModifyDBInstanceNetworkAddress(req: ModifyDBInstanceNetworkAddressRequest, cb?: (error: string, rep: ModifyDBInstanceNetworkAddressResponse) => void): Promise<ModifyDBInstanceNetworkAddressResponse>;
|
|
150
150
|
/**
|
|
151
|
-
* 本接口(CreateDBInstance)用于创建包年包月的MongoDB
|
|
151
|
+
* 本接口(CreateDBInstance)用于创建包年包月的MongoDB云数据库实例。接口支持的售卖规格,可通过接口查询 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/35767) 获取。
|
|
152
152
|
*/
|
|
153
153
|
CreateDBInstance(req: CreateDBInstanceRequest, cb?: (error: string, rep: CreateDBInstanceResponse) => void): Promise<CreateDBInstanceResponse>;
|
|
154
154
|
/**
|
|
155
|
-
*
|
|
155
|
+
* 本接口(IsolateDBInstance)用于隔离 MongoDB 云数据库按量计费实例。隔离后实例保留在回收站中,不能再写入数据。隔离一定时间后,实例会彻底删除,回收站保存时间请参考按量计费的服务条款。已删除的按量计费实例无法恢复,请谨慎操作。
|
|
156
156
|
*/
|
|
157
157
|
IsolateDBInstance(req: IsolateDBInstanceRequest, cb?: (error: string, rep: IsolateDBInstanceResponse) => void): Promise<IsolateDBInstanceResponse>;
|
|
158
158
|
/**
|
|
@@ -160,11 +160,11 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
160
160
|
*/
|
|
161
161
|
DescribeInstanceParams(req: DescribeInstanceParamsRequest, cb?: (error: string, rep: DescribeInstanceParamsResponse) => void): Promise<DescribeInstanceParamsResponse>;
|
|
162
162
|
/**
|
|
163
|
-
*
|
|
163
|
+
* 本接口(DescribeSpecInfo)用于查询实例的售卖规格。
|
|
164
164
|
*/
|
|
165
165
|
DescribeSpecInfo(req: DescribeSpecInfoRequest, cb?: (error: string, rep: DescribeSpecInfoResponse) => void): Promise<DescribeSpecInfoResponse>;
|
|
166
166
|
/**
|
|
167
|
-
*
|
|
167
|
+
* 本接口(DescribeBackupDownloadTask)用于查询备份下载任务信息。
|
|
168
168
|
*/
|
|
169
169
|
DescribeBackupDownloadTask(req: DescribeBackupDownloadTaskRequest, cb?: (error: string, rep: DescribeBackupDownloadTaskResponse) => void): Promise<DescribeBackupDownloadTaskResponse>;
|
|
170
170
|
/**
|
|
@@ -201,7 +201,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
201
201
|
*/
|
|
202
202
|
DescribeDBInstanceParamTplDetail(req: DescribeDBInstanceParamTplDetailRequest, cb?: (error: string, rep: DescribeDBInstanceParamTplDetailResponse) => void): Promise<DescribeDBInstanceParamTplDetailResponse>;
|
|
203
203
|
/**
|
|
204
|
-
*
|
|
204
|
+
* 本接口(KillOps)用于终止 MongoDB 云数据库实例上执行的特定操作。
|
|
205
205
|
*/
|
|
206
206
|
KillOps(req: KillOpsRequest, cb?: (error: string, rep: KillOpsResponse) => void): Promise<KillOpsResponse>;
|
|
207
207
|
/**
|
|
@@ -102,7 +102,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
102
102
|
return this.request("DescribeDBBackups", req, cb);
|
|
103
103
|
}
|
|
104
104
|
/**
|
|
105
|
-
*
|
|
105
|
+
* 本接口(DescribeDetailedSlowLogs)用于查询实例慢日志详情。
|
|
106
106
|
*/
|
|
107
107
|
async DescribeDetailedSlowLogs(req, cb) {
|
|
108
108
|
return this.request("DescribeDetailedSlowLogs", req, cb);
|
|
@@ -120,7 +120,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
120
120
|
return this.request("InquirePriceModifyDBInstanceSpec", req, cb);
|
|
121
121
|
}
|
|
122
122
|
/**
|
|
123
|
-
*
|
|
123
|
+
* 本接口(RestartNodes)用于批量重启数据库节点。
|
|
124
124
|
*/
|
|
125
125
|
async RestartNodes(req, cb) {
|
|
126
126
|
return this.request("RestartNodes", req, cb);
|
|
@@ -183,7 +183,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
183
183
|
return this.request("DropDBInstanceParamTpl", req, cb);
|
|
184
184
|
}
|
|
185
185
|
/**
|
|
186
|
-
* 本接口(ModifyDBInstanceSpec)用于调整MongoDB云数据库实例配置。接口支持的售卖规格,可从查询云数据库的售卖规格(DescribeSpecInfo)获取。
|
|
186
|
+
* 本接口(ModifyDBInstanceSpec)用于调整MongoDB云数据库实例配置。接口支持的售卖规格,可从查询云数据库的售卖规格([DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567))获取。
|
|
187
187
|
*/
|
|
188
188
|
async ModifyDBInstanceSpec(req, cb) {
|
|
189
189
|
return this.request("ModifyDBInstanceSpec", req, cb);
|
|
@@ -238,13 +238,13 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
238
238
|
return this.request("ModifyDBInstanceNetworkAddress", req, cb);
|
|
239
239
|
}
|
|
240
240
|
/**
|
|
241
|
-
* 本接口(CreateDBInstance)用于创建包年包月的MongoDB
|
|
241
|
+
* 本接口(CreateDBInstance)用于创建包年包月的MongoDB云数据库实例。接口支持的售卖规格,可通过接口查询 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/35767) 获取。
|
|
242
242
|
*/
|
|
243
243
|
async CreateDBInstance(req, cb) {
|
|
244
244
|
return this.request("CreateDBInstance", req, cb);
|
|
245
245
|
}
|
|
246
246
|
/**
|
|
247
|
-
*
|
|
247
|
+
* 本接口(IsolateDBInstance)用于隔离 MongoDB 云数据库按量计费实例。隔离后实例保留在回收站中,不能再写入数据。隔离一定时间后,实例会彻底删除,回收站保存时间请参考按量计费的服务条款。已删除的按量计费实例无法恢复,请谨慎操作。
|
|
248
248
|
*/
|
|
249
249
|
async IsolateDBInstance(req, cb) {
|
|
250
250
|
return this.request("IsolateDBInstance", req, cb);
|
|
@@ -256,13 +256,13 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
256
256
|
return this.request("DescribeInstanceParams", req, cb);
|
|
257
257
|
}
|
|
258
258
|
/**
|
|
259
|
-
*
|
|
259
|
+
* 本接口(DescribeSpecInfo)用于查询实例的售卖规格。
|
|
260
260
|
*/
|
|
261
261
|
async DescribeSpecInfo(req, cb) {
|
|
262
262
|
return this.request("DescribeSpecInfo", req, cb);
|
|
263
263
|
}
|
|
264
264
|
/**
|
|
265
|
-
*
|
|
265
|
+
* 本接口(DescribeBackupDownloadTask)用于查询备份下载任务信息。
|
|
266
266
|
*/
|
|
267
267
|
async DescribeBackupDownloadTask(req, cb) {
|
|
268
268
|
return this.request("DescribeBackupDownloadTask", req, cb);
|
|
@@ -317,7 +317,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
317
317
|
return this.request("DescribeDBInstanceParamTplDetail", req, cb);
|
|
318
318
|
}
|
|
319
319
|
/**
|
|
320
|
-
*
|
|
320
|
+
* 本接口(KillOps)用于终止 MongoDB 云数据库实例上执行的特定操作。
|
|
321
321
|
*/
|
|
322
322
|
async KillOps(req, cb) {
|
|
323
323
|
return this.request("KillOps", req, cb);
|