tencentcloud-sdk-nodejs-tcb 4.1.199 → 4.1.202
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.
|
@@ -37,6 +37,13 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
37
37
|
async DescribeCreateMySQLResult(req, cb) {
|
|
38
38
|
return this.request("DescribeCreateMySQLResult", req, cb);
|
|
39
39
|
}
|
|
40
|
+
/**
|
|
41
|
+
* 查询网关版本信息
|
|
42
|
+
暂不鉴权
|
|
43
|
+
*/
|
|
44
|
+
async DescribeGatewayVersions(req, cb) {
|
|
45
|
+
return this.request("DescribeGatewayVersions", req, cb);
|
|
46
|
+
}
|
|
40
47
|
/**
|
|
41
48
|
* 修改日志主题
|
|
42
49
|
*/
|
|
@@ -50,14 +57,10 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
50
57
|
return this.request("DescribeUserList", req, cb);
|
|
51
58
|
}
|
|
52
59
|
/**
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
调用该接口前需要先查询Mysql是否开通,可通过 [DescribeCreateMySQLResult ](https://cloud.tencent.com/document/api/876/128185) 查询,只有开通成功才能操作。
|
|
58
|
-
*/
|
|
59
|
-
async RunSql(req, cb) {
|
|
60
|
-
return this.request("RunSql", req, cb);
|
|
60
|
+
* 云服务器规格list
|
|
61
|
+
*/
|
|
62
|
+
async DescribeVmSpec(req, cb) {
|
|
63
|
+
return this.request("DescribeVmSpec", req, cb);
|
|
61
64
|
}
|
|
62
65
|
/**
|
|
63
66
|
* 创建托管域名
|
|
@@ -95,10 +98,16 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
95
98
|
return this.request("UpdateTable", req, cb);
|
|
96
99
|
}
|
|
97
100
|
/**
|
|
98
|
-
*
|
|
101
|
+
* 查询 API Key 列表。分页查询指定云开发环境下的 API Key 访问凭证列表。支持按类型过滤(api_key 或 publish_key)。未指定类型时,默认仅返回 api_key 类型的记录。列表查询中 api_key 类型的令牌值将进行脱敏处理(仅保留前后各 6 位字符);publish_key 类型始终返回完整明文。接口需要管理员权限。
|
|
99
102
|
*/
|
|
100
|
-
async
|
|
101
|
-
return this.request("
|
|
103
|
+
async DescribeApiKeyList(req, cb) {
|
|
104
|
+
return this.request("DescribeApiKeyList", req, cb);
|
|
105
|
+
}
|
|
106
|
+
/**
|
|
107
|
+
* 销毁云服务器实例
|
|
108
|
+
*/
|
|
109
|
+
async DeleteVmInstance(req, cb) {
|
|
110
|
+
return this.request("DeleteVmInstance", req, cb);
|
|
102
111
|
}
|
|
103
112
|
/**
|
|
104
113
|
* **创建环境日志资源**
|
|
@@ -117,12 +126,6 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
117
126
|
async CreateEnvResource(req, cb) {
|
|
118
127
|
return this.request("CreateEnvResource", req, cb);
|
|
119
128
|
}
|
|
120
|
-
/**
|
|
121
|
-
* 销毁静态托管资源,该接口创建异步销毁任务,资源最终状态可从DestroyStaticStore接口查看
|
|
122
|
-
*/
|
|
123
|
-
async DestroyStaticStore(req, cb) {
|
|
124
|
-
return this.request("DestroyStaticStore", req, cb);
|
|
125
|
-
}
|
|
126
129
|
/**
|
|
127
130
|
* 本接口用于购买云开发环境。
|
|
128
131
|
该接口会自动下单并支付,会在腾讯云账户中扣除余额(余额不足会下单失败)。
|
|
@@ -140,16 +143,23 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
140
143
|
return this.request("ModifyDatabaseACL", req, cb);
|
|
141
144
|
}
|
|
142
145
|
/**
|
|
143
|
-
|
|
146
|
+
* 创建虚拟服务器
|
|
147
|
+
创建流程为先调用[DescribeVmSpec](https://cloud.tencent.com/document/product/876/129360)获取可购买的规格,同时调用[DescribeBlueprints](https://cloud.tencent.com/document/product/1207/47689)拉取镜像列表,选中一个规格和一个镜像后,调用[InquireVmPrice](https://cloud.tencent.com/document/product/876/129759)询价,如果价格可接受,调用此接口创建实例
|
|
148
|
+
*/
|
|
149
|
+
async CreateVmInstance(req, cb) {
|
|
150
|
+
return this.request("CreateVmInstance", req, cb);
|
|
151
|
+
}
|
|
152
|
+
/**
|
|
153
|
+
* 本接口DeleteHTTPServiceRoute用于删除HTTP访问服务域名或者路由。可批量删除多条path路由、删除域名及所有path路由,如果Paths字段为空则删除域名及所有path路由,如果Paths不为空则仅删除path路由。
|
|
144
154
|
*/
|
|
145
|
-
async
|
|
146
|
-
return this.request("
|
|
155
|
+
async DeleteHTTPServiceRoute(req, cb) {
|
|
156
|
+
return this.request("DeleteHTTPServiceRoute", req, cb);
|
|
147
157
|
}
|
|
148
158
|
/**
|
|
149
|
-
*
|
|
159
|
+
* 本接口DescribeHTTPServiceRoute用于查询环境下HTTP访问服务路由信息。可通过Filters过滤。如果不存在不会返回错误。
|
|
150
160
|
*/
|
|
151
|
-
async
|
|
152
|
-
return this.request("
|
|
161
|
+
async DescribeHTTPServiceRoute(req, cb) {
|
|
162
|
+
return this.request("DescribeHTTPServiceRoute", req, cb);
|
|
153
163
|
}
|
|
154
164
|
/**
|
|
155
165
|
* 增加安全域名。
|
|
@@ -163,18 +173,16 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
163
173
|
return this.request("CreateAuthDomain", req, cb);
|
|
164
174
|
}
|
|
165
175
|
/**
|
|
166
|
-
*
|
|
176
|
+
* 查询环境下的云服务器列表
|
|
167
177
|
*/
|
|
168
|
-
async
|
|
169
|
-
return this.request("
|
|
178
|
+
async DescribeVmInstances(req, cb) {
|
|
179
|
+
return this.request("DescribeVmInstances", req, cb);
|
|
170
180
|
}
|
|
171
181
|
/**
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
async ModifyProvider(req, cb) {
|
|
177
|
-
return this.request("ModifyProvider", req, cb);
|
|
182
|
+
* 查询服务器价格
|
|
183
|
+
*/
|
|
184
|
+
async InquireVmPrice(req, cb) {
|
|
185
|
+
return this.request("InquireVmPrice", req, cb);
|
|
178
186
|
}
|
|
179
187
|
/**
|
|
180
188
|
* 查询服务版本的详情,CPU和MEM 请使用CPUSize和MemSize
|
|
@@ -191,10 +199,10 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
191
199
|
return this.request("DescribeAuthDomains", req, cb);
|
|
192
200
|
}
|
|
193
201
|
/**
|
|
194
|
-
*
|
|
202
|
+
* 查询客户端详情。获取指定云开发环境下某个客户端的配置信息,包括客户端基本信息(名称、图标、描述)、OAuth 凭证(ClientId、ClientSecret)、安全域名、允许的 Scope 列表、Token 有效期、会话控制策略等。当客户端 ID 等于环境 ID 时,返回该环境的默认客户端配置。
|
|
195
203
|
*/
|
|
196
|
-
async
|
|
197
|
-
return this.request("
|
|
204
|
+
async DescribeClient(req, cb) {
|
|
205
|
+
return this.request("DescribeClient", req, cb);
|
|
198
206
|
}
|
|
199
207
|
/**
|
|
200
208
|
* 设置数据库安全规则。
|
|
@@ -236,12 +244,10 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
236
244
|
return this.request("ModifyClient", req, cb);
|
|
237
245
|
}
|
|
238
246
|
/**
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
async RenewEnv(req, cb) {
|
|
244
|
-
return this.request("RenewEnv", req, cb);
|
|
247
|
+
* 本接口ModifyHTTPServiceRoute用于修改HTTP访问服务路由。支持增量修改,对应字段不传参数表示不需要修改
|
|
248
|
+
*/
|
|
249
|
+
async ModifyHTTPServiceRoute(req, cb) {
|
|
250
|
+
return this.request("ModifyHTTPServiceRoute", req, cb);
|
|
245
251
|
}
|
|
246
252
|
/**
|
|
247
253
|
* 查询静态托管域名任务状态
|
|
@@ -249,6 +255,14 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
249
255
|
async DescribeHostingDomainTask(req, cb) {
|
|
250
256
|
return this.request("DescribeHostingDomainTask", req, cb);
|
|
251
257
|
}
|
|
258
|
+
/**
|
|
259
|
+
* 本接口用于云开发环境套餐续费。
|
|
260
|
+
该接口会自动下单并支付,会在腾讯云账户中扣除余额(余额不足会下单失败)。
|
|
261
|
+
该接口支持自动扣除代金券(AutoVoucher=true时),符合条件的代金券会被自动扣除。
|
|
262
|
+
*/
|
|
263
|
+
async RenewEnv(req, cb) {
|
|
264
|
+
return this.request("RenewEnv", req, cb);
|
|
265
|
+
}
|
|
252
266
|
/**
|
|
253
267
|
* 针对已隔离的免费环境,可以通过本接口将其恢复访问。
|
|
254
268
|
*/
|
|
@@ -287,12 +301,6 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
287
301
|
async ModifyEnv(req, cb) {
|
|
288
302
|
return this.request("ModifyEnv", req, cb);
|
|
289
303
|
}
|
|
290
|
-
/**
|
|
291
|
-
* 删除网关API
|
|
292
|
-
*/
|
|
293
|
-
async DeleteCloudBaseGWAPI(req, cb) {
|
|
294
|
-
return this.request("DeleteCloudBaseGWAPI", req, cb);
|
|
295
|
-
}
|
|
296
304
|
/**
|
|
297
305
|
* 删除认证源
|
|
298
306
|
*/
|
|
@@ -313,10 +321,10 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
313
321
|
return this.request("CheckTcbService", req, cb);
|
|
314
322
|
}
|
|
315
323
|
/**
|
|
316
|
-
*
|
|
324
|
+
* 创建云开发平台的API Key。在指定云开发环境下创建一个 API Key 访问凭证。支持两种类型:api_key(服务端管理员访问凭证,以管理员身份签发,可设置有效期,不设置有效期则永不过期,单个环境最多创建 5 个)和 publish_key(前端匿名访问凭证,固定有效期,每个环境仅保留一个)。创建成功后将返回 API Key 明文 Token,该值仅在创建时返回一次,请妥善保存。需要管理员权限。
|
|
317
325
|
*/
|
|
318
|
-
async
|
|
319
|
-
return this.request("
|
|
326
|
+
async CreateApiKey(req, cb) {
|
|
327
|
+
return this.request("CreateApiKey", req, cb);
|
|
320
328
|
}
|
|
321
329
|
/**
|
|
322
330
|
* 查询数据库安全规则。
|
|
@@ -340,10 +348,14 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
340
348
|
return this.request("DescribeMySQLTaskStatus", req, cb);
|
|
341
349
|
}
|
|
342
350
|
/**
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
351
|
+
* 本接口(RunSql)用于执行MySQL语句。
|
|
352
|
+
|
|
353
|
+
该接口用来执行 MySql 语句,比如创建表格、插入数据、修改数据、删除字段、添加索引等可以通过sql 语句实现的都可以使用该接口。
|
|
354
|
+
|
|
355
|
+
调用该接口前需要先查询Mysql是否开通,可通过 [DescribeCreateMySQLResult ](https://cloud.tencent.com/document/api/876/128185) 查询,只有开通成功才能操作。
|
|
356
|
+
*/
|
|
357
|
+
async RunSql(req, cb) {
|
|
358
|
+
return this.request("RunSql", req, cb);
|
|
347
359
|
}
|
|
348
360
|
/**
|
|
349
361
|
* 查询指定指标的配额使用量
|
|
@@ -352,10 +364,27 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
352
364
|
return this.request("DescribeQuotaData", req, cb);
|
|
353
365
|
}
|
|
354
366
|
/**
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
367
|
+
* 修改身份认证源。更新指定云开发环境下已有身份认证源的配置信息,支持修改基本信息(名称、图标、描述)、协议连接配置(ClientId、ClientSecret、端点地址等)、登录行为控制(透传模式、自动注册、邮箱/手机号自动关联)以及启用状态。
|
|
368
|
+
对于 OIDC 类型身份源,修改 Issuer 后将自动通过 OpenID Connect Discovery 重新获取端点配置。
|
|
369
|
+
若自定义登录(CUSTOM)或邮箱登录(EMAIL)身份源尚不存在,调用该接口时将自动创建。
|
|
370
|
+
*/
|
|
371
|
+
async ModifyProvider(req, cb) {
|
|
372
|
+
return this.request("ModifyProvider", req, cb);
|
|
373
|
+
}
|
|
374
|
+
/**
|
|
375
|
+
* 本接口用于销毁云开发环境。
|
|
376
|
+
云开发环境遵循腾讯云包年包月预付费产品生命周期,因此环境销毁需要分两步:
|
|
377
|
+
1. 资源退费。此时会根据当前环境剩余有效期,自动退还相关费用(代金券不退)。退款后,环境进入隔离期。
|
|
378
|
+
2. 环境删除。环境在进入隔离期后15天会自动删除。也可以通过本接口,指定 IsForce=true 来强制删除隔离期环境。
|
|
379
|
+
|
|
380
|
+
**注意**⚠️
|
|
381
|
+
1. 环境退费后进入隔离期,则所有资源均无法访问,控制台无法操作和管理。
|
|
382
|
+
2. 环境被彻底删除后,所有数据均无法找回。请谨慎操作。
|
|
383
|
+
|
|
384
|
+
可以通过接口 [tcb:DescribeBillingInfo](https://cloud.tencent.com/document/product/876/94390) 查询环境计费状态。
|
|
385
|
+
*/
|
|
386
|
+
async DestroyEnv(req, cb) {
|
|
387
|
+
return this.request("DestroyEnv", req, cb);
|
|
359
388
|
}
|
|
360
389
|
/**
|
|
361
390
|
* 修改tcb用户
|
|
@@ -384,25 +413,10 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
384
413
|
return this.request("DeleteTable", req, cb);
|
|
385
414
|
}
|
|
386
415
|
/**
|
|
387
|
-
|
|
388
|
-
云开发环境遵循腾讯云包年包月预付费产品生命周期,因此环境销毁需要分两步:
|
|
389
|
-
1. 资源退费。此时会根据当前环境剩余有效期,自动退还相关费用(代金券不退)。退款后,环境进入隔离期。
|
|
390
|
-
2. 环境删除。环境在进入隔离期后15天会自动删除。也可以通过本接口,指定 IsForce=true 来强制删除隔离期环境。
|
|
391
|
-
|
|
392
|
-
**注意**⚠️
|
|
393
|
-
1. 环境退费后进入隔离期,则所有资源均无法访问,控制台无法操作和管理。
|
|
394
|
-
2. 环境被彻底删除后,所有数据均无法找回。请谨慎操作。
|
|
395
|
-
|
|
396
|
-
可以通过接口 [tcb:DescribeBillingInfo](https://cloud.tencent.com/document/product/876/94390) 查询环境计费状态。
|
|
397
|
-
*/
|
|
398
|
-
async DestroyEnv(req, cb) {
|
|
399
|
-
return this.request("DestroyEnv", req, cb);
|
|
400
|
-
}
|
|
401
|
-
/**
|
|
402
|
-
* 获取网关服务
|
|
416
|
+
* 获取计费相关信息
|
|
403
417
|
*/
|
|
404
|
-
async
|
|
405
|
-
return this.request("
|
|
418
|
+
async DescribeBillingInfo(req, cb) {
|
|
419
|
+
return this.request("DescribeBillingInfo", req, cb);
|
|
406
420
|
}
|
|
407
421
|
/**
|
|
408
422
|
* 获取云托管代码上传url
|
|
@@ -410,6 +424,12 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
410
424
|
async DescribeCloudBaseBuildService(req, cb) {
|
|
411
425
|
return this.request("DescribeCloudBaseBuildService", req, cb);
|
|
412
426
|
}
|
|
427
|
+
/**
|
|
428
|
+
* 搜索用户调用日志
|
|
429
|
+
*/
|
|
430
|
+
async SearchClsLog(req, cb) {
|
|
431
|
+
return this.request("SearchClsLog", req, cb);
|
|
432
|
+
}
|
|
413
433
|
/**
|
|
414
434
|
* 获取环境列表,含环境下的各个资源信息。尤其是各资源的唯一标识,是请求各资源的关键参数
|
|
415
435
|
*/
|
|
@@ -424,6 +444,12 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
424
444
|
async DestroyMySQL(req, cb) {
|
|
425
445
|
return this.request("DestroyMySQL", req, cb);
|
|
426
446
|
}
|
|
447
|
+
/**
|
|
448
|
+
* 本接口(RunCommands)用于执行文档型数据库命令。
|
|
449
|
+
*/
|
|
450
|
+
async RunCommands(req, cb) {
|
|
451
|
+
return this.request("RunCommands", req, cb);
|
|
452
|
+
}
|
|
427
453
|
/**
|
|
428
454
|
* 创建云开发产品计费订单,用于以下几种场景:
|
|
429
455
|
1. 购买云开发环境
|
|
@@ -439,28 +465,22 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
439
465
|
return this.request("CreateBillDeal", req, cb);
|
|
440
466
|
}
|
|
441
467
|
/**
|
|
442
|
-
*
|
|
443
|
-
*/
|
|
444
|
-
async DescribeClient(req, cb) {
|
|
445
|
-
return this.request("DescribeClient", req, cb);
|
|
446
|
-
}
|
|
447
|
-
/**
|
|
448
|
-
* 创建云开发网关API
|
|
468
|
+
* 根据指定指标名称,查询某环境在指定时间范围内的监控数据,返回按统计粒度聚合后的时序数据。
|
|
449
469
|
*/
|
|
450
|
-
async
|
|
451
|
-
return this.request("
|
|
470
|
+
async DescribeCurveData(req, cb) {
|
|
471
|
+
return this.request("DescribeCurveData", req, cb);
|
|
452
472
|
}
|
|
453
473
|
/**
|
|
454
|
-
*
|
|
474
|
+
* 本接口CreateHTTPServiceRoute用于创建HTTP访问服务路由。如果不传Domain.Routes,仅创建域名信息。首次创建域名后需要调用DescribeHTTPServiceRoute查询域名状态,如果状态是PROCESSING,需要轮询查询域名状态直到SUCCESS或者FAIL。如果状态是FAIL,可以删除后重新创建。创建成功后域名可能无法访问,原因是异步下发的路由,可通过http或者https探测路由是否下发,如果http访问返回404或者https访问握手失败,可等待一会再试,直到访问正常。
|
|
455
475
|
*/
|
|
456
|
-
async
|
|
457
|
-
return this.request("
|
|
476
|
+
async CreateHTTPServiceRoute(req, cb) {
|
|
477
|
+
return this.request("CreateHTTPServiceRoute", req, cb);
|
|
458
478
|
}
|
|
459
479
|
/**
|
|
460
|
-
*
|
|
480
|
+
* 本接口(CreateTable)用于创建文档型数据库表,支持创建capped类型集合,暂时不支持分片表。
|
|
461
481
|
*/
|
|
462
|
-
async
|
|
463
|
-
return this.request("
|
|
482
|
+
async CreateTable(req, cb) {
|
|
483
|
+
return this.request("CreateTable", req, cb);
|
|
464
484
|
}
|
|
465
485
|
/**
|
|
466
486
|
* 创建tcb用户
|
|
@@ -481,16 +501,22 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
481
501
|
return this.request("DescribeEnvLimit", req, cb);
|
|
482
502
|
}
|
|
483
503
|
/**
|
|
484
|
-
*
|
|
504
|
+
* 修改登录配置
|
|
485
505
|
*/
|
|
486
|
-
async
|
|
487
|
-
return this.request("
|
|
506
|
+
async EditAuthConfig(req, cb) {
|
|
507
|
+
return this.request("EditAuthConfig", req, cb);
|
|
488
508
|
}
|
|
489
509
|
/**
|
|
490
|
-
*
|
|
510
|
+
* 销毁静态托管资源,该接口创建异步销毁任务,资源最终状态可从DestroyStaticStore接口查看
|
|
491
511
|
*/
|
|
492
|
-
async
|
|
493
|
-
return this.request("
|
|
512
|
+
async DestroyStaticStore(req, cb) {
|
|
513
|
+
return this.request("DestroyStaticStore", req, cb);
|
|
514
|
+
}
|
|
515
|
+
/**
|
|
516
|
+
* 删除指定云开发环境下的某个 API Key 服务端访问凭证。删除后,该 API Key 对应的 Token 将被吊销,已使用该 Key 发起的请求将失败。该操作具有幂等性,若指定的 API Key 不存在则直接返回成功。需要管理员权限。
|
|
517
|
+
*/
|
|
518
|
+
async DeleteApiKey(req, cb) {
|
|
519
|
+
return this.request("DeleteApiKey", req, cb);
|
|
494
520
|
}
|
|
495
521
|
/**
|
|
496
522
|
* 添加身份认证源。在指定云开发环境下创建一个新的身份认证源,支持 OAuth 2.0、OIDC、SAML 2.0 等标准协议,以及自定义登录和邮箱登录等多种认证方式。
|