tencentcloud-sdk-nodejs-tcb 4.1.238 → 4.1.239
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.
|
@@ -29,251 +29,227 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
29
29
|
super("tcb.tencentcloudapi.com", "2018-06-08", clientConfig);
|
|
30
30
|
}
|
|
31
31
|
/**
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
*/
|
|
37
|
-
async DescribeCreateMySQLResult(req, cb) {
|
|
38
|
-
return this.request("DescribeCreateMySQLResult", req, cb);
|
|
32
|
+
* 从环境池里立即取出1个环境
|
|
33
|
+
*/
|
|
34
|
+
async ReleaseEnv(req, cb) {
|
|
35
|
+
return this.request("ReleaseEnv", req, cb);
|
|
39
36
|
}
|
|
40
37
|
/**
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
38
|
+
* 查询 API Key 列表。分页查询指定云开发环境下的 API Key 访问凭证列表。支持按类型过滤（api_key 或 publish_key）。未指定类型时，默认仅返回 api_key 类型的记录。列表查询中 api_key 类型的令牌值将进行脱敏处理（仅保留前后各 6 位字符）；publish_key 类型始终返回完整明文。接口需要管理员权限。
|
|
39
|
+
*/
|
|
40
|
+
async DescribeApiKeyList(req, cb) {
|
|
41
|
+
return this.request("DescribeApiKeyList", req, cb);
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* 查询指定云开发环境下已配置的 AI 模型分组列表。返回结果包含该环境下所有类型的模型分组（自定义类型 custom、内置类型 builtin），以及各分组下的模型列表、服务地址、启用状态等配置信息。
|
|
45
|
+
|
|
46
|
+
通常在以下场景中使用：
|
|
47
|
+
|
|
48
|
+
控制台展示：在云开发控制台 AI+ 功能 → 模型管理页面，展示当前环境已配置的模型分组列表。
|
|
49
|
+
|
|
50
|
+
模型管理：在调用 [UpdateAIModel]() 或 [DeleteAIModel]() 接口前，通过本接口查询当前分组配置。
|
|
51
|
+
|
|
52
|
+
业务集成：开发者查询可用模型列表，用于选择合适的模型接入 AI+ 功能。
|
|
44
53
|
*/
|
|
45
|
-
async
|
|
46
|
-
return this.request("
|
|
54
|
+
async DescribeAIModels(req, cb) {
|
|
55
|
+
return this.request("DescribeAIModels", req, cb);
|
|
47
56
|
}
|
|
48
57
|
/**
|
|
49
|
-
*
|
|
50
|
-
|
|
58
|
+
* **创建环境日志资源**
|
|
59
|
+
|
|
60
|
+
环境开通后，若用户需要开启检索日志功能，需调用此接口进行日志资源的开通。
|
|
61
|
+
|
|
62
|
+
> **注意**：日志资源的开通为**异步操作**，接口调用成功后并不代表日志资源已立即可用。
|
|
63
|
+
|
|
64
|
+
**如何确认日志开通状态：**
|
|
65
|
+
|
|
66
|
+
可通过 [DescribeEnvs](https://cloud.tencent.com/document/product/876/34820) 接口轮询查询日志开通结果，建议每 5 秒轮询一次，最长等待 5 分钟。在返回的数据结构 [EnvInfo](https://cloud.tencent.com/document/api/876/34822#EnvInfo) 中，检查 `LogServices` 字段下 `LogServiceInfo` 是否包含有效的日志主题（Topic）等相关信息，以此判断日志资源是否已成功开通：
|
|
67
|
+
|
|
68
|
+
- **已开通**：`LogServiceInfo` 中存在日志主题 ID 等有效信息
|
|
69
|
+
- **未开通 / 开通中**：`LogServiceInfo` 为空或相关字段缺失
|
|
51
70
|
*/
|
|
52
|
-
async
|
|
53
|
-
return this.request("
|
|
71
|
+
async CreateEnvResource(req, cb) {
|
|
72
|
+
return this.request("CreateEnvResource", req, cb);
|
|
54
73
|
}
|
|
55
74
|
/**
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
75
|
+
* 创建 AI 模型配置分组。云开发标准版及以上套餐才可使用
|
|
76
|
+
|
|
77
|
+
支持自定义类型（custom）：用户自行提供模型服务地址（baseUrl）和访问密钥，分组名可自由命名，适用于接入第三方或自建模型服务。
|
|
78
|
+
|
|
79
|
+
注意：内置类型（builtin）分组由云开发平台统一创建和管理，不支持通过此接口创建。如需修改内置分组的模型列表或启用状态，请使用 [UpdateAIModel](https://cloud.tencent.com/document/product/876/131316) 接口。
|
|
80
|
+
|
|
81
|
+
创建成功后，可通过 [DescribeAIModels](https://cloud.tencent.com/document/product/876/131318) 接口查询分组信息，并在云开发 AI+ 功能中使用所配置的模型。
|
|
82
|
+
*/
|
|
83
|
+
async CreateAIModel(req, cb) {
|
|
84
|
+
return this.request("CreateAIModel", req, cb);
|
|
60
85
|
}
|
|
61
86
|
/**
|
|
62
|
-
*
|
|
63
|
-
|
|
64
|
-
{
|
|
65
|
-
"private_key_id": "<返回的 KeyID>",
|
|
66
|
-
"private_key": "<返回的 PrivateKey>",
|
|
67
|
-
"env_id": "<请求时传入的 EnvId>"
|
|
68
|
-
}
|
|
87
|
+
* 修改客户端配置。采用增量更新策略，仅更新请求中传入的非空字段，未传入的字段保持原值不变。支持修改客户端基本信息（名称、图标、描述、主页地址）、安全域名、允许的 Scope 列表、Token 有效期、会话控制策略及启用状态等配置。
|
|
88
|
+
Id、Secret、CreatedAt、Meta 等字段在该接口中不可修改，当客户端 ID 等于环境 ID 且客户端尚未创建时，将自动创建默认客户端配置。
|
|
69
89
|
*/
|
|
70
|
-
async
|
|
71
|
-
return this.request("
|
|
90
|
+
async ModifyClient(req, cb) {
|
|
91
|
+
return this.request("ModifyClient", req, cb);
|
|
72
92
|
}
|
|
73
93
|
/**
|
|
74
|
-
*
|
|
94
|
+
* 查询客户端详情。获取指定云开发环境下某个客户端的配置信息，包括客户端基本信息（名称、图标、描述）、OAuth 凭证（ClientId、ClientSecret）、安全域名、允许的 Scope 列表、Token 有效期、会话控制策略等。当客户端 ID 等于环境 ID 时，返回该环境的默认客户端配置。
|
|
75
95
|
*/
|
|
76
|
-
async
|
|
77
|
-
return this.request("
|
|
96
|
+
async DescribeClient(req, cb) {
|
|
97
|
+
return this.request("DescribeClient", req, cb);
|
|
78
98
|
}
|
|
79
99
|
/**
|
|
80
|
-
*
|
|
100
|
+
* 修改资源基础权限。
|
|
81
101
|
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
通常在以下场景中使用：
|
|
85
|
-
|
|
86
|
-
开通托管模型前：通过本接口查询平台支持的托管模型及其规格，结合 [UpdateAIModel](https://cloud.tencent.com/document/product/876/131316) 接口完成模型配置。
|
|
102
|
+
修改云函数、云存储和数据库表的基础权限配置。支持预定义权限级别和自定义安全规则两种方式配置资源访问权限。
|
|
87
103
|
*/
|
|
88
|
-
async
|
|
89
|
-
return this.request("
|
|
104
|
+
async ModifyResourcePermission(req, cb) {
|
|
105
|
+
return this.request("ModifyResourcePermission", req, cb);
|
|
90
106
|
}
|
|
91
107
|
/**
|
|
92
|
-
*
|
|
108
|
+
* 获取新套餐列表，含详情，如果传了PackageId，则只获取指定套餐详情
|
|
93
109
|
*/
|
|
94
|
-
async
|
|
95
|
-
return this.request("
|
|
110
|
+
async DescribeBaasPackageList(req, cb) {
|
|
111
|
+
return this.request("DescribeBaasPackageList", req, cb);
|
|
96
112
|
}
|
|
97
113
|
/**
|
|
98
|
-
*
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
例如：
|
|
102
|
-
某个环境在 2026-01-05 购买了3个月个人版(到期时间: 2026-04-05)，则他可以在以下3个周期内，分别享有40000资源点的额度：
|
|
103
|
-
1. 2026-01-05 ~ 2026-02-05 23:59:59
|
|
104
|
-
2. 2026-02-06 ~ 2026-03-05 23:59:59
|
|
105
|
-
3. 2026-03-06 ~ 2026-04-05 23:59:59
|
|
114
|
+
* 从指定云开发环境中解绑已绑定的外部云存储源。解绑后，该环境将不再关联外部 存储源，云存储功能恢复为未绑定状态。
|
|
115
|
+
解绑操作仅移除 CloudBase 侧的绑定关系，不会删除桶本身及桶内数据，桶仍由用户自行管理。
|
|
106
116
|
|
|
107
|
-
|
|
117
|
+
注意⚠️
|
|
118
|
+
解绑之后，会导致云存储不可用，请谨慎操作。
|
|
108
119
|
*/
|
|
109
|
-
async
|
|
110
|
-
return this.request("
|
|
120
|
+
async UnbindStorageSource(req, cb) {
|
|
121
|
+
return this.request("UnbindStorageSource", req, cb);
|
|
111
122
|
}
|
|
112
123
|
/**
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
async CreateMySQL(req, cb) {
|
|
118
|
-
return this.request("CreateMySQL", req, cb);
|
|
124
|
+
* 删除tcb用户
|
|
125
|
+
*/
|
|
126
|
+
async DeleteUsers(req, cb) {
|
|
127
|
+
return this.request("DeleteUsers", req, cb);
|
|
119
128
|
}
|
|
120
129
|
/**
|
|
121
|
-
*
|
|
130
|
+
* 本接口（ListPGUserMigrations）用于查询目标环境已应用的用户 migration 列表。
|
|
122
131
|
*/
|
|
123
|
-
async
|
|
124
|
-
return this.request("
|
|
132
|
+
async ListPGUserMigrations(req, cb) {
|
|
133
|
+
return this.request("ListPGUserMigrations", req, cb);
|
|
125
134
|
}
|
|
126
135
|
/**
|
|
127
|
-
*
|
|
136
|
+
* 检查是否开通Tcb服务
|
|
128
137
|
*/
|
|
129
|
-
async
|
|
130
|
-
return this.request("
|
|
138
|
+
async CheckTcbService(req, cb) {
|
|
139
|
+
return this.request("CheckTcbService", req, cb);
|
|
131
140
|
}
|
|
132
141
|
/**
|
|
133
|
-
*
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
注意：内置类型（builtin）分组由云开发平台统一创建和管理，不支持通过此接口创建。如需修改内置分组的模型列表或启用状态，请使用 [UpdateAIModel](https://cloud.tencent.com/document/product/876/131316) 接口。
|
|
138
|
-
|
|
139
|
-
创建成功后，可通过 [DescribeAIModels](https://cloud.tencent.com/document/product/876/131318) 接口查询分组信息，并在云开发 AI+ 功能中使用所配置的模型。
|
|
142
|
+
* 添加身份认证源。在指定云开发环境下创建一个新的身份认证源，支持 OAuth 2.0、OIDC、SAML 2.0 等标准协议，以及自定义登录和邮箱登录等多种认证方式。
|
|
143
|
+
创建时需指定身份源协议类型（ProviderType）并配置对应的协议连接参数（Config）。若身份源 ID 已存在将返回错误。
|
|
144
|
+
限制：一个环境最大可允许加入20个认证源。
|
|
140
145
|
*/
|
|
141
|
-
async
|
|
142
|
-
return this.request("
|
|
146
|
+
async AddProvider(req, cb) {
|
|
147
|
+
return this.request("AddProvider", req, cb);
|
|
143
148
|
}
|
|
144
149
|
/**
|
|
145
|
-
*
|
|
150
|
+
* 获取云托管代码上传url
|
|
146
151
|
*/
|
|
147
|
-
async
|
|
148
|
-
return this.request("
|
|
152
|
+
async DescribeCloudBaseBuildService(req, cb) {
|
|
153
|
+
return this.request("DescribeCloudBaseBuildService", req, cb);
|
|
149
154
|
}
|
|
150
155
|
/**
|
|
151
|
-
*
|
|
156
|
+
* 销毁云服务器实例
|
|
152
157
|
*/
|
|
153
|
-
async
|
|
154
|
-
return this.request("
|
|
158
|
+
async DeleteVmInstance(req, cb) {
|
|
159
|
+
return this.request("DeleteVmInstance", req, cb);
|
|
155
160
|
}
|
|
156
161
|
/**
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
> **注意**：日志资源的开通为**异步操作**，接口调用成功后并不代表日志资源已立即可用。
|
|
162
|
-
|
|
163
|
-
**如何确认日志开通状态：**
|
|
164
|
-
|
|
165
|
-
可通过 [DescribeEnvs](https://cloud.tencent.com/document/product/876/34820) 接口轮询查询日志开通结果，建议每 5 秒轮询一次，最长等待 5 分钟。在返回的数据结构 [EnvInfo](https://cloud.tencent.com/document/api/876/34822#EnvInfo) 中，检查 `LogServices` 字段下 `LogServiceInfo` 是否包含有效的日志主题（Topic）等相关信息，以此判断日志资源是否已成功开通：
|
|
166
|
-
|
|
167
|
-
- **已开通**：`LogServiceInfo` 中存在日志主题 ID 等有效信息
|
|
168
|
-
- **未开通 / 开通中**：`LogServiceInfo` 为空或相关字段缺失
|
|
169
|
-
*/
|
|
170
|
-
async CreateEnvResource(req, cb) {
|
|
171
|
-
return this.request("CreateEnvResource", req, cb);
|
|
162
|
+
* 创建tcb用户
|
|
163
|
+
*/
|
|
164
|
+
async CreateUser(req, cb) {
|
|
165
|
+
return this.request("CreateUser", req, cb);
|
|
172
166
|
}
|
|
173
167
|
/**
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
环境发货是异步行为，后续可以通过接口 [DescribeEnvs ](https://cloud.tencent.com/document/product/876/34820) 查询环境状态和各项资源信息；通过 [DescribeBillingInfo](https://cloud.tencent.com/document/product/876/94390) 查询环境套餐信息，包括 到期时间、当前套餐等。
|
|
179
|
-
*/
|
|
180
|
-
async CreateEnv(req, cb) {
|
|
181
|
-
return this.request("CreateEnv", req, cb);
|
|
168
|
+
* 创建静态托管资源，包括COS和CDN，异步任务创建，查看创建结果需要根据DescribeStaticStore接口来查看
|
|
169
|
+
*/
|
|
170
|
+
async CreateStaticStore(req, cb) {
|
|
171
|
+
return this.request("CreateStaticStore", req, cb);
|
|
182
172
|
}
|
|
183
173
|
/**
|
|
184
|
-
*
|
|
174
|
+
* 本接口(DescribeTables)用于查询文档型数据库所有表信息，包括表名、表中数据条数、表中数据量、索引个数及索引的大小等。
|
|
185
175
|
*/
|
|
186
|
-
async
|
|
187
|
-
return this.request("
|
|
176
|
+
async DescribeTables(req, cb) {
|
|
177
|
+
return this.request("DescribeTables", req, cb);
|
|
188
178
|
}
|
|
189
179
|
/**
|
|
190
|
-
*
|
|
191
|
-
|
|
180
|
+
* 为云存储绑定外部云存储源。
|
|
181
|
+
将一个用户自有的 COS桶 作为外部存储源绑定到指定云开发环境的云存储。绑定后，该环境的云存储文件操作将指向此桶，通过 BasePath 路径前缀实现与其他环境的数据隔离。
|
|
182
|
+
每个环境仅允许绑定 1 个外部云存储源。
|
|
192
183
|
*/
|
|
193
|
-
async
|
|
194
|
-
return this.request("
|
|
184
|
+
async BindStorageSource(req, cb) {
|
|
185
|
+
return this.request("BindStorageSource", req, cb);
|
|
195
186
|
}
|
|
196
187
|
/**
|
|
197
|
-
*
|
|
188
|
+
* 修改日志主题
|
|
198
189
|
*/
|
|
199
|
-
async
|
|
200
|
-
return this.request("
|
|
190
|
+
async ModifyClsTopic(req, cb) {
|
|
191
|
+
return this.request("ModifyClsTopic", req, cb);
|
|
201
192
|
}
|
|
202
193
|
/**
|
|
203
|
-
*
|
|
194
|
+
* 查询tcb用户列表
|
|
204
195
|
*/
|
|
205
|
-
async
|
|
206
|
-
return this.request("
|
|
196
|
+
async DescribeUserList(req, cb) {
|
|
197
|
+
return this.request("DescribeUserList", req, cb);
|
|
207
198
|
}
|
|
208
199
|
/**
|
|
209
|
-
*
|
|
200
|
+
* 查询静态托管域名任务状态
|
|
210
201
|
*/
|
|
211
|
-
async
|
|
212
|
-
return this.request("
|
|
202
|
+
async DescribeHostingDomainTask(req, cb) {
|
|
203
|
+
return this.request("DescribeHostingDomainTask", req, cb);
|
|
213
204
|
}
|
|
214
205
|
/**
|
|
215
|
-
*
|
|
216
|
-
|
|
217
|
-
通常在以下场景中使用：
|
|
218
|
-
|
|
219
|
-
控制台展示：在云开发控制台 AI+ 功能 → 模型管理页面，展示当前环境已配置的模型分组列表。
|
|
220
|
-
|
|
221
|
-
模型管理：在调用 [UpdateAIModel]() 或 [DeleteAIModel]() 接口前，通过本接口查询当前分组配置。
|
|
206
|
+
* 本接口（CreateMySQL）用于开通Mysql型数据库。
|
|
222
207
|
|
|
223
|
-
|
|
208
|
+
开通后，可通过 [DescribeCreateMySQLResult ](https://cloud.tencent.com/document/api/876/128185) 查询开通结果，Mysql开通成功后，可通过接口设置数据库账号相关功能包括但不限于【创建账号、删除账号、查询可授权权限列表、查询账号已有权限、修改主机、修改配置、修改账号库表权限】、集群操作相关【查询集群参数、修改集群参数】，连接设置相关【关闭外网、开通外网、查询集群信息】，备份回档相关【创建手动回档、删除手动回档、修改自动备份配置信息、查询备份文件列表、集群回档、查询任务列表、获取table列表、获取集群数据库列表、查询备份下载地址】，相关功能接口文档：[TDSQL-C MySQL API文档](https://cloud.tencent.com/document/product/1003/48106)，可以通过 [RunSql](https://cloud.tencent.com/document/api/876/127880) 接口来执行 sql 命令，比如创建表格、插入数据、删除表格等 sql 命令。
|
|
224
209
|
*/
|
|
225
|
-
async
|
|
226
|
-
return this.request("
|
|
210
|
+
async CreateMySQL(req, cb) {
|
|
211
|
+
return this.request("CreateMySQL", req, cb);
|
|
227
212
|
}
|
|
228
213
|
/**
|
|
229
|
-
*
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
安全域名绑定成功之后，需要几分钟时间逐步生效。
|
|
214
|
+
* 本接口用于购买云开发环境。
|
|
215
|
+
该接口会自动下单并支付，会在腾讯云账户中扣除余额（余额不足会下单失败）。
|
|
216
|
+
该接口支持自动扣除代金券（AutoVoucher=true时），符合条件的代金券会被自动扣除。
|
|
217
|
+
环境下单成功之后会返回EnvId。EnvId是全局唯一表示。
|
|
218
|
+
环境发货是异步行为，后续可以通过接口 [DescribeEnvs ](https://cloud.tencent.com/document/product/876/34820) 查询环境状态和各项资源信息；通过 [DescribeBillingInfo](https://cloud.tencent.com/document/product/876/94390) 查询环境套餐信息，包括 到期时间、当前套餐等。
|
|
235
219
|
*/
|
|
236
|
-
async
|
|
237
|
-
return this.request("
|
|
238
|
-
}
|
|
239
|
-
/**
|
|
240
|
-
* 查询环境下的云服务器列表
|
|
241
|
-
*/
|
|
242
|
-
async DescribeVmInstances(req, cb) {
|
|
243
|
-
return this.request("DescribeVmInstances", req, cb);
|
|
220
|
+
async CreateEnv(req, cb) {
|
|
221
|
+
return this.request("CreateEnv", req, cb);
|
|
244
222
|
}
|
|
245
223
|
/**
|
|
246
|
-
*
|
|
224
|
+
* 本接口（RunCommands）用于执行文档型数据库命令。
|
|
247
225
|
*/
|
|
248
|
-
async
|
|
249
|
-
return this.request("
|
|
226
|
+
async RunCommands(req, cb) {
|
|
227
|
+
return this.request("RunCommands", req, cb);
|
|
250
228
|
}
|
|
251
229
|
/**
|
|
252
|
-
*
|
|
230
|
+
* 查询环境下的云服务器列表
|
|
253
231
|
*/
|
|
254
|
-
async
|
|
255
|
-
return this.request("
|
|
232
|
+
async DescribeVmInstances(req, cb) {
|
|
233
|
+
return this.request("DescribeVmInstances", req, cb);
|
|
256
234
|
}
|
|
257
235
|
/**
|
|
258
|
-
*
|
|
236
|
+
* 增加安全域名。
|
|
259
237
|
云开发会校验网页应用请求的来源域名，您需要将来源域名加入到WEB安全域名列表中。
|
|
260
|
-
可以通过接口 [
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
*/
|
|
268
|
-
async DescribeClient(req, cb) {
|
|
269
|
-
return this.request("DescribeClient", req, cb);
|
|
238
|
+
可以通过接口 [DescribeAuthDomains](https://cloud.tencent.com/document/product/876/42151) 获取当前已绑定生效的安全域名。
|
|
239
|
+
|
|
240
|
+
注意⚠️
|
|
241
|
+
安全域名绑定成功之后，需要几分钟时间逐步生效。
|
|
242
|
+
*/
|
|
243
|
+
async CreateAuthDomain(req, cb) {
|
|
244
|
+
return this.request("CreateAuthDomain", req, cb);
|
|
270
245
|
}
|
|
271
246
|
/**
|
|
272
|
-
*
|
|
273
|
-
|
|
247
|
+
* 修改身份认证源。更新指定云开发环境下已有身份认证源的配置信息，支持修改基本信息（名称、图标、描述）、协议连接配置（ClientId、ClientSecret、端点地址等）、登录行为控制（透传模式、自动注册、邮箱/手机号自动关联）以及启用状态。
|
|
248
|
+
对于 OIDC 类型身份源，修改 Issuer 后将自动通过 OpenID Connect Discovery 重新获取端点配置。
|
|
249
|
+
若自定义登录（CUSTOM）或邮箱登录（EMAIL）身份源尚不存在，调用该接口时将自动创建。
|
|
274
250
|
*/
|
|
275
|
-
async
|
|
276
|
-
return this.request("
|
|
251
|
+
async ModifyProvider(req, cb) {
|
|
252
|
+
return this.request("ModifyProvider", req, cb);
|
|
277
253
|
}
|
|
278
254
|
/**
|
|
279
255
|
* 删除合法域名。
|
|
@@ -287,31 +263,10 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
287
263
|
return this.request("DeleteAuthDomain", req, cb);
|
|
288
264
|
}
|
|
289
265
|
/**
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
调用该接口前需要先查询Mysql是否开通，可通过 [DescribeCreateMySQLResult ](https://cloud.tencent.com/document/api/876/128185) 查询，只有已开通的才能查到集群信息，Mysql开通成功后，可通过接口设置数据库账号相关功能包括但不限于【创建账号、删除账号、查询可授权权限列表、查询账号已有权限、修改主机、修改配置、修改账号库表权限】、集群操作相关【查询集群参数、修改集群参数】，连接设置相关【关闭外网、开通外网、查询集群信息】，备份回档相关【创建手动回档、删除手动回档、修改自动备份配置信息、查询备份文件列表、集群回档、查询任务列表、获取table列表、获取集群数据库列表、查询备份下载地址】，相关功能接口文档：[TDSQL-C MySQL API文档](https://cloud.tencent.com/document/product/1003/48106)，可以通过 [RunSql](https://cloud.tencent.com/document/api/876/127880) 接口来执行 MySql 命令，比如创建表格、插入数据、删除表格等 MySql 命令。
|
|
293
|
-
*/
|
|
294
|
-
async DescribeMySQLClusterDetail(req, cb) {
|
|
295
|
-
return this.request("DescribeMySQLClusterDetail", req, cb);
|
|
296
|
-
}
|
|
297
|
-
/**
|
|
298
|
-
* 云服务器规格list
|
|
299
|
-
*/
|
|
300
|
-
async DescribeVmSpec(req, cb) {
|
|
301
|
-
return this.request("DescribeVmSpec", req, cb);
|
|
302
|
-
}
|
|
303
|
-
/**
|
|
304
|
-
* 获取新套餐列表，含详情，如果传了PackageId，则只获取指定套餐详情
|
|
266
|
+
* 本接口DescribeHTTPServiceRoute用于查询环境下HTTP访问服务路由信息。可通过Filters过滤。如果不存在不会返回错误。HTTP访问服务提供了默认域名，通过本接口可直接获取默认域名。
|
|
305
267
|
*/
|
|
306
|
-
async
|
|
307
|
-
return this.request("
|
|
308
|
-
}
|
|
309
|
-
/**
|
|
310
|
-
* 修改客户端配置。采用增量更新策略，仅更新请求中传入的非空字段，未传入的字段保持原值不变。支持修改客户端基本信息（名称、图标、描述、主页地址）、安全域名、允许的 Scope 列表、Token 有效期、会话控制策略及启用状态等配置。
|
|
311
|
-
Id、Secret、CreatedAt、Meta 等字段在该接口中不可修改，当客户端 ID 等于环境 ID 且客户端尚未创建时，将自动创建默认客户端配置。
|
|
312
|
-
*/
|
|
313
|
-
async ModifyClient(req, cb) {
|
|
314
|
-
return this.request("ModifyClient", req, cb);
|
|
268
|
+
async DescribeHTTPServiceRoute(req, cb) {
|
|
269
|
+
return this.request("DescribeHTTPServiceRoute", req, cb);
|
|
315
270
|
}
|
|
316
271
|
/**
|
|
317
272
|
* 本接口ModifyHTTPServiceRoute用于修改HTTP访问服务路由。支持增量修改，对应字段不传参数则不修改
|
|
@@ -320,77 +275,54 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
320
275
|
return this.request("ModifyHTTPServiceRoute", req, cb);
|
|
321
276
|
}
|
|
322
277
|
/**
|
|
323
|
-
*
|
|
278
|
+
* 查询指定云开发环境的登录策略配置。包括手机号短信登录、邮箱登录、用户名密码登录和匿名登录方式的开启状态，同时包含短信验证码发送通道、MFA 多因子认证和密码的更新策略。
|
|
324
279
|
*/
|
|
325
|
-
async
|
|
326
|
-
return this.request("
|
|
280
|
+
async DescribeLoginConfig(req, cb) {
|
|
281
|
+
return this.request("DescribeLoginConfig", req, cb);
|
|
327
282
|
}
|
|
328
283
|
/**
|
|
329
|
-
*
|
|
284
|
+
* 删除认证源
|
|
330
285
|
*/
|
|
331
|
-
async
|
|
332
|
-
return this.request("
|
|
286
|
+
async DeleteProvider(req, cb) {
|
|
287
|
+
return this.request("DeleteProvider", req, cb);
|
|
333
288
|
}
|
|
334
289
|
/**
|
|
335
|
-
*
|
|
336
|
-
|
|
337
|
-
|
|
290
|
+
* 创建云开发平台的API Key。在指定云开发环境下创建一个 API Key 访问凭证。支持两种类型：api_key（服务端管理员访问凭证，以管理员身份签发，可设置有效期，不设置有效期则永不过期，单个环境最多创建 5 个）和 publish_key（前端匿名访问凭证，固定有效期，每个环境仅保留一个）。创建成功后将返回 API Key 明文 Token，该值仅在创建时返回一次，请妥善保存。需要管理员权限。
|
|
291
|
+
权限范围与注意事项：
|
|
292
|
+
- api_key 是以"管理员身份"签发的访问凭证，持有该 Token 即拥有腾讯云云开发数据流（含数据库、云函数、云存储、托管等）资源的完整访问与操作权限。该凭证不区分子资源粒度，一旦泄露等同于环境管理员权限被泄露，请按"高敏感凭证"管理： 仅用于服务端调用、严禁下发到前端/客户端、严禁写入代码仓库或日志、定期轮换并回收闲置凭证。
|
|
293
|
+
- 在为子账号 / 协作者 / RAM 子用户授权该接口权限时，须先评估该子账号是否有资格获得该环境的管理员级数据流权限，能创建 api_key ≈ 能拥有环境管理员权限。
|
|
338
294
|
*/
|
|
339
|
-
async
|
|
340
|
-
return this.request("
|
|
341
|
-
}
|
|
342
|
-
/**
|
|
343
|
-
* 本接口（DescribeDatabaseACL）获取文档型数据库权限。
|
|
344
|
-
*/
|
|
345
|
-
async DescribeDatabaseACL(req, cb) {
|
|
346
|
-
return this.request("DescribeDatabaseACL", req, cb);
|
|
347
|
-
}
|
|
348
|
-
/**
|
|
349
|
-
* 删除tcb用户
|
|
350
|
-
*/
|
|
351
|
-
async DeleteUsers(req, cb) {
|
|
352
|
-
return this.request("DeleteUsers", req, cb);
|
|
295
|
+
async CreateApiKey(req, cb) {
|
|
296
|
+
return this.request("CreateApiKey", req, cb);
|
|
353
297
|
}
|
|
354
298
|
/**
|
|
355
|
-
*
|
|
356
|
-
|
|
357
|
-
不同分组类型支持的更新操作如下：
|
|
358
|
-
自定义类型（custom）：可更新模型服务地址（BaseUrl）、访问密钥（Secret）、模型列表及分组备注。
|
|
359
|
-
内置类型（builtin）：默认由云开发平台统一管理服务地址和密钥。若同时传入自定义 BaseURL 和 Secret，该分组将自动转换为自定义类型（custom），后续使用用户自行提供的服务地址和访问密钥，平台不再托管其凭证。
|
|
360
|
-
|
|
361
|
-
分组类型转换说明:
|
|
362
|
-
调用本接口时，可通过传入 BaseURL 与 Secret 参数触发分组类型的自动转换，规则如下：
|
|
363
|
-
(1) builtin → custom（内置转自定义）
|
|
364
|
-
当分组当前类型（Type）为 builtin 时，若请求中同时传入有效的 BaseURL（非 http://default.tcb）和 Secret，系统将自动将该分组转换为自定义类型（Type = custom）。转换后，平台不再托管该分组的服务地址和访问密钥，后续将使用用户自行提供的 BaseUrl 与 Secret 对模型服务发起请求。
|
|
365
|
-
|
|
366
|
-
(2) custom → builtin（自定义恢复内置托管）
|
|
367
|
-
仅当分组的原始类型（OriginType）为 builtin 时，支持将分组恢复为内置托管类型。将 BaseUrl 传入固定值 http://default.tcb，且不传入 Secret，系统将自动将该分组转换回内置托管类型（Type = builtin），平台重新接管其服务地址和访问密钥。
|
|
368
|
-
若 OriginType 为 CUSTOM（即用户通过 [CreateAIModel](https://cloud.tencent.com/document/product/876/131320) 接口自行创建的自定义分组），不支持恢复为内置托管类型。
|
|
369
|
-
|
|
370
|
-
更新成功后，可通过 [DescribeAIModels](https://cloud.tencent.com/document/product/876/131318) 接口查询最新分组配置。
|
|
299
|
+
* 查询数据库安全规则。
|
|
300
|
+
安全规则，用于控制C端用户的访问权限。详见 [安全规则介绍](https://cloud.tencent.com/document/product/876/123478) 。
|
|
371
301
|
*/
|
|
372
|
-
async
|
|
373
|
-
return this.request("
|
|
302
|
+
async DescribeSafeRule(req, cb) {
|
|
303
|
+
return this.request("DescribeSafeRule", req, cb);
|
|
374
304
|
}
|
|
375
305
|
/**
|
|
376
|
-
*
|
|
306
|
+
* 本接口（DescribeMySQLTaskStatus）用于查询Mysql任务状态。
|
|
377
307
|
*/
|
|
378
|
-
async
|
|
379
|
-
return this.request("
|
|
308
|
+
async DescribeMySQLTaskStatus(req, cb) {
|
|
309
|
+
return this.request("DescribeMySQLTaskStatus", req, cb);
|
|
380
310
|
}
|
|
381
311
|
/**
|
|
382
|
-
* 本接口（
|
|
312
|
+
* 本接口（RunSql）用于执行MySQL语句。
|
|
383
313
|
|
|
384
|
-
|
|
314
|
+
该接口用来执行 MySql 语句，比如创建表格、插入数据、修改数据、删除字段、添加索引等可以通过sql 语句实现的都可以使用该接口。
|
|
315
|
+
|
|
316
|
+
调用该接口前需要先查询Mysql是否开通，可通过 [DescribeCreateMySQLResult ](https://cloud.tencent.com/document/api/876/128185) 查询，只有开通成功才能操作。
|
|
385
317
|
*/
|
|
386
|
-
async
|
|
387
|
-
return this.request("
|
|
318
|
+
async RunSql(req, cb) {
|
|
319
|
+
return this.request("RunSql", req, cb);
|
|
388
320
|
}
|
|
389
321
|
/**
|
|
390
|
-
*
|
|
322
|
+
* 查询指定云开发环境下的身份认证源列表。返回该环境已配置的所有身份认证源信息，包括第三方登录（OAuth、OIDC、SAML）、微信小程序登录、自定义登录和邮箱登录等。返回结果包含认证源基本信息、关联应用、配置状态及启用情况。若自定义登录或邮箱登录的身份源尚未创建，接口会自动追加一个默认关闭状态的身份源记录。
|
|
391
323
|
*/
|
|
392
|
-
async
|
|
393
|
-
return this.request("
|
|
324
|
+
async GetProviders(req, cb) {
|
|
325
|
+
return this.request("GetProviders", req, cb);
|
|
394
326
|
}
|
|
395
327
|
/**
|
|
396
328
|
* 修改指定云开发环境已绑定的外部云存储源配置。
|
|
@@ -403,77 +335,151 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
403
335
|
return this.request("ModifyStorageSource", req, cb);
|
|
404
336
|
}
|
|
405
337
|
/**
|
|
406
|
-
|
|
338
|
+
* 创建云开发产品计费订单，用于以下几种场景：
|
|
339
|
+
1. 购买云开发环境
|
|
340
|
+
2. 续费云开发环境
|
|
341
|
+
3. 变更云开发环境套餐
|
|
342
|
+
4. 购买云开发资源包
|
|
343
|
+
5. 购买云开发大促包
|
|
344
|
+
|
|
345
|
+
该接口支持下单并支付(CreateAndPay=true时)，此时会自动在腾讯云账户中扣除余额（余额不足会下单失败）。
|
|
346
|
+
该接口支持自动扣除代金券（AutoVoucher=true时），符合条件的代金券会被自动扣除。
|
|
347
|
+
*/
|
|
348
|
+
async CreateBillDeal(req, cb) {
|
|
349
|
+
return this.request("CreateBillDeal", req, cb);
|
|
350
|
+
}
|
|
351
|
+
/**
|
|
352
|
+
* 根据指定指标名称，查询某环境在指定时间范围内的监控数据，返回按统计粒度聚合后的时序数据。
|
|
407
353
|
*/
|
|
408
|
-
async
|
|
409
|
-
return this.request("
|
|
354
|
+
async DescribeCurveData(req, cb) {
|
|
355
|
+
return this.request("DescribeCurveData", req, cb);
|
|
410
356
|
}
|
|
411
357
|
/**
|
|
412
|
-
*
|
|
358
|
+
* 本接口（ModifyDatabaseACL）用于修改文档型数据库权限。
|
|
413
359
|
*/
|
|
414
|
-
async
|
|
415
|
-
return this.request("
|
|
360
|
+
async ModifyDatabaseACL(req, cb) {
|
|
361
|
+
return this.request("ModifyDatabaseACL", req, cb);
|
|
416
362
|
}
|
|
417
363
|
/**
|
|
418
|
-
|
|
364
|
+
* 查询环境个数上限
|
|
365
|
+
*/
|
|
366
|
+
async DescribeEnvLimit(req, cb) {
|
|
367
|
+
return this.request("DescribeEnvLimit", req, cb);
|
|
368
|
+
}
|
|
369
|
+
/**
|
|
370
|
+
* 销毁静态托管资源，该接口创建异步销毁任务，资源最终状态可从DestroyStaticStore接口查看
|
|
371
|
+
*/
|
|
372
|
+
async DestroyStaticStore(req, cb) {
|
|
373
|
+
return this.request("DestroyStaticStore", req, cb);
|
|
374
|
+
}
|
|
375
|
+
/**
|
|
376
|
+
* 删除指定云开发环境下的某个 API Key 服务端访问凭证。删除后，该 API Key 对应的 Token 将被吊销，已使用该 Key 发起的请求将失败。该操作具有幂等性，若指定的 API Key 不存在则直接返回成功。需要管理员权限。
|
|
377
|
+
*/
|
|
378
|
+
async DeleteApiKey(req, cb) {
|
|
379
|
+
return this.request("DeleteApiKey", req, cb);
|
|
380
|
+
}
|
|
381
|
+
/**
|
|
382
|
+
* 本接口(ListTables)用于查询文档型数据库所有表信息，包括表名、表中数据条数、表中数据量、索引个数及索引的大小等。
|
|
419
383
|
|
|
420
|
-
|
|
421
|
-
|
|
384
|
+
该接口跟 [DescribeTables](https://cloud.tencent.com/document/api/876/127962) 接口功能一致，后续该接口可能会下线，请使用 [DescribeTable](https://cloud.tencent.com/document/api/876/127962)接口。
|
|
385
|
+
*/
|
|
386
|
+
async ListTables(req, cb) {
|
|
387
|
+
return this.request("ListTables", req, cb);
|
|
388
|
+
}
|
|
389
|
+
/**
|
|
390
|
+
* 本接口（DescribePGUserMigration）用于查询目标环境指定 migration 详情。
|
|
391
|
+
*/
|
|
392
|
+
async DescribePGUserMigration(req, cb) {
|
|
393
|
+
return this.request("DescribePGUserMigration", req, cb);
|
|
394
|
+
}
|
|
395
|
+
/**
|
|
396
|
+
* 查询云开发平台支持的托管类型 AI 模型列表。
|
|
422
397
|
|
|
423
|
-
|
|
398
|
+
托管类型模型由云开发平台统一接入和管理，用户无需自行配置模型服务地址和访问密钥，开通后即可直接使用。返回结果按模型分组（Group）组织，包含各模型的规格参数（ModelSpec）和计费信息（ModelChargingInfo）。
|
|
399
|
+
|
|
400
|
+
通常在以下场景中使用：
|
|
401
|
+
|
|
402
|
+
开通托管模型前：通过本接口查询平台支持的托管模型及其规格，结合 [UpdateAIModel](https://cloud.tencent.com/document/product/876/131316) 接口完成模型配置。
|
|
424
403
|
*/
|
|
425
|
-
async
|
|
426
|
-
return this.request("
|
|
404
|
+
async DescribeManagedAIModelList(req, cb) {
|
|
405
|
+
return this.request("DescribeManagedAIModelList", req, cb);
|
|
427
406
|
}
|
|
428
407
|
/**
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
408
|
+
* 创建托管域名
|
|
409
|
+
*/
|
|
410
|
+
async CreateHostingDomain(req, cb) {
|
|
411
|
+
return this.request("CreateHostingDomain", req, cb);
|
|
412
|
+
}
|
|
413
|
+
/**
|
|
414
|
+
* 创建虚拟服务器
|
|
415
|
+
创建流程为先调用[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)询价，如果价格可接受，调用此接口创建实例
|
|
433
416
|
*/
|
|
434
|
-
async
|
|
435
|
-
return this.request("
|
|
417
|
+
async CreateVmInstance(req, cb) {
|
|
418
|
+
return this.request("CreateVmInstance", req, cb);
|
|
436
419
|
}
|
|
437
420
|
/**
|
|
438
|
-
|
|
439
|
-
|
|
421
|
+
* 本接口DeleteHTTPServiceRoute用于删除HTTP访问服务域名或者路由。可批量删除多条path路由、删除域名及所有path路由，如果Paths字段为空则删除域名及所有path路由，如果Paths不为空则仅删除path路由。
|
|
422
|
+
*/
|
|
423
|
+
async DeleteHTTPServiceRoute(req, cb) {
|
|
424
|
+
return this.request("DeleteHTTPServiceRoute", req, cb);
|
|
425
|
+
}
|
|
426
|
+
/**
|
|
427
|
+
* 获取环境列表，含环境下的各个资源信息。尤其是各资源的唯一标识，是请求各资源的关键参数
|
|
428
|
+
*/
|
|
429
|
+
async DescribeEnvs(req, cb) {
|
|
430
|
+
return this.request("DescribeEnvs", req, cb);
|
|
431
|
+
}
|
|
432
|
+
/**
|
|
433
|
+
* 查询服务版本的详情，CPU和MEM 请使用CPUSize和MemSize
|
|
434
|
+
*/
|
|
435
|
+
async DescribeCloudBaseRunServerVersion(req, cb) {
|
|
436
|
+
return this.request("DescribeCloudBaseRunServerVersion", req, cb);
|
|
437
|
+
}
|
|
438
|
+
/**
|
|
439
|
+
* 设置数据库安全规则。
|
|
440
|
+
安全规则，用于控制C端用户的访问权限。详见 [安全规则介绍 ](https://cloud.tencent.com/document/product/876/123478)。
|
|
440
441
|
*/
|
|
441
|
-
async
|
|
442
|
-
return this.request("
|
|
442
|
+
async ModifySafeRule(req, cb) {
|
|
443
|
+
return this.request("ModifySafeRule", req, cb);
|
|
443
444
|
}
|
|
444
445
|
/**
|
|
445
|
-
*
|
|
446
|
-
|
|
447
|
-
|
|
446
|
+
* 本接口（DescribeTable）用于查询文档型数据库表的相关信息，包括索引等信息。
|
|
447
|
+
|
|
448
|
+
接口入参中的 Tag 为文档型数据库的实例 Id，可以通过 [DescribeEnvs](https://cloud.tencent.com/document/api/876/34820) 接口返回的 EnvList[0].Databases[0].InstanceId 获取。
|
|
448
449
|
*/
|
|
449
|
-
async
|
|
450
|
-
return this.request("
|
|
450
|
+
async DescribeTable(req, cb) {
|
|
451
|
+
return this.request("DescribeTable", req, cb);
|
|
451
452
|
}
|
|
452
453
|
/**
|
|
453
|
-
* 本接口（
|
|
454
|
+
* 本接口（RepairPGUserMigrationHistory）用于受控修复 history，只修改 user_schema_migrations，不执行 SQL。
|
|
454
455
|
*/
|
|
455
|
-
async
|
|
456
|
-
return this.request("
|
|
456
|
+
async RepairPGUserMigrationHistory(req, cb) {
|
|
457
|
+
return this.request("RepairPGUserMigrationHistory", req, cb);
|
|
457
458
|
}
|
|
458
459
|
/**
|
|
459
|
-
*
|
|
460
|
+
* 在Postgres数据库上执行SQL
|
|
460
461
|
*/
|
|
461
|
-
async
|
|
462
|
-
return this.request("
|
|
462
|
+
async ExecutePGSql(req, cb) {
|
|
463
|
+
return this.request("ExecutePGSql", req, cb);
|
|
463
464
|
}
|
|
464
465
|
/**
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
466
|
+
* 删除 AI 模型配置分组，支持批量删除。内置分组无法删除。分组删除后，该分组下的所有模型配置将同步移除，针对该分组模型的请求将会失败，请在删除前确认业务侧已停止对该分组的调用。
|
|
467
|
+
|
|
468
|
+
注意：
|
|
469
|
+
此操作不可逆，删除后数据无法恢复，请谨慎操作。
|
|
470
|
+
|
|
471
|
+
删除前建议通过 [DescribeAIModelList]() 接口确认分组当前状态。
|
|
472
|
+
*/
|
|
473
|
+
async DeleteAIModel(req, cb) {
|
|
474
|
+
return this.request("DeleteAIModel", req, cb);
|
|
469
475
|
}
|
|
470
476
|
/**
|
|
471
|
-
*
|
|
472
|
-
|
|
473
|
-
|
|
477
|
+
* 本接口(DeleteTable)用于删除文档型数据库表，删除表后表中数据将会被删除且无法恢复，请谨慎操作。
|
|
478
|
+
|
|
479
|
+
接口入参中的 Tag 为文档型数据库的实例 Id，可以通过 [DescribeEnvs](https://cloud.tencent.com/document/api/876/34820) 接口返回的 EnvList[0].Databases[0].InstanceId 获取。
|
|
474
480
|
*/
|
|
475
|
-
async
|
|
476
|
-
return this.request("
|
|
481
|
+
async DeleteTable(req, cb) {
|
|
482
|
+
return this.request("DeleteTable", req, cb);
|
|
477
483
|
}
|
|
478
484
|
/**
|
|
479
485
|
* 本接口用于销毁云开发环境。
|
|
@@ -491,179 +497,225 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
491
497
|
return this.request("DestroyEnv", req, cb);
|
|
492
498
|
}
|
|
493
499
|
/**
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
500
|
+
* 本接口（DestroyMySQL）用于销毁Mysql。
|
|
501
|
+
|
|
502
|
+
销毁后可以通过 [DescribeMySQLTaskStatus](https://cloud.tencent.com/document/api/876/128183) 接口查询销毁结果，如果 `Response.Data. Status = FAILED ` 表示销毁失败，可以重新调用销毁接口重试。
|
|
503
|
+
*/
|
|
504
|
+
async DestroyMySQL(req, cb) {
|
|
505
|
+
return this.request("DestroyMySQL", req, cb);
|
|
498
506
|
}
|
|
499
507
|
/**
|
|
500
|
-
*
|
|
508
|
+
* 本接口CreateHTTPServiceRoute用于创建HTTP访问服务路由。如果不传Domain.Routes，仅创建域名信息。首次创建域名后需要调用DescribeHTTPServiceRoute查询域名状态，如果状态是PROCESSING，需要轮询查询域名状态直到SUCCESS或者FAIL。如果状态是FAIL，可以删除后重新创建。创建成功后域名可能无法访问，原因是异步下发的路由，可通过http或者https探测路由是否下发，如果http访问返回404或者https访问握手失败，可等待一会再试，直到访问正常。此外HTTP访问服务提供了默认域名，通过DescribeHTTPServiceRoute接口可直接获取默认域名。
|
|
501
509
|
*/
|
|
502
|
-
async
|
|
503
|
-
return this.request("
|
|
510
|
+
async CreateHTTPServiceRoute(req, cb) {
|
|
511
|
+
return this.request("CreateHTTPServiceRoute", req, cb);
|
|
504
512
|
}
|
|
505
513
|
/**
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
514
|
+
* 查询资源基础权限。
|
|
515
|
+
|
|
516
|
+
查询云函数、云存储和数据库表的基础权限配置。支持单个资源查询和批量查询。
|
|
517
|
+
*/
|
|
518
|
+
async DescribeResourcePermission(req, cb) {
|
|
519
|
+
return this.request("DescribeResourcePermission", req, cb);
|
|
510
520
|
}
|
|
511
521
|
/**
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
522
|
+
* 查询环境计费周期。
|
|
523
|
+
云开发环境的资源点都是按月结算的，每个月都有一定的抵扣额度。
|
|
524
|
+
|
|
525
|
+
例如：
|
|
526
|
+
某个环境在 2026-01-05 购买了3个月个人版(到期时间: 2026-04-05)，则他可以在以下3个周期内，分别享有40000资源点的额度：
|
|
527
|
+
1. 2026-01-05 ~ 2026-02-05 23:59:59
|
|
528
|
+
2. 2026-02-06 ~ 2026-03-05 23:59:59
|
|
529
|
+
3. 2026-03-06 ~ 2026-04-05 23:59:59
|
|
530
|
+
|
|
531
|
+
本接口，用于获取环境当前属于哪个计费周期内。
|
|
532
|
+
*/
|
|
533
|
+
async DescribeEnvAccountCircle(req, cb) {
|
|
534
|
+
return this.request("DescribeEnvAccountCircle", req, cb);
|
|
516
535
|
}
|
|
517
536
|
/**
|
|
518
|
-
*
|
|
537
|
+
* 本接口（DescribeCreateMySQLResult）用于查询开通Mysql结果。
|
|
519
538
|
|
|
520
|
-
|
|
539
|
+
`Response.Data.Status = "notexist"` 表示未开通，如果未开通，可以调用 [CreateMySQL](https://cloud.tencent.com/document/api/876/128186) 来开通
|
|
540
|
+
`Response.Data. Status = "success"` 表示开通成功，Mysql开通成功后，可通过接口设置数据库账号相关功能包括但不限于【创建账号、删除账号、查询可授权权限列表、查询账号已有权限、修改主机、修改配置、修改账号库表权限】、集群操作相关【查询集群参数、修改集群参数】，连接设置相关【关闭外网、开通外网、查询集群信息】，备份回档相关【创建手动回档、删除手动回档、修改自动备份配置信息、查询备份文件列表、集群回档、查询任务列表、获取table列表、获取集群数据库列表、查询备份下载地址】，相关功能接口文档：[TDSQL-C MySQL API文档](https://cloud.tencent.com/document/product/1003/48106)，可以通过 [RunSql](https://cloud.tencent.com/document/api/876/127880) 接口来执行 sql 命令，比如创建表格、插入数据、删除表格等 MySql 命令。
|
|
521
541
|
*/
|
|
522
|
-
async
|
|
523
|
-
return this.request("
|
|
542
|
+
async DescribeCreateMySQLResult(req, cb) {
|
|
543
|
+
return this.request("DescribeCreateMySQLResult", req, cb);
|
|
524
544
|
}
|
|
525
545
|
/**
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
546
|
+
* 查询网关版本信息
|
|
547
|
+
暂不鉴权
|
|
548
|
+
*/
|
|
549
|
+
async DescribeGatewayVersions(req, cb) {
|
|
550
|
+
return this.request("DescribeGatewayVersions", req, cb);
|
|
530
551
|
}
|
|
531
552
|
/**
|
|
532
|
-
*
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
553
|
+
* 创建自定义登录密钥。在指定云开发环境下生成一对 RSA 1024 位非对称密钥对，系统仅存储公钥，私钥仅在创建时返回一次且不可恢复，请妥善保存。创建新密钥后，该环境下原有未设置过期时间的旧密钥将被自动标记为 2 小时后过期，请确保客户端及时更新密钥配置。
|
|
554
|
+
返回的 KeyID 和 PrivateKey 需与环境 ID 一起组装为 JSON 配置文件，供客户端 Admin SDK 初始化时使用，文件格式如下：
|
|
555
|
+
{
|
|
556
|
+
"private_key_id": "<返回的 KeyID>",
|
|
557
|
+
"private_key": "<返回的 PrivateKey>",
|
|
558
|
+
"env_id": "<请求时传入的 EnvId>"
|
|
559
|
+
}
|
|
537
560
|
*/
|
|
538
|
-
async
|
|
539
|
-
return this.request("
|
|
561
|
+
async CreateCustomLoginKey(req, cb) {
|
|
562
|
+
return this.request("CreateCustomLoginKey", req, cb);
|
|
540
563
|
}
|
|
541
564
|
/**
|
|
542
|
-
*
|
|
565
|
+
* 白名单接口，申请Tcb角色临时凭证
|
|
543
566
|
*/
|
|
544
|
-
async
|
|
545
|
-
return this.request("
|
|
567
|
+
async AssumeRoleForAllocatedEnv(req, cb) {
|
|
568
|
+
return this.request("AssumeRoleForAllocatedEnv", req, cb);
|
|
546
569
|
}
|
|
547
570
|
/**
|
|
548
|
-
*
|
|
571
|
+
* 本接口(CreateTable)用于创建文档型数据库表，支持创建capped类型集合，暂时不支持分片表。
|
|
549
572
|
*/
|
|
550
|
-
async
|
|
551
|
-
return this.request("
|
|
573
|
+
async CreateTable(req, cb) {
|
|
574
|
+
return this.request("CreateTable", req, cb);
|
|
552
575
|
}
|
|
553
576
|
/**
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
577
|
+
* 本接口（PreviewPGUserMigrations）用于预览SQL migrations 在远端的执行计划，不实际执行SQL。
|
|
578
|
+
*/
|
|
579
|
+
async PreviewPGUserMigrations(req, cb) {
|
|
580
|
+
return this.request("PreviewPGUserMigrations", req, cb);
|
|
581
|
+
}
|
|
582
|
+
/**
|
|
583
|
+
* 查询服务器价格
|
|
584
|
+
*/
|
|
585
|
+
async InquireVmPrice(req, cb) {
|
|
586
|
+
return this.request("InquireVmPrice", req, cb);
|
|
587
|
+
}
|
|
588
|
+
/**
|
|
589
|
+
* 本接口用于获取当前环境的安全域名列表。
|
|
590
|
+
云开发会校验网页应用请求的来源域名，您需要将来源域名加入到WEB安全域名列表中。
|
|
591
|
+
可以通过接口 [CreateAuthDomain](https://cloud.tencent.com/document/product/876/42764) 增加安全域名。
|
|
557
592
|
*/
|
|
558
|
-
async
|
|
559
|
-
return this.request("
|
|
593
|
+
async DescribeAuthDomains(req, cb) {
|
|
594
|
+
return this.request("DescribeAuthDomains", req, cb);
|
|
560
595
|
}
|
|
561
596
|
/**
|
|
562
|
-
*
|
|
563
|
-
|
|
597
|
+
* 本接口（DescribeMySQLClusterDetail）查询Mysql集群信息。
|
|
598
|
+
|
|
599
|
+
调用该接口前需要先查询Mysql是否开通，可通过 [DescribeCreateMySQLResult ](https://cloud.tencent.com/document/api/876/128185) 查询，只有已开通的才能查到集群信息，Mysql开通成功后，可通过接口设置数据库账号相关功能包括但不限于【创建账号、删除账号、查询可授权权限列表、查询账号已有权限、修改主机、修改配置、修改账号库表权限】、集群操作相关【查询集群参数、修改集群参数】，连接设置相关【关闭外网、开通外网、查询集群信息】，备份回档相关【创建手动回档、删除手动回档、修改自动备份配置信息、查询备份文件列表、集群回档、查询任务列表、获取table列表、获取集群数据库列表、查询备份下载地址】，相关功能接口文档：[TDSQL-C MySQL API文档](https://cloud.tencent.com/document/product/1003/48106)，可以通过 [RunSql](https://cloud.tencent.com/document/api/876/127880) 接口来执行 MySql 命令，比如创建表格、插入数据、删除表格等 MySql 命令。
|
|
564
600
|
*/
|
|
565
|
-
async
|
|
566
|
-
return this.request("
|
|
601
|
+
async DescribeMySQLClusterDetail(req, cb) {
|
|
602
|
+
return this.request("DescribeMySQLClusterDetail", req, cb);
|
|
567
603
|
}
|
|
568
604
|
/**
|
|
569
|
-
*
|
|
605
|
+
* 获取计费相关信息
|
|
570
606
|
*/
|
|
571
|
-
async
|
|
572
|
-
return this.request("
|
|
607
|
+
async DescribeBillingInfo(req, cb) {
|
|
608
|
+
return this.request("DescribeBillingInfo", req, cb);
|
|
573
609
|
}
|
|
574
610
|
/**
|
|
575
|
-
*
|
|
576
|
-
|
|
577
|
-
2. 续费云开发环境
|
|
578
|
-
3. 变更云开发环境套餐
|
|
579
|
-
4. 购买云开发资源包
|
|
580
|
-
5. 购买云开发大促包
|
|
581
|
-
|
|
582
|
-
该接口支持下单并支付(CreateAndPay=true时)，此时会自动在腾讯云账户中扣除余额（余额不足会下单失败）。
|
|
611
|
+
* 本接口用于云开发环境套餐续费。
|
|
612
|
+
该接口会自动下单并支付，会在腾讯云账户中扣除余额（余额不足会下单失败）。
|
|
583
613
|
该接口支持自动扣除代金券（AutoVoucher=true时），符合条件的代金券会被自动扣除。
|
|
584
614
|
*/
|
|
585
|
-
async
|
|
586
|
-
return this.request("
|
|
615
|
+
async RenewEnv(req, cb) {
|
|
616
|
+
return this.request("RenewEnv", req, cb);
|
|
587
617
|
}
|
|
588
618
|
/**
|
|
589
|
-
*
|
|
619
|
+
* 从环境池里立即取出1个环境
|
|
590
620
|
*/
|
|
591
|
-
async
|
|
592
|
-
return this.request("
|
|
621
|
+
async AllocateEnv(req, cb) {
|
|
622
|
+
return this.request("AllocateEnv", req, cb);
|
|
593
623
|
}
|
|
594
624
|
/**
|
|
595
|
-
*
|
|
625
|
+
* 本接口（DescribeDatabaseACL）获取文档型数据库权限。
|
|
596
626
|
*/
|
|
597
|
-
async
|
|
598
|
-
return this.request("
|
|
627
|
+
async DescribeDatabaseACL(req, cb) {
|
|
628
|
+
return this.request("DescribeDatabaseACL", req, cb);
|
|
599
629
|
}
|
|
600
630
|
/**
|
|
601
|
-
|
|
631
|
+
* 更新 AI 模型配置分组。支持修改分组的模型列表、服务地址、访问密钥、备注及启用状态。
|
|
632
|
+
|
|
633
|
+
不同分组类型支持的更新操作如下：
|
|
634
|
+
自定义类型（custom）：可更新模型服务地址（BaseUrl）、访问密钥（Secret）、模型列表及分组备注。
|
|
635
|
+
内置类型（builtin）：默认由云开发平台统一管理服务地址和密钥。若同时传入自定义 BaseURL 和 Secret，该分组将自动转换为自定义类型（custom），后续使用用户自行提供的服务地址和访问密钥，平台不再托管其凭证。
|
|
636
|
+
|
|
637
|
+
分组类型转换说明:
|
|
638
|
+
调用本接口时，可通过传入 BaseURL 与 Secret 参数触发分组类型的自动转换，规则如下：
|
|
639
|
+
(1) builtin → custom（内置转自定义）
|
|
640
|
+
当分组当前类型（Type）为 builtin 时，若请求中同时传入有效的 BaseURL（非 http://default.tcb）和 Secret，系统将自动将该分组转换为自定义类型（Type = custom）。转换后，平台不再托管该分组的服务地址和访问密钥，后续将使用用户自行提供的 BaseUrl 与 Secret 对模型服务发起请求。
|
|
641
|
+
|
|
642
|
+
(2) custom → builtin（自定义恢复内置托管）
|
|
643
|
+
仅当分组的原始类型（OriginType）为 builtin 时，支持将分组恢复为内置托管类型。将 BaseUrl 传入固定值 http://default.tcb，且不传入 Secret，系统将自动将该分组转换回内置托管类型（Type = builtin），平台重新接管其服务地址和访问密钥。
|
|
644
|
+
若 OriginType 为 CUSTOM（即用户通过 [CreateAIModel](https://cloud.tencent.com/document/product/876/131320) 接口自行创建的自定义分组），不支持恢复为内置托管类型。
|
|
645
|
+
|
|
646
|
+
更新成功后，可通过 [DescribeAIModels](https://cloud.tencent.com/document/product/876/131318) 接口查询最新分组配置。
|
|
647
|
+
*/
|
|
648
|
+
async UpdateAIModel(req, cb) {
|
|
649
|
+
return this.request("UpdateAIModel", req, cb);
|
|
650
|
+
}
|
|
651
|
+
/**
|
|
652
|
+
* 查看当前环境下静态托管资源信息，根据返回结果判断静态资源的状态
|
|
602
653
|
*/
|
|
603
|
-
async
|
|
604
|
-
return this.request("
|
|
654
|
+
async DescribeStaticStore(req, cb) {
|
|
655
|
+
return this.request("DescribeStaticStore", req, cb);
|
|
605
656
|
}
|
|
606
657
|
/**
|
|
607
|
-
*
|
|
658
|
+
* 本接口(UpdateTable)用于修改文档型数据库表信息，当前可以支持创建和删除索引。
|
|
608
659
|
*/
|
|
609
|
-
async
|
|
610
|
-
return this.request("
|
|
660
|
+
async UpdateTable(req, cb) {
|
|
661
|
+
return this.request("UpdateTable", req, cb);
|
|
611
662
|
}
|
|
612
663
|
/**
|
|
613
|
-
|
|
664
|
+
* 本接口用于变更云开发环境套餐。
|
|
665
|
+
该接口会自动下单并支付，会在腾讯云账户中扣除余额（余额不足会下单失败）。
|
|
666
|
+
该接口支持自动扣除代金券（AutoVoucher=true时），符合条件的代金券会被自动扣除。
|
|
667
|
+
*/
|
|
668
|
+
async ModifyEnvPlan(req, cb) {
|
|
669
|
+
return this.request("ModifyEnvPlan", req, cb);
|
|
670
|
+
}
|
|
671
|
+
/**
|
|
672
|
+
* 本接口（PushPGUserMigrations）用于批量应用Migrations。
|
|
614
673
|
*/
|
|
615
|
-
async
|
|
616
|
-
return this.request("
|
|
674
|
+
async PushPGUserMigrations(req, cb) {
|
|
675
|
+
return this.request("PushPGUserMigrations", req, cb);
|
|
617
676
|
}
|
|
618
677
|
/**
|
|
619
|
-
*
|
|
678
|
+
* 搜索用户调用日志
|
|
620
679
|
*/
|
|
621
|
-
async
|
|
622
|
-
return this.request("
|
|
680
|
+
async SearchClsLog(req, cb) {
|
|
681
|
+
return this.request("SearchClsLog", req, cb);
|
|
623
682
|
}
|
|
624
683
|
/**
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
调用该接口前需要先查询Mysql是否开通，可通过 [DescribeCreateMySQLResult ](https://cloud.tencent.com/document/api/876/128185) 查询，只有开通成功才能操作。
|
|
630
|
-
*/
|
|
631
|
-
async RunSql(req, cb) {
|
|
632
|
-
return this.request("RunSql", req, cb);
|
|
684
|
+
* 查询指定指标的配额使用量
|
|
685
|
+
*/
|
|
686
|
+
async DescribeQuotaData(req, cb) {
|
|
687
|
+
return this.request("DescribeQuotaData", req, cb);
|
|
633
688
|
}
|
|
634
689
|
/**
|
|
635
|
-
*
|
|
690
|
+
* 本接口（RollbackPGUserMigrations）用于按最近 N 条已应用 migration 倒序执行 rollback。
|
|
636
691
|
*/
|
|
637
|
-
async
|
|
638
|
-
return this.request("
|
|
692
|
+
async RollbackPGUserMigrations(req, cb) {
|
|
693
|
+
return this.request("RollbackPGUserMigrations", req, cb);
|
|
639
694
|
}
|
|
640
695
|
/**
|
|
641
|
-
*
|
|
696
|
+
* 修改tcb用户
|
|
642
697
|
*/
|
|
643
|
-
async
|
|
644
|
-
return this.request("
|
|
698
|
+
async ModifyUser(req, cb) {
|
|
699
|
+
return this.request("ModifyUser", req, cb);
|
|
645
700
|
}
|
|
646
701
|
/**
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
async AddProvider(req, cb) {
|
|
652
|
-
return this.request("AddProvider", req, cb);
|
|
702
|
+
* 更新环境信息
|
|
703
|
+
*/
|
|
704
|
+
async ModifyEnv(req, cb) {
|
|
705
|
+
return this.request("ModifyEnv", req, cb);
|
|
653
706
|
}
|
|
654
707
|
/**
|
|
655
|
-
*
|
|
708
|
+
* 云服务器规格list
|
|
656
709
|
*/
|
|
657
|
-
async
|
|
658
|
-
return this.request("
|
|
710
|
+
async DescribeVmSpec(req, cb) {
|
|
711
|
+
return this.request("DescribeVmSpec", req, cb);
|
|
659
712
|
}
|
|
660
713
|
/**
|
|
661
|
-
*
|
|
662
|
-
|
|
663
|
-
该接口跟 [DescribeTables](https://cloud.tencent.com/document/api/876/127962) 接口功能一致，后续该接口可能会下线，请使用 [DescribeTable](https://cloud.tencent.com/document/api/876/127962)接口。
|
|
714
|
+
* 修改指定云开发环境的登录策略配置。支持开启或关闭手机号短信登录、邮箱登录、用户名密码登录和匿名登录，同时可配置短信验证码发送通道、MFA 多因子认证和密码更新策略。
|
|
715
|
+
修改后立即生效，影响该环境下所有终端用户的登录行为。
|
|
664
716
|
*/
|
|
665
|
-
async
|
|
666
|
-
return this.request("
|
|
717
|
+
async ModifyLoginConfig(req, cb) {
|
|
718
|
+
return this.request("ModifyLoginConfig", req, cb);
|
|
667
719
|
}
|
|
668
720
|
}
|
|
669
721
|
exports.Client = Client;
|