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.
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
|
|
2
|
-
import { DescribeEnvLimitResponse,
|
|
2
|
+
import { DescribeEnvLimitResponse, DescribeResourcePermissionResponse, BindStorageSourceRequest, CheckTcbServiceResponse, GetProvidersRequest, DescribeCloudBaseRunServerVersionRequest, CreateVmInstanceResponse, ModifyEnvPlanRequest, AddProviderRequest, ModifyClsTopicResponse, DeleteProviderResponse, DescribeMySQLClusterDetailResponse, ModifyStorageSourceResponse, CreateVmInstanceRequest, DescribeEnvsRequest, ModifyUserResponse, DescribeEnvLimitRequest, DescribeCloudBaseBuildServiceResponse, DescribeMySQLTaskStatusRequest, RepairPGUserMigrationHistoryResponse, RepairPGUserMigrationHistoryRequest, AllocateEnvResponse, ModifyEnvResponse, ReleaseEnvResponse, DescribeHTTPServiceRouteRequest, DescribeCurveDataResponse, DescribeBaasPackageListRequest, DescribeAuthDomainsResponse, ModifyClsTopicRequest, DescribeLoginConfigRequest, CreateHTTPServiceRouteRequest, CreateHostingDomainRequest, UnbindStorageSourceResponse, DescribePGUserMigrationResponse, ModifyLoginConfigRequest, ModifyDatabaseACLRequest, DescribeCloudBaseRunServerVersionResponse, DeleteVmInstanceResponse, DescribeGatewayVersionsResponse, DescribeGatewayVersionsRequest, CreateEnvResourceRequest, DescribeVmInstancesRequest, DescribeHostingDomainTaskRequest, ModifyHTTPServiceRouteRequest, DescribeQuotaDataResponse, CreateBillDealResponse, DestroyMySQLResponse, DescribeHTTPServiceRouteResponse, ModifySafeRuleRequest, AllocateEnvRequest, CreateEnvResponse, RunCommandsResponse, DescribeTablesRequest, DescribeApiKeyListResponse, DeleteAIModelResponse, ExecutePGSqlResponse, CreateUserResponse, DescribeEnvAccountCircleRequest, CreateBillDealRequest, RenewEnvResponse, DescribeMySQLClusterDetailRequest, CreateStaticStoreRequest, DescribeBillingInfoResponse, CreateAuthDomainResponse, DeleteApiKeyResponse, DestroyStaticStoreRequest, UpdateAIModelRequest, RenewEnvRequest, DescribeClientResponse, DeleteHTTPServiceRouteResponse, UpdateTableResponse, UpdateAIModelResponse, ListPGUserMigrationsRequest, ModifyEnvPlanResponse, CreateCustomLoginKeyRequest, RunSqlRequest, CreateAIModelResponse, DescribeCreateMySQLResultRequest, ListPGUserMigrationsResponse, DescribeBillingInfoRequest, UnbindStorageSourceRequest, DestroyStaticStoreResponse, DeleteVmInstanceRequest, DescribeUserListResponse, CreateTableRequest, CreateMySQLResponse, ModifyResourcePermissionRequest, DeleteAuthDomainResponse, DeleteApiKeyRequest, ModifyProviderRequest, DeleteTableRequest, DestroyEnvRequest, DestroyEnvResponse, DeleteTableResponse, AddProviderResponse, DestroyMySQLRequest, DescribeEnvsResponse, ListTablesRequest, CreateAuthDomainRequest, CreateHostingDomainResponse, ModifyResourcePermissionResponse, DescribeCreateMySQLResultResponse, DescribeSafeRuleRequest, ModifyUserRequest, DeleteUsersRequest, DescribeBaasPackageListResponse, SearchClsLogResponse, DescribeSafeRuleResponse, DescribeApiKeyListRequest, DescribeStaticStoreRequest, AssumeRoleForAllocatedEnvResponse, DescribeTablesResponse, DescribeEnvAccountCircleResponse, ModifyDatabaseACLResponse, CreateTableResponse, PreviewPGUserMigrationsResponse, ReleaseEnvRequest, PreviewPGUserMigrationsRequest, CreateMySQLRequest, CreateUserRequest, CreateApiKeyResponse, DescribeMySQLTaskStatusResponse, AssumeRoleForAllocatedEnvRequest, CreateAIModelRequest, DescribeLoginConfigResponse, DeleteAIModelRequest, CreateEnvResourceResponse, DescribeUserListRequest, DescribeCurveDataRequest, DescribeStaticStoreResponse, DescribeResourcePermissionRequest, ModifyHTTPServiceRouteResponse, GetProvidersResponse, DescribeQuotaDataRequest, CreateStaticStoreResponse, PushPGUserMigrationsRequest, DescribePGUserMigrationRequest, DescribeVmInstancesResponse, RollbackPGUserMigrationsResponse, ModifySafeRuleResponse, ModifyClientResponse, DescribeTableRequest, UpdateTableRequest, RollbackPGUserMigrationsRequest, RunSqlResponse, DescribeClientRequest, DescribeHostingDomainTaskResponse, DeleteAuthDomainRequest, CreateHTTPServiceRouteResponse, CreateCustomLoginKeyResponse, ListTablesResponse, ModifyClientRequest, DeleteUsersResponse, DescribeCloudBaseBuildServiceRequest, SearchClsLogRequest, InquireVmPriceRequest, CheckTcbServiceRequest, DescribeManagedAIModelListResponse, DescribeAIModelsResponse, CreateEnvRequest, DeleteHTTPServiceRouteRequest, RunCommandsRequest, DescribeAuthDomainsRequest, DescribeVmSpecResponse, DescribeAIModelsRequest, DescribeTableResponse, ModifyStorageSourceRequest, DescribeDatabaseACLRequest, ExecutePGSqlRequest, DescribeDatabaseACLResponse, DeleteProviderRequest, DescribeVmSpecRequest, PushPGUserMigrationsResponse, BindStorageSourceResponse, ModifyProviderResponse, ModifyEnvRequest, DescribeManagedAIModelListRequest, InquireVmPriceResponse, ModifyLoginConfigResponse, CreateApiKeyRequest } from "./tcb_models";
|
|
3
3
|
/**
|
|
4
4
|
* tcb client
|
|
5
5
|
* @class
|
|
@@ -7,68 +7,133 @@ import { DescribeEnvLimitResponse, ListTablesResponse, BindStorageSourceRequest,
|
|
|
7
7
|
export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
8
8
|
constructor(clientConfig: TencentCloudCommon.ClientConfig);
|
|
9
9
|
/**
|
|
10
|
-
|
|
10
|
+
* 从环境池里立即取出1个环境
|
|
11
|
+
*/
|
|
12
|
+
ReleaseEnv(req: ReleaseEnvRequest, cb?: (error: string, rep: ReleaseEnvResponse) => void): Promise<ReleaseEnvResponse>;
|
|
13
|
+
/**
|
|
14
|
+
* 查询 API Key 列表。分页查询指定云开发环境下的 API Key 访问凭证列表。支持按类型过滤（api_key 或 publish_key）。未指定类型时，默认仅返回 api_key 类型的记录。列表查询中 api_key 类型的令牌值将进行脱敏处理（仅保留前后各 6 位字符）；publish_key 类型始终返回完整明文。接口需要管理员权限。
|
|
15
|
+
*/
|
|
16
|
+
DescribeApiKeyList(req: DescribeApiKeyListRequest, cb?: (error: string, rep: DescribeApiKeyListResponse) => void): Promise<DescribeApiKeyListResponse>;
|
|
17
|
+
/**
|
|
18
|
+
* 查询指定云开发环境下已配置的 AI 模型分组列表。返回结果包含该环境下所有类型的模型分组（自定义类型 custom、内置类型 builtin），以及各分组下的模型列表、服务地址、启用状态等配置信息。
|
|
11
19
|
|
|
12
|
-
|
|
13
|
-
|
|
20
|
+
通常在以下场景中使用：
|
|
21
|
+
|
|
22
|
+
控制台展示：在云开发控制台 AI+ 功能 → 模型管理页面，展示当前环境已配置的模型分组列表。
|
|
23
|
+
|
|
24
|
+
模型管理：在调用 [UpdateAIModel]() 或 [DeleteAIModel]() 接口前，通过本接口查询当前分组配置。
|
|
25
|
+
|
|
26
|
+
业务集成：开发者查询可用模型列表，用于选择合适的模型接入 AI+ 功能。
|
|
14
27
|
*/
|
|
15
|
-
|
|
28
|
+
DescribeAIModels(req: DescribeAIModelsRequest, cb?: (error: string, rep: DescribeAIModelsResponse) => void): Promise<DescribeAIModelsResponse>;
|
|
16
29
|
/**
|
|
17
|
-
*
|
|
18
|
-
|
|
19
|
-
|
|
30
|
+
* **创建环境日志资源**
|
|
31
|
+
|
|
32
|
+
环境开通后，若用户需要开启检索日志功能，需调用此接口进行日志资源的开通。
|
|
33
|
+
|
|
34
|
+
> **注意**：日志资源的开通为**异步操作**，接口调用成功后并不代表日志资源已立即可用。
|
|
35
|
+
|
|
36
|
+
**如何确认日志开通状态：**
|
|
37
|
+
|
|
38
|
+
可通过 [DescribeEnvs](https://cloud.tencent.com/document/product/876/34820) 接口轮询查询日志开通结果，建议每 5 秒轮询一次，最长等待 5 分钟。在返回的数据结构 [EnvInfo](https://cloud.tencent.com/document/api/876/34822#EnvInfo) 中，检查 `LogServices` 字段下 `LogServiceInfo` 是否包含有效的日志主题（Topic）等相关信息，以此判断日志资源是否已成功开通：
|
|
39
|
+
|
|
40
|
+
- **已开通**：`LogServiceInfo` 中存在日志主题 ID 等有效信息
|
|
41
|
+
- **未开通 / 开通中**：`LogServiceInfo` 为空或相关字段缺失
|
|
20
42
|
*/
|
|
21
|
-
|
|
43
|
+
CreateEnvResource(req: CreateEnvResourceRequest, cb?: (error: string, rep: CreateEnvResourceResponse) => void): Promise<CreateEnvResourceResponse>;
|
|
22
44
|
/**
|
|
23
|
-
*
|
|
24
|
-
|
|
45
|
+
* 创建 AI 模型配置分组。云开发标准版及以上套餐才可使用
|
|
46
|
+
|
|
47
|
+
支持自定义类型（custom）：用户自行提供模型服务地址（baseUrl）和访问密钥，分组名可自由命名，适用于接入第三方或自建模型服务。
|
|
48
|
+
|
|
49
|
+
注意：内置类型（builtin）分组由云开发平台统一创建和管理，不支持通过此接口创建。如需修改内置分组的模型列表或启用状态，请使用 [UpdateAIModel](https://cloud.tencent.com/document/product/876/131316) 接口。
|
|
50
|
+
|
|
51
|
+
创建成功后，可通过 [DescribeAIModels](https://cloud.tencent.com/document/product/876/131318) 接口查询分组信息，并在云开发 AI+ 功能中使用所配置的模型。
|
|
25
52
|
*/
|
|
26
|
-
|
|
53
|
+
CreateAIModel(req: CreateAIModelRequest, cb?: (error: string, rep: CreateAIModelResponse) => void): Promise<CreateAIModelResponse>;
|
|
27
54
|
/**
|
|
28
|
-
|
|
55
|
+
* 修改客户端配置。采用增量更新策略，仅更新请求中传入的非空字段，未传入的字段保持原值不变。支持修改客户端基本信息（名称、图标、描述、主页地址）、安全域名、允许的 Scope 列表、Token 有效期、会话控制策略及启用状态等配置。
|
|
56
|
+
Id、Secret、CreatedAt、Meta 等字段在该接口中不可修改，当客户端 ID 等于环境 ID 且客户端尚未创建时，将自动创建默认客户端配置。
|
|
57
|
+
*/
|
|
58
|
+
ModifyClient(req: ModifyClientRequest, cb?: (error: string, rep: ModifyClientResponse) => void): Promise<ModifyClientResponse>;
|
|
59
|
+
/**
|
|
60
|
+
* 查询客户端详情。获取指定云开发环境下某个客户端的配置信息，包括客户端基本信息（名称、图标、描述）、OAuth 凭证（ClientId、ClientSecret）、安全域名、允许的 Scope 列表、Token 有效期、会话控制策略等。当客户端 ID 等于环境 ID 时，返回该环境的默认客户端配置。
|
|
29
61
|
*/
|
|
30
|
-
|
|
62
|
+
DescribeClient(req: DescribeClientRequest, cb?: (error: string, rep: DescribeClientResponse) => void): Promise<DescribeClientResponse>;
|
|
31
63
|
/**
|
|
32
|
-
*
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
"private_key_id": "<返回的 KeyID>",
|
|
36
|
-
"private_key": "<返回的 PrivateKey>",
|
|
37
|
-
"env_id": "<请求时传入的 EnvId>"
|
|
38
|
-
}
|
|
64
|
+
* 修改资源基础权限。
|
|
65
|
+
|
|
66
|
+
修改云函数、云存储和数据库表的基础权限配置。支持预定义权限级别和自定义安全规则两种方式配置资源访问权限。
|
|
39
67
|
*/
|
|
40
|
-
|
|
68
|
+
ModifyResourcePermission(req: ModifyResourcePermissionRequest, cb?: (error: string, rep: ModifyResourcePermissionResponse) => void): Promise<ModifyResourcePermissionResponse>;
|
|
41
69
|
/**
|
|
42
|
-
*
|
|
70
|
+
* 获取新套餐列表，含详情，如果传了PackageId，则只获取指定套餐详情
|
|
43
71
|
*/
|
|
44
|
-
|
|
72
|
+
DescribeBaasPackageList(req: DescribeBaasPackageListRequest, cb?: (error: string, rep: DescribeBaasPackageListResponse) => void): Promise<DescribeBaasPackageListResponse>;
|
|
45
73
|
/**
|
|
46
|
-
*
|
|
47
|
-
|
|
48
|
-
托管类型模型由云开发平台统一接入和管理，用户无需自行配置模型服务地址和访问密钥，开通后即可直接使用。返回结果按模型分组（Group）组织，包含各模型的规格参数（ModelSpec）和计费信息（ModelChargingInfo）。
|
|
49
|
-
|
|
50
|
-
通常在以下场景中使用：
|
|
74
|
+
* 从指定云开发环境中解绑已绑定的外部云存储源。解绑后，该环境将不再关联外部 存储源，云存储功能恢复为未绑定状态。
|
|
75
|
+
解绑操作仅移除 CloudBase 侧的绑定关系，不会删除桶本身及桶内数据，桶仍由用户自行管理。
|
|
51
76
|
|
|
52
|
-
|
|
77
|
+
注意⚠️
|
|
78
|
+
解绑之后，会导致云存储不可用，请谨慎操作。
|
|
53
79
|
*/
|
|
54
|
-
|
|
80
|
+
UnbindStorageSource(req: UnbindStorageSourceRequest, cb?: (error: string, rep: UnbindStorageSourceResponse) => void): Promise<UnbindStorageSourceResponse>;
|
|
55
81
|
/**
|
|
56
|
-
*
|
|
82
|
+
* 删除tcb用户
|
|
57
83
|
*/
|
|
58
|
-
|
|
84
|
+
DeleteUsers(req: DeleteUsersRequest, cb?: (error: string, rep: DeleteUsersResponse) => void): Promise<DeleteUsersResponse>;
|
|
59
85
|
/**
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
86
|
+
* 本接口（ListPGUserMigrations）用于查询目标环境已应用的用户 migration 列表。
|
|
87
|
+
*/
|
|
88
|
+
ListPGUserMigrations(req: ListPGUserMigrationsRequest, cb?: (error: string, rep: ListPGUserMigrationsResponse) => void): Promise<ListPGUserMigrationsResponse>;
|
|
89
|
+
/**
|
|
90
|
+
* 检查是否开通Tcb服务
|
|
91
|
+
*/
|
|
92
|
+
CheckTcbService(req?: CheckTcbServiceRequest, cb?: (error: string, rep: CheckTcbServiceResponse) => void): Promise<CheckTcbServiceResponse>;
|
|
93
|
+
/**
|
|
94
|
+
* 添加身份认证源。在指定云开发环境下创建一个新的身份认证源，支持 OAuth 2.0、OIDC、SAML 2.0 等标准协议，以及自定义登录和邮箱登录等多种认证方式。
|
|
95
|
+
创建时需指定身份源协议类型（ProviderType）并配置对应的协议连接参数（Config）。若身份源 ID 已存在将返回错误。
|
|
96
|
+
限制：一个环境最大可允许加入20个认证源。
|
|
70
97
|
*/
|
|
71
|
-
|
|
98
|
+
AddProvider(req: AddProviderRequest, cb?: (error: string, rep: AddProviderResponse) => void): Promise<AddProviderResponse>;
|
|
99
|
+
/**
|
|
100
|
+
* 获取云托管代码上传url
|
|
101
|
+
*/
|
|
102
|
+
DescribeCloudBaseBuildService(req: DescribeCloudBaseBuildServiceRequest, cb?: (error: string, rep: DescribeCloudBaseBuildServiceResponse) => void): Promise<DescribeCloudBaseBuildServiceResponse>;
|
|
103
|
+
/**
|
|
104
|
+
* 销毁云服务器实例
|
|
105
|
+
*/
|
|
106
|
+
DeleteVmInstance(req: DeleteVmInstanceRequest, cb?: (error: string, rep: DeleteVmInstanceResponse) => void): Promise<DeleteVmInstanceResponse>;
|
|
107
|
+
/**
|
|
108
|
+
* 创建tcb用户
|
|
109
|
+
*/
|
|
110
|
+
CreateUser(req: CreateUserRequest, cb?: (error: string, rep: CreateUserResponse) => void): Promise<CreateUserResponse>;
|
|
111
|
+
/**
|
|
112
|
+
* 创建静态托管资源，包括COS和CDN，异步任务创建，查看创建结果需要根据DescribeStaticStore接口来查看
|
|
113
|
+
*/
|
|
114
|
+
CreateStaticStore(req: CreateStaticStoreRequest, cb?: (error: string, rep: CreateStaticStoreResponse) => void): Promise<CreateStaticStoreResponse>;
|
|
115
|
+
/**
|
|
116
|
+
* 本接口(DescribeTables)用于查询文档型数据库所有表信息，包括表名、表中数据条数、表中数据量、索引个数及索引的大小等。
|
|
117
|
+
*/
|
|
118
|
+
DescribeTables(req: DescribeTablesRequest, cb?: (error: string, rep: DescribeTablesResponse) => void): Promise<DescribeTablesResponse>;
|
|
119
|
+
/**
|
|
120
|
+
* 为云存储绑定外部云存储源。
|
|
121
|
+
将一个用户自有的 COS桶 作为外部存储源绑定到指定云开发环境的云存储。绑定后，该环境的云存储文件操作将指向此桶，通过 BasePath 路径前缀实现与其他环境的数据隔离。
|
|
122
|
+
每个环境仅允许绑定 1 个外部云存储源。
|
|
123
|
+
*/
|
|
124
|
+
BindStorageSource(req: BindStorageSourceRequest, cb?: (error: string, rep: BindStorageSourceResponse) => void): Promise<BindStorageSourceResponse>;
|
|
125
|
+
/**
|
|
126
|
+
* 修改日志主题
|
|
127
|
+
*/
|
|
128
|
+
ModifyClsTopic(req: ModifyClsTopicRequest, cb?: (error: string, rep: ModifyClsTopicResponse) => void): Promise<ModifyClsTopicResponse>;
|
|
129
|
+
/**
|
|
130
|
+
* 查询tcb用户列表
|
|
131
|
+
*/
|
|
132
|
+
DescribeUserList(req: DescribeUserListRequest, cb?: (error: string, rep: DescribeUserListResponse) => void): Promise<DescribeUserListResponse>;
|
|
133
|
+
/**
|
|
134
|
+
* 查询静态托管域名任务状态
|
|
135
|
+
*/
|
|
136
|
+
DescribeHostingDomainTask(req: DescribeHostingDomainTaskRequest, cb?: (error: string, rep: DescribeHostingDomainTaskResponse) => void): Promise<DescribeHostingDomainTaskResponse>;
|
|
72
137
|
/**
|
|
73
138
|
* 本接口（CreateMySQL）用于开通Mysql型数据库。
|
|
74
139
|
|
|
@@ -76,58 +141,153 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
76
141
|
*/
|
|
77
142
|
CreateMySQL(req: CreateMySQLRequest, cb?: (error: string, rep: CreateMySQLResponse) => void): Promise<CreateMySQLResponse>;
|
|
78
143
|
/**
|
|
79
|
-
|
|
144
|
+
* 本接口用于购买云开发环境。
|
|
145
|
+
该接口会自动下单并支付，会在腾讯云账户中扣除余额（余额不足会下单失败）。
|
|
146
|
+
该接口支持自动扣除代金券（AutoVoucher=true时），符合条件的代金券会被自动扣除。
|
|
147
|
+
环境下单成功之后会返回EnvId。EnvId是全局唯一表示。
|
|
148
|
+
环境发货是异步行为，后续可以通过接口 [DescribeEnvs ](https://cloud.tencent.com/document/product/876/34820) 查询环境状态和各项资源信息；通过 [DescribeBillingInfo](https://cloud.tencent.com/document/product/876/94390) 查询环境套餐信息，包括 到期时间、当前套餐等。
|
|
149
|
+
*/
|
|
150
|
+
CreateEnv(req: CreateEnvRequest, cb?: (error: string, rep: CreateEnvResponse) => void): Promise<CreateEnvResponse>;
|
|
151
|
+
/**
|
|
152
|
+
* 本接口（RunCommands）用于执行文档型数据库命令。
|
|
80
153
|
*/
|
|
81
|
-
|
|
154
|
+
RunCommands(req: RunCommandsRequest, cb?: (error: string, rep: RunCommandsResponse) => void): Promise<RunCommandsResponse>;
|
|
82
155
|
/**
|
|
83
|
-
*
|
|
156
|
+
* 查询环境下的云服务器列表
|
|
84
157
|
*/
|
|
85
|
-
|
|
158
|
+
DescribeVmInstances(req: DescribeVmInstancesRequest, cb?: (error: string, rep: DescribeVmInstancesResponse) => void): Promise<DescribeVmInstancesResponse>;
|
|
86
159
|
/**
|
|
87
|
-
*
|
|
88
|
-
|
|
89
|
-
|
|
160
|
+
* 增加安全域名。
|
|
161
|
+
云开发会校验网页应用请求的来源域名，您需要将来源域名加入到WEB安全域名列表中。
|
|
162
|
+
可以通过接口 [DescribeAuthDomains](https://cloud.tencent.com/document/product/876/42151) 获取当前已绑定生效的安全域名。
|
|
90
163
|
|
|
91
|
-
|
|
164
|
+
注意⚠️
|
|
165
|
+
安全域名绑定成功之后，需要几分钟时间逐步生效。
|
|
166
|
+
*/
|
|
167
|
+
CreateAuthDomain(req: CreateAuthDomainRequest, cb?: (error: string, rep: CreateAuthDomainResponse) => void): Promise<CreateAuthDomainResponse>;
|
|
168
|
+
/**
|
|
169
|
+
* 修改身份认证源。更新指定云开发环境下已有身份认证源的配置信息，支持修改基本信息（名称、图标、描述）、协议连接配置（ClientId、ClientSecret、端点地址等）、登录行为控制（透传模式、自动注册、邮箱/手机号自动关联）以及启用状态。
|
|
170
|
+
对于 OIDC 类型身份源，修改 Issuer 后将自动通过 OpenID Connect Discovery 重新获取端点配置。
|
|
171
|
+
若自定义登录（CUSTOM）或邮箱登录（EMAIL）身份源尚不存在，调用该接口时将自动创建。
|
|
172
|
+
*/
|
|
173
|
+
ModifyProvider(req: ModifyProviderRequest, cb?: (error: string, rep: ModifyProviderResponse) => void): Promise<ModifyProviderResponse>;
|
|
174
|
+
/**
|
|
175
|
+
* 删除合法域名。
|
|
176
|
+
云开发会校验网页应用请求的来源域名，您需要将来源域名加入到WEB安全域名列表中。
|
|
177
|
+
可以通过接口 [DescribeAuthDomains](https://cloud.tencent.com/document/product/876/42151) 获取当前已绑定生效的安全域名，将对应安全域名的id填入Domainlds中
|
|
92
178
|
|
|
93
|
-
|
|
179
|
+
注意⚠️
|
|
180
|
+
安全域名被删除之后，可能会引起跨域问题，请谨慎操作。
|
|
94
181
|
*/
|
|
95
|
-
|
|
182
|
+
DeleteAuthDomain(req: DeleteAuthDomainRequest, cb?: (error: string, rep: DeleteAuthDomainResponse) => void): Promise<DeleteAuthDomainResponse>;
|
|
96
183
|
/**
|
|
97
|
-
*
|
|
184
|
+
* 本接口DescribeHTTPServiceRoute用于查询环境下HTTP访问服务路由信息。可通过Filters过滤。如果不存在不会返回错误。HTTP访问服务提供了默认域名，通过本接口可直接获取默认域名。
|
|
98
185
|
*/
|
|
99
|
-
|
|
186
|
+
DescribeHTTPServiceRoute(req: DescribeHTTPServiceRouteRequest, cb?: (error: string, rep: DescribeHTTPServiceRouteResponse) => void): Promise<DescribeHTTPServiceRouteResponse>;
|
|
100
187
|
/**
|
|
101
|
-
* 本接口
|
|
188
|
+
* 本接口ModifyHTTPServiceRoute用于修改HTTP访问服务路由。支持增量修改，对应字段不传参数则不修改
|
|
102
189
|
*/
|
|
103
|
-
|
|
190
|
+
ModifyHTTPServiceRoute(req: ModifyHTTPServiceRouteRequest, cb?: (error: string, rep: ModifyHTTPServiceRouteResponse) => void): Promise<ModifyHTTPServiceRouteResponse>;
|
|
104
191
|
/**
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
192
|
+
* 查询指定云开发环境的登录策略配置。包括手机号短信登录、邮箱登录、用户名密码登录和匿名登录方式的开启状态，同时包含短信验证码发送通道、MFA 多因子认证和密码的更新策略。
|
|
193
|
+
*/
|
|
194
|
+
DescribeLoginConfig(req: DescribeLoginConfigRequest, cb?: (error: string, rep: DescribeLoginConfigResponse) => void): Promise<DescribeLoginConfigResponse>;
|
|
195
|
+
/**
|
|
196
|
+
* 删除认证源
|
|
197
|
+
*/
|
|
198
|
+
DeleteProvider(req: DeleteProviderRequest, cb?: (error: string, rep: DeleteProviderResponse) => void): Promise<DeleteProviderResponse>;
|
|
199
|
+
/**
|
|
200
|
+
* 创建云开发平台的API Key。在指定云开发环境下创建一个 API Key 访问凭证。支持两种类型：api_key（服务端管理员访问凭证，以管理员身份签发，可设置有效期，不设置有效期则永不过期，单个环境最多创建 5 个）和 publish_key（前端匿名访问凭证，固定有效期，每个环境仅保留一个）。创建成功后将返回 API Key 明文 Token，该值仅在创建时返回一次，请妥善保存。需要管理员权限。
|
|
201
|
+
权限范围与注意事项：
|
|
202
|
+
- api_key 是以"管理员身份"签发的访问凭证，持有该 Token 即拥有腾讯云云开发数据流（含数据库、云函数、云存储、托管等）资源的完整访问与操作权限。该凭证不区分子资源粒度，一旦泄露等同于环境管理员权限被泄露，请按"高敏感凭证"管理： 仅用于服务端调用、严禁下发到前端/客户端、严禁写入代码仓库或日志、定期轮换并回收闲置凭证。
|
|
203
|
+
- 在为子账号 / 协作者 / RAM 子用户授权该接口权限时，须先评估该子账号是否有资格获得该环境的管理员级数据流权限，能创建 api_key ≈ 能拥有环境管理员权限。
|
|
204
|
+
*/
|
|
205
|
+
CreateApiKey(req: CreateApiKeyRequest, cb?: (error: string, rep: CreateApiKeyResponse) => void): Promise<CreateApiKeyResponse>;
|
|
206
|
+
/**
|
|
207
|
+
* 查询数据库安全规则。
|
|
208
|
+
安全规则，用于控制C端用户的访问权限。详见 [安全规则介绍](https://cloud.tencent.com/document/product/876/123478) 。
|
|
209
|
+
*/
|
|
210
|
+
DescribeSafeRule(req: DescribeSafeRuleRequest, cb?: (error: string, rep: DescribeSafeRuleResponse) => void): Promise<DescribeSafeRuleResponse>;
|
|
211
|
+
/**
|
|
212
|
+
* 本接口（DescribeMySQLTaskStatus）用于查询Mysql任务状态。
|
|
213
|
+
*/
|
|
214
|
+
DescribeMySQLTaskStatus(req: DescribeMySQLTaskStatusRequest, cb?: (error: string, rep: DescribeMySQLTaskStatusResponse) => void): Promise<DescribeMySQLTaskStatusResponse>;
|
|
215
|
+
/**
|
|
216
|
+
* 本接口（RunSql）用于执行MySQL语句。
|
|
110
217
|
|
|
111
|
-
|
|
218
|
+
该接口用来执行 MySql 语句，比如创建表格、插入数据、修改数据、删除字段、添加索引等可以通过sql 语句实现的都可以使用该接口。
|
|
112
219
|
|
|
113
|
-
|
|
220
|
+
调用该接口前需要先查询Mysql是否开通，可通过 [DescribeCreateMySQLResult ](https://cloud.tencent.com/document/api/876/128185) 查询，只有开通成功才能操作。
|
|
221
|
+
*/
|
|
222
|
+
RunSql(req: RunSqlRequest, cb?: (error: string, rep: RunSqlResponse) => void): Promise<RunSqlResponse>;
|
|
223
|
+
/**
|
|
224
|
+
* 查询指定云开发环境下的身份认证源列表。返回该环境已配置的所有身份认证源信息，包括第三方登录（OAuth、OIDC、SAML）、微信小程序登录、自定义登录和邮箱登录等。返回结果包含认证源基本信息、关联应用、配置状态及启用情况。若自定义登录或邮箱登录的身份源尚未创建，接口会自动追加一个默认关闭状态的身份源记录。
|
|
225
|
+
*/
|
|
226
|
+
GetProviders(req: GetProvidersRequest, cb?: (error: string, rep: GetProvidersResponse) => void): Promise<GetProvidersResponse>;
|
|
227
|
+
/**
|
|
228
|
+
* 修改指定云开发环境已绑定的外部云存储源配置。
|
|
229
|
+
修改之后，大约3~5分钟生效。
|
|
114
230
|
|
|
115
|
-
|
|
116
|
-
|
|
231
|
+
注意⚠️
|
|
232
|
+
本接口仅更新存储源绑定关系，不会迁移您的数据。
|
|
117
233
|
*/
|
|
118
|
-
|
|
234
|
+
ModifyStorageSource(req: ModifyStorageSourceRequest, cb?: (error: string, rep: ModifyStorageSourceResponse) => void): Promise<ModifyStorageSourceResponse>;
|
|
119
235
|
/**
|
|
120
|
-
*
|
|
121
|
-
|
|
236
|
+
* 创建云开发产品计费订单，用于以下几种场景：
|
|
237
|
+
1. 购买云开发环境
|
|
238
|
+
2. 续费云开发环境
|
|
239
|
+
3. 变更云开发环境套餐
|
|
240
|
+
4. 购买云开发资源包
|
|
241
|
+
5. 购买云开发大促包
|
|
242
|
+
|
|
243
|
+
该接口支持下单并支付(CreateAndPay=true时)，此时会自动在腾讯云账户中扣除余额（余额不足会下单失败）。
|
|
122
244
|
该接口支持自动扣除代金券（AutoVoucher=true时），符合条件的代金券会被自动扣除。
|
|
123
|
-
环境下单成功之后会返回EnvId。EnvId是全局唯一表示。
|
|
124
|
-
环境发货是异步行为，后续可以通过接口 [DescribeEnvs ](https://cloud.tencent.com/document/product/876/34820) 查询环境状态和各项资源信息；通过 [DescribeBillingInfo](https://cloud.tencent.com/document/product/876/94390) 查询环境套餐信息，包括 到期时间、当前套餐等。
|
|
125
245
|
*/
|
|
126
|
-
|
|
246
|
+
CreateBillDeal(req: CreateBillDealRequest, cb?: (error: string, rep: CreateBillDealResponse) => void): Promise<CreateBillDealResponse>;
|
|
247
|
+
/**
|
|
248
|
+
* 根据指定指标名称，查询某环境在指定时间范围内的监控数据，返回按统计粒度聚合后的时序数据。
|
|
249
|
+
*/
|
|
250
|
+
DescribeCurveData(req: DescribeCurveDataRequest, cb?: (error: string, rep: DescribeCurveDataResponse) => void): Promise<DescribeCurveDataResponse>;
|
|
127
251
|
/**
|
|
128
252
|
* 本接口（ModifyDatabaseACL）用于修改文档型数据库权限。
|
|
129
253
|
*/
|
|
130
254
|
ModifyDatabaseACL(req: ModifyDatabaseACLRequest, cb?: (error: string, rep: ModifyDatabaseACLResponse) => void): Promise<ModifyDatabaseACLResponse>;
|
|
255
|
+
/**
|
|
256
|
+
* 查询环境个数上限
|
|
257
|
+
*/
|
|
258
|
+
DescribeEnvLimit(req?: DescribeEnvLimitRequest, cb?: (error: string, rep: DescribeEnvLimitResponse) => void): Promise<DescribeEnvLimitResponse>;
|
|
259
|
+
/**
|
|
260
|
+
* 销毁静态托管资源，该接口创建异步销毁任务，资源最终状态可从DestroyStaticStore接口查看
|
|
261
|
+
*/
|
|
262
|
+
DestroyStaticStore(req: DestroyStaticStoreRequest, cb?: (error: string, rep: DestroyStaticStoreResponse) => void): Promise<DestroyStaticStoreResponse>;
|
|
263
|
+
/**
|
|
264
|
+
* 删除指定云开发环境下的某个 API Key 服务端访问凭证。删除后，该 API Key 对应的 Token 将被吊销，已使用该 Key 发起的请求将失败。该操作具有幂等性，若指定的 API Key 不存在则直接返回成功。需要管理员权限。
|
|
265
|
+
*/
|
|
266
|
+
DeleteApiKey(req: DeleteApiKeyRequest, cb?: (error: string, rep: DeleteApiKeyResponse) => void): Promise<DeleteApiKeyResponse>;
|
|
267
|
+
/**
|
|
268
|
+
* 本接口(ListTables)用于查询文档型数据库所有表信息，包括表名、表中数据条数、表中数据量、索引个数及索引的大小等。
|
|
269
|
+
|
|
270
|
+
该接口跟 [DescribeTables](https://cloud.tencent.com/document/api/876/127962) 接口功能一致，后续该接口可能会下线，请使用 [DescribeTable](https://cloud.tencent.com/document/api/876/127962)接口。
|
|
271
|
+
*/
|
|
272
|
+
ListTables(req: ListTablesRequest, cb?: (error: string, rep: ListTablesResponse) => void): Promise<ListTablesResponse>;
|
|
273
|
+
/**
|
|
274
|
+
* 本接口（DescribePGUserMigration）用于查询目标环境指定 migration 详情。
|
|
275
|
+
*/
|
|
276
|
+
DescribePGUserMigration(req: DescribePGUserMigrationRequest, cb?: (error: string, rep: DescribePGUserMigrationResponse) => void): Promise<DescribePGUserMigrationResponse>;
|
|
277
|
+
/**
|
|
278
|
+
* 查询云开发平台支持的托管类型 AI 模型列表。
|
|
279
|
+
|
|
280
|
+
托管类型模型由云开发平台统一接入和管理，用户无需自行配置模型服务地址和访问密钥，开通后即可直接使用。返回结果按模型分组（Group）组织，包含各模型的规格参数（ModelSpec）和计费信息（ModelChargingInfo）。
|
|
281
|
+
|
|
282
|
+
通常在以下场景中使用：
|
|
283
|
+
|
|
284
|
+
开通托管模型前：通过本接口查询平台支持的托管模型及其规格，结合 [UpdateAIModel](https://cloud.tencent.com/document/product/876/131316) 接口完成模型配置。
|
|
285
|
+
*/
|
|
286
|
+
DescribeManagedAIModelList(req: DescribeManagedAIModelListRequest, cb?: (error: string, rep: DescribeManagedAIModelListResponse) => void): Promise<DescribeManagedAIModelListResponse>;
|
|
287
|
+
/**
|
|
288
|
+
* 创建托管域名
|
|
289
|
+
*/
|
|
290
|
+
CreateHostingDomain(req: CreateHostingDomainRequest, cb?: (error: string, rep: CreateHostingDomainResponse) => void): Promise<CreateHostingDomainResponse>;
|
|
131
291
|
/**
|
|
132
292
|
* 创建虚拟服务器
|
|
133
293
|
创建流程为先调用[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)询价，如果价格可接受，调用此接口创建实例
|
|
@@ -138,70 +298,133 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
138
298
|
*/
|
|
139
299
|
DeleteHTTPServiceRoute(req: DeleteHTTPServiceRouteRequest, cb?: (error: string, rep: DeleteHTTPServiceRouteResponse) => void): Promise<DeleteHTTPServiceRouteResponse>;
|
|
140
300
|
/**
|
|
141
|
-
*
|
|
301
|
+
* 获取环境列表，含环境下的各个资源信息。尤其是各资源的唯一标识，是请求各资源的关键参数
|
|
142
302
|
*/
|
|
143
|
-
|
|
303
|
+
DescribeEnvs(req: DescribeEnvsRequest, cb?: (error: string, rep: DescribeEnvsResponse) => void): Promise<DescribeEnvsResponse>;
|
|
144
304
|
/**
|
|
145
|
-
*
|
|
305
|
+
* 查询服务版本的详情，CPU和MEM 请使用CPUSize和MemSize
|
|
146
306
|
*/
|
|
147
|
-
|
|
307
|
+
DescribeCloudBaseRunServerVersion(req: DescribeCloudBaseRunServerVersionRequest, cb?: (error: string, rep: DescribeCloudBaseRunServerVersionResponse) => void): Promise<DescribeCloudBaseRunServerVersionResponse>;
|
|
148
308
|
/**
|
|
149
|
-
*
|
|
309
|
+
* 设置数据库安全规则。
|
|
310
|
+
安全规则，用于控制C端用户的访问权限。详见 [安全规则介绍 ](https://cloud.tencent.com/document/product/876/123478)。
|
|
311
|
+
*/
|
|
312
|
+
ModifySafeRule(req: ModifySafeRuleRequest, cb?: (error: string, rep: ModifySafeRuleResponse) => void): Promise<ModifySafeRuleResponse>;
|
|
313
|
+
/**
|
|
314
|
+
* 本接口（DescribeTable）用于查询文档型数据库表的相关信息，包括索引等信息。
|
|
150
315
|
|
|
151
|
-
|
|
316
|
+
接口入参中的 Tag 为文档型数据库的实例 Id，可以通过 [DescribeEnvs](https://cloud.tencent.com/document/api/876/34820) 接口返回的 EnvList[0].Databases[0].InstanceId 获取。
|
|
317
|
+
*/
|
|
318
|
+
DescribeTable(req: DescribeTableRequest, cb?: (error: string, rep: DescribeTableResponse) => void): Promise<DescribeTableResponse>;
|
|
319
|
+
/**
|
|
320
|
+
* 本接口（RepairPGUserMigrationHistory）用于受控修复 history，只修改 user_schema_migrations，不执行 SQL。
|
|
321
|
+
*/
|
|
322
|
+
RepairPGUserMigrationHistory(req: RepairPGUserMigrationHistoryRequest, cb?: (error: string, rep: RepairPGUserMigrationHistoryResponse) => void): Promise<RepairPGUserMigrationHistoryResponse>;
|
|
323
|
+
/**
|
|
324
|
+
* 在Postgres数据库上执行SQL
|
|
325
|
+
*/
|
|
326
|
+
ExecutePGSql(req: ExecutePGSqlRequest, cb?: (error: string, rep: ExecutePGSqlResponse) => void): Promise<ExecutePGSqlResponse>;
|
|
327
|
+
/**
|
|
328
|
+
* 删除 AI 模型配置分组，支持批量删除。内置分组无法删除。分组删除后，该分组下的所有模型配置将同步移除，针对该分组模型的请求将会失败，请在删除前确认业务侧已停止对该分组的调用。
|
|
152
329
|
|
|
153
|
-
|
|
330
|
+
注意：
|
|
331
|
+
此操作不可逆，删除后数据无法恢复，请谨慎操作。
|
|
154
332
|
|
|
155
|
-
|
|
333
|
+
删除前建议通过 [DescribeAIModelList]() 接口确认分组当前状态。
|
|
334
|
+
*/
|
|
335
|
+
DeleteAIModel(req: DeleteAIModelRequest, cb?: (error: string, rep: DeleteAIModelResponse) => void): Promise<DeleteAIModelResponse>;
|
|
336
|
+
/**
|
|
337
|
+
* 本接口(DeleteTable)用于删除文档型数据库表，删除表后表中数据将会被删除且无法恢复，请谨慎操作。
|
|
156
338
|
|
|
157
|
-
|
|
339
|
+
接口入参中的 Tag 为文档型数据库的实例 Id，可以通过 [DescribeEnvs](https://cloud.tencent.com/document/api/876/34820) 接口返回的 EnvList[0].Databases[0].InstanceId 获取。
|
|
340
|
+
*/
|
|
341
|
+
DeleteTable(req: DeleteTableRequest, cb?: (error: string, rep: DeleteTableResponse) => void): Promise<DeleteTableResponse>;
|
|
342
|
+
/**
|
|
343
|
+
* 本接口用于销毁云开发环境。
|
|
344
|
+
云开发环境遵循腾讯云包年包月预付费产品生命周期，因此环境销毁需要分两步：
|
|
345
|
+
1. 资源退费。此时会根据当前环境剩余有效期，自动退还相关费用(代金券不退)。退款后，环境进入隔离期。
|
|
346
|
+
2. 环境删除。环境在进入隔离期后15天会自动删除。也可以通过本接口，指定 IsForce=true 来强制删除隔离期环境。
|
|
347
|
+
|
|
348
|
+
**注意**⚠️
|
|
349
|
+
1. 环境退费后进入隔离期，则所有资源均无法访问，控制台无法操作和管理。
|
|
350
|
+
2. 环境被彻底删除后，所有数据均无法找回。请谨慎操作。
|
|
351
|
+
|
|
352
|
+
可以通过接口 [tcb:DescribeBillingInfo](https://cloud.tencent.com/document/product/876/94390) 查询环境计费状态。
|
|
353
|
+
*/
|
|
354
|
+
DestroyEnv(req: DestroyEnvRequest, cb?: (error: string, rep: DestroyEnvResponse) => void): Promise<DestroyEnvResponse>;
|
|
355
|
+
/**
|
|
356
|
+
* 本接口（DestroyMySQL）用于销毁Mysql。
|
|
357
|
+
|
|
358
|
+
销毁后可以通过 [DescribeMySQLTaskStatus](https://cloud.tencent.com/document/api/876/128183) 接口查询销毁结果，如果 `Response.Data. Status = FAILED ` 表示销毁失败，可以重新调用销毁接口重试。
|
|
359
|
+
*/
|
|
360
|
+
DestroyMySQL(req: DestroyMySQLRequest, cb?: (error: string, rep: DestroyMySQLResponse) => void): Promise<DestroyMySQLResponse>;
|
|
361
|
+
/**
|
|
362
|
+
* 本接口CreateHTTPServiceRoute用于创建HTTP访问服务路由。如果不传Domain.Routes，仅创建域名信息。首次创建域名后需要调用DescribeHTTPServiceRoute查询域名状态，如果状态是PROCESSING，需要轮询查询域名状态直到SUCCESS或者FAIL。如果状态是FAIL，可以删除后重新创建。创建成功后域名可能无法访问，原因是异步下发的路由，可通过http或者https探测路由是否下发，如果http访问返回404或者https访问握手失败，可等待一会再试，直到访问正常。此外HTTP访问服务提供了默认域名，通过DescribeHTTPServiceRoute接口可直接获取默认域名。
|
|
363
|
+
*/
|
|
364
|
+
CreateHTTPServiceRoute(req: CreateHTTPServiceRouteRequest, cb?: (error: string, rep: CreateHTTPServiceRouteResponse) => void): Promise<CreateHTTPServiceRouteResponse>;
|
|
365
|
+
/**
|
|
366
|
+
* 查询资源基础权限。
|
|
367
|
+
|
|
368
|
+
查询云函数、云存储和数据库表的基础权限配置。支持单个资源查询和批量查询。
|
|
369
|
+
*/
|
|
370
|
+
DescribeResourcePermission(req: DescribeResourcePermissionRequest, cb?: (error: string, rep: DescribeResourcePermissionResponse) => void): Promise<DescribeResourcePermissionResponse>;
|
|
371
|
+
/**
|
|
372
|
+
* 查询环境计费周期。
|
|
373
|
+
云开发环境的资源点都是按月结算的，每个月都有一定的抵扣额度。
|
|
374
|
+
|
|
375
|
+
例如：
|
|
376
|
+
某个环境在 2026-01-05 购买了3个月个人版(到期时间: 2026-04-05)，则他可以在以下3个周期内，分别享有40000资源点的额度：
|
|
377
|
+
1. 2026-01-05 ~ 2026-02-05 23:59:59
|
|
378
|
+
2. 2026-02-06 ~ 2026-03-05 23:59:59
|
|
379
|
+
3. 2026-03-06 ~ 2026-04-05 23:59:59
|
|
380
|
+
|
|
381
|
+
本接口，用于获取环境当前属于哪个计费周期内。
|
|
382
|
+
*/
|
|
383
|
+
DescribeEnvAccountCircle(req: DescribeEnvAccountCircleRequest, cb?: (error: string, rep: DescribeEnvAccountCircleResponse) => void): Promise<DescribeEnvAccountCircleResponse>;
|
|
384
|
+
/**
|
|
385
|
+
* 本接口（DescribeCreateMySQLResult）用于查询开通Mysql结果。
|
|
386
|
+
|
|
387
|
+
`Response.Data.Status = "notexist"` 表示未开通，如果未开通，可以调用 [CreateMySQL](https://cloud.tencent.com/document/api/876/128186) 来开通
|
|
388
|
+
`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 命令。
|
|
389
|
+
*/
|
|
390
|
+
DescribeCreateMySQLResult(req: DescribeCreateMySQLResultRequest, cb?: (error: string, rep: DescribeCreateMySQLResultResponse) => void): Promise<DescribeCreateMySQLResultResponse>;
|
|
391
|
+
/**
|
|
392
|
+
* 查询网关版本信息
|
|
393
|
+
暂不鉴权
|
|
394
|
+
*/
|
|
395
|
+
DescribeGatewayVersions(req: DescribeGatewayVersionsRequest, cb?: (error: string, rep: DescribeGatewayVersionsResponse) => void): Promise<DescribeGatewayVersionsResponse>;
|
|
396
|
+
/**
|
|
397
|
+
* 创建自定义登录密钥。在指定云开发环境下生成一对 RSA 1024 位非对称密钥对，系统仅存储公钥，私钥仅在创建时返回一次且不可恢复，请妥善保存。创建新密钥后，该环境下原有未设置过期时间的旧密钥将被自动标记为 2 小时后过期，请确保客户端及时更新密钥配置。
|
|
398
|
+
返回的 KeyID 和 PrivateKey 需与环境 ID 一起组装为 JSON 配置文件，供客户端 Admin SDK 初始化时使用，文件格式如下：
|
|
399
|
+
{
|
|
400
|
+
"private_key_id": "<返回的 KeyID>",
|
|
401
|
+
"private_key": "<返回的 PrivateKey>",
|
|
402
|
+
"env_id": "<请求时传入的 EnvId>"
|
|
403
|
+
}
|
|
158
404
|
*/
|
|
159
|
-
|
|
405
|
+
CreateCustomLoginKey(req: CreateCustomLoginKeyRequest, cb?: (error: string, rep: CreateCustomLoginKeyResponse) => void): Promise<CreateCustomLoginKeyResponse>;
|
|
160
406
|
/**
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
注意⚠️
|
|
166
|
-
安全域名绑定成功之后，需要几分钟时间逐步生效。
|
|
167
|
-
*/
|
|
168
|
-
CreateAuthDomain(req: CreateAuthDomainRequest, cb?: (error: string, rep: CreateAuthDomainResponse) => void): Promise<CreateAuthDomainResponse>;
|
|
407
|
+
* 白名单接口，申请Tcb角色临时凭证
|
|
408
|
+
*/
|
|
409
|
+
AssumeRoleForAllocatedEnv(req: AssumeRoleForAllocatedEnvRequest, cb?: (error: string, rep: AssumeRoleForAllocatedEnvResponse) => void): Promise<AssumeRoleForAllocatedEnvResponse>;
|
|
169
410
|
/**
|
|
170
|
-
*
|
|
411
|
+
* 本接口(CreateTable)用于创建文档型数据库表，支持创建capped类型集合，暂时不支持分片表。
|
|
171
412
|
*/
|
|
172
|
-
|
|
413
|
+
CreateTable(req: CreateTableRequest, cb?: (error: string, rep: CreateTableResponse) => void): Promise<CreateTableResponse>;
|
|
173
414
|
/**
|
|
174
|
-
*
|
|
415
|
+
* 本接口（PreviewPGUserMigrations）用于预览SQL migrations 在远端的执行计划，不实际执行SQL。
|
|
175
416
|
*/
|
|
176
|
-
|
|
417
|
+
PreviewPGUserMigrations(req: PreviewPGUserMigrationsRequest, cb?: (error: string, rep: PreviewPGUserMigrationsResponse) => void): Promise<PreviewPGUserMigrationsResponse>;
|
|
177
418
|
/**
|
|
178
|
-
*
|
|
419
|
+
* 查询服务器价格
|
|
179
420
|
*/
|
|
180
|
-
|
|
421
|
+
InquireVmPrice(req: InquireVmPriceRequest, cb?: (error: string, rep: InquireVmPriceResponse) => void): Promise<InquireVmPriceResponse>;
|
|
181
422
|
/**
|
|
182
423
|
* 本接口用于获取当前环境的安全域名列表。
|
|
183
424
|
云开发会校验网页应用请求的来源域名，您需要将来源域名加入到WEB安全域名列表中。
|
|
184
425
|
可以通过接口 [CreateAuthDomain](https://cloud.tencent.com/document/product/876/42764) 增加安全域名。
|
|
185
426
|
*/
|
|
186
427
|
DescribeAuthDomains(req: DescribeAuthDomainsRequest, cb?: (error: string, rep: DescribeAuthDomainsResponse) => void): Promise<DescribeAuthDomainsResponse>;
|
|
187
|
-
/**
|
|
188
|
-
* 查询客户端详情。获取指定云开发环境下某个客户端的配置信息，包括客户端基本信息（名称、图标、描述）、OAuth 凭证（ClientId、ClientSecret）、安全域名、允许的 Scope 列表、Token 有效期、会话控制策略等。当客户端 ID 等于环境 ID 时，返回该环境的默认客户端配置。
|
|
189
|
-
*/
|
|
190
|
-
DescribeClient(req: DescribeClientRequest, cb?: (error: string, rep: DescribeClientResponse) => void): Promise<DescribeClientResponse>;
|
|
191
|
-
/**
|
|
192
|
-
* 设置数据库安全规则。
|
|
193
|
-
安全规则，用于控制C端用户的访问权限。详见 [安全规则介绍 ](https://cloud.tencent.com/document/product/876/123478)。
|
|
194
|
-
*/
|
|
195
|
-
ModifySafeRule(req: ModifySafeRuleRequest, cb?: (error: string, rep: ModifySafeRuleResponse) => void): Promise<ModifySafeRuleResponse>;
|
|
196
|
-
/**
|
|
197
|
-
* 删除合法域名。
|
|
198
|
-
云开发会校验网页应用请求的来源域名，您需要将来源域名加入到WEB安全域名列表中。
|
|
199
|
-
可以通过接口 [DescribeAuthDomains](https://cloud.tencent.com/document/product/876/42151) 获取当前已绑定生效的安全域名，将对应安全域名的id填入Domainlds中
|
|
200
|
-
|
|
201
|
-
注意⚠️
|
|
202
|
-
安全域名被删除之后，可能会引起跨域问题，请谨慎操作。
|
|
203
|
-
*/
|
|
204
|
-
DeleteAuthDomain(req: DeleteAuthDomainRequest, cb?: (error: string, rep: DeleteAuthDomainResponse) => void): Promise<DeleteAuthDomainResponse>;
|
|
205
428
|
/**
|
|
206
429
|
* 本接口（DescribeMySQLClusterDetail）查询Mysql集群信息。
|
|
207
430
|
|
|
@@ -209,30 +432,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
209
432
|
*/
|
|
210
433
|
DescribeMySQLClusterDetail(req: DescribeMySQLClusterDetailRequest, cb?: (error: string, rep: DescribeMySQLClusterDetailResponse) => void): Promise<DescribeMySQLClusterDetailResponse>;
|
|
211
434
|
/**
|
|
212
|
-
*
|
|
213
|
-
*/
|
|
214
|
-
DescribeVmSpec(req: DescribeVmSpecRequest, cb?: (error: string, rep: DescribeVmSpecResponse) => void): Promise<DescribeVmSpecResponse>;
|
|
215
|
-
/**
|
|
216
|
-
* 获取新套餐列表，含详情，如果传了PackageId，则只获取指定套餐详情
|
|
217
|
-
*/
|
|
218
|
-
DescribeBaasPackageList(req: DescribeBaasPackageListRequest, cb?: (error: string, rep: DescribeBaasPackageListResponse) => void): Promise<DescribeBaasPackageListResponse>;
|
|
219
|
-
/**
|
|
220
|
-
* 修改客户端配置。采用增量更新策略，仅更新请求中传入的非空字段，未传入的字段保持原值不变。支持修改客户端基本信息（名称、图标、描述、主页地址）、安全域名、允许的 Scope 列表、Token 有效期、会话控制策略及启用状态等配置。
|
|
221
|
-
Id、Secret、CreatedAt、Meta 等字段在该接口中不可修改，当客户端 ID 等于环境 ID 且客户端尚未创建时，将自动创建默认客户端配置。
|
|
222
|
-
*/
|
|
223
|
-
ModifyClient(req: ModifyClientRequest, cb?: (error: string, rep: ModifyClientResponse) => void): Promise<ModifyClientResponse>;
|
|
224
|
-
/**
|
|
225
|
-
* 本接口ModifyHTTPServiceRoute用于修改HTTP访问服务路由。支持增量修改，对应字段不传参数则不修改
|
|
226
|
-
*/
|
|
227
|
-
ModifyHTTPServiceRoute(req: ModifyHTTPServiceRouteRequest, cb?: (error: string, rep: ModifyHTTPServiceRouteResponse) => void): Promise<ModifyHTTPServiceRouteResponse>;
|
|
228
|
-
/**
|
|
229
|
-
* 从环境池里立即取出1个环境
|
|
230
|
-
*/
|
|
231
|
-
AllocateEnv(req: AllocateEnvRequest, cb?: (error: string, rep: AllocateEnvResponse) => void): Promise<AllocateEnvResponse>;
|
|
232
|
-
/**
|
|
233
|
-
* 查询静态托管域名任务状态
|
|
435
|
+
* 获取计费相关信息
|
|
234
436
|
*/
|
|
235
|
-
|
|
437
|
+
DescribeBillingInfo(req: DescribeBillingInfoRequest, cb?: (error: string, rep: DescribeBillingInfoResponse) => void): Promise<DescribeBillingInfoResponse>;
|
|
236
438
|
/**
|
|
237
439
|
* 本接口用于云开发环境套餐续费。
|
|
238
440
|
该接口会自动下单并支付，会在腾讯云账户中扣除余额（余额不足会下单失败）。
|
|
@@ -240,13 +442,13 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
240
442
|
*/
|
|
241
443
|
RenewEnv(req: RenewEnvRequest, cb?: (error: string, rep: RenewEnvResponse) => void): Promise<RenewEnvResponse>;
|
|
242
444
|
/**
|
|
243
|
-
*
|
|
445
|
+
* 从环境池里立即取出1个环境
|
|
244
446
|
*/
|
|
245
|
-
|
|
447
|
+
AllocateEnv(req: AllocateEnvRequest, cb?: (error: string, rep: AllocateEnvResponse) => void): Promise<AllocateEnvResponse>;
|
|
246
448
|
/**
|
|
247
|
-
*
|
|
449
|
+
* 本接口（DescribeDatabaseACL）获取文档型数据库权限。
|
|
248
450
|
*/
|
|
249
|
-
|
|
451
|
+
DescribeDatabaseACL(req: DescribeDatabaseACLRequest, cb?: (error: string, rep: DescribeDatabaseACLResponse) => void): Promise<DescribeDatabaseACLResponse>;
|
|
250
452
|
/**
|
|
251
453
|
* 更新 AI 模型配置分组。支持修改分组的模型列表、服务地址、访问密钥、备注及启用状态。
|
|
252
454
|
|
|
@@ -271,52 +473,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
271
473
|
*/
|
|
272
474
|
DescribeStaticStore(req: DescribeStaticStoreRequest, cb?: (error: string, rep: DescribeStaticStoreResponse) => void): Promise<DescribeStaticStoreResponse>;
|
|
273
475
|
/**
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
接口入参中的 Tag 为文档型数据库的实例 Id，可以通过 [DescribeEnvs](https://cloud.tencent.com/document/api/876/34820) 接口返回的 EnvList[0].Databases[0].InstanceId 获取。
|
|
277
|
-
*/
|
|
278
|
-
DescribeTable(req: DescribeTableRequest, cb?: (error: string, rep: DescribeTableResponse) => void): Promise<DescribeTableResponse>;
|
|
279
|
-
/**
|
|
280
|
-
* 更新环境信息
|
|
281
|
-
*/
|
|
282
|
-
ModifyEnv(req: ModifyEnvRequest, cb?: (error: string, rep: ModifyEnvResponse) => void): Promise<ModifyEnvResponse>;
|
|
283
|
-
/**
|
|
284
|
-
* 修改指定云开发环境已绑定的外部云存储源配置。
|
|
285
|
-
修改之后，大约3~5分钟生效。
|
|
286
|
-
|
|
287
|
-
注意⚠️
|
|
288
|
-
本接口仅更新存储源绑定关系，不会迁移您的数据。
|
|
289
|
-
*/
|
|
290
|
-
ModifyStorageSource(req: ModifyStorageSourceRequest, cb?: (error: string, rep: ModifyStorageSourceResponse) => void): Promise<ModifyStorageSourceResponse>;
|
|
291
|
-
/**
|
|
292
|
-
* 删除认证源
|
|
293
|
-
*/
|
|
294
|
-
DeleteProvider(req: DeleteProviderRequest, cb?: (error: string, rep: DeleteProviderResponse) => void): Promise<DeleteProviderResponse>;
|
|
295
|
-
/**
|
|
296
|
-
* 在Postgres数据库上执行SQL
|
|
476
|
+
* 本接口(UpdateTable)用于修改文档型数据库表信息，当前可以支持创建和删除索引。
|
|
297
477
|
*/
|
|
298
|
-
|
|
299
|
-
/**
|
|
300
|
-
* 删除 AI 模型配置分组，支持批量删除。内置分组无法删除。分组删除后，该分组下的所有模型配置将同步移除，针对该分组模型的请求将会失败，请在删除前确认业务侧已停止对该分组的调用。
|
|
301
|
-
|
|
302
|
-
注意：
|
|
303
|
-
此操作不可逆，删除后数据无法恢复，请谨慎操作。
|
|
304
|
-
|
|
305
|
-
删除前建议通过 [DescribeAIModelList]() 接口确认分组当前状态。
|
|
306
|
-
*/
|
|
307
|
-
DeleteAIModel(req: DeleteAIModelRequest, cb?: (error: string, rep: DeleteAIModelResponse) => void): Promise<DeleteAIModelResponse>;
|
|
308
|
-
/**
|
|
309
|
-
* 创建云开发平台的API Key。在指定云开发环境下创建一个 API Key 访问凭证。支持两种类型：api_key（服务端管理员访问凭证，以管理员身份签发，可设置有效期，不设置有效期则永不过期，单个环境最多创建 5 个）和 publish_key（前端匿名访问凭证，固定有效期，每个环境仅保留一个）。创建成功后将返回 API Key 明文 Token，该值仅在创建时返回一次，请妥善保存。需要管理员权限。
|
|
310
|
-
权限范围与注意事项：
|
|
311
|
-
- api_key 是以"管理员身份"签发的访问凭证，持有该 Token 即拥有腾讯云云开发数据流（含数据库、云函数、云存储、托管等）资源的完整访问与操作权限。该凭证不区分子资源粒度，一旦泄露等同于环境管理员权限被泄露，请按"高敏感凭证"管理： 仅用于服务端调用、严禁下发到前端/客户端、严禁写入代码仓库或日志、定期轮换并回收闲置凭证。
|
|
312
|
-
- 在为子账号 / 协作者 / RAM 子用户授权该接口权限时，须先评估该子账号是否有资格获得该环境的管理员级数据流权限，能创建 api_key ≈ 能拥有环境管理员权限。
|
|
313
|
-
*/
|
|
314
|
-
CreateApiKey(req: CreateApiKeyRequest, cb?: (error: string, rep: CreateApiKeyResponse) => void): Promise<CreateApiKeyResponse>;
|
|
315
|
-
/**
|
|
316
|
-
* 查询数据库安全规则。
|
|
317
|
-
安全规则，用于控制C端用户的访问权限。详见 [安全规则介绍](https://cloud.tencent.com/document/product/876/123478) 。
|
|
318
|
-
*/
|
|
319
|
-
DescribeSafeRule(req: DescribeSafeRuleRequest, cb?: (error: string, rep: DescribeSafeRuleResponse) => void): Promise<DescribeSafeRuleResponse>;
|
|
478
|
+
UpdateTable(req: UpdateTableRequest, cb?: (error: string, rep: UpdateTableResponse) => void): Promise<UpdateTableResponse>;
|
|
320
479
|
/**
|
|
321
480
|
* 本接口用于变更云开发环境套餐。
|
|
322
481
|
该接口会自动下单并支付，会在腾讯云账户中扣除余额（余额不足会下单失败）。
|
|
@@ -324,9 +483,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
324
483
|
*/
|
|
325
484
|
ModifyEnvPlan(req: ModifyEnvPlanRequest, cb?: (error: string, rep: ModifyEnvPlanResponse) => void): Promise<ModifyEnvPlanResponse>;
|
|
326
485
|
/**
|
|
327
|
-
* 本接口（
|
|
486
|
+
* 本接口（PushPGUserMigrations）用于批量应用Migrations。
|
|
328
487
|
*/
|
|
329
|
-
|
|
488
|
+
PushPGUserMigrations(req: PushPGUserMigrationsRequest, cb?: (error: string, rep: PushPGUserMigrationsResponse) => void): Promise<PushPGUserMigrationsResponse>;
|
|
330
489
|
/**
|
|
331
490
|
* 搜索用户调用日志
|
|
332
491
|
*/
|
|
@@ -336,147 +495,24 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
336
495
|
*/
|
|
337
496
|
DescribeQuotaData(req: DescribeQuotaDataRequest, cb?: (error: string, rep: DescribeQuotaDataResponse) => void): Promise<DescribeQuotaDataResponse>;
|
|
338
497
|
/**
|
|
339
|
-
|
|
340
|
-
对于 OIDC 类型身份源，修改 Issuer 后将自动通过 OpenID Connect Discovery 重新获取端点配置。
|
|
341
|
-
若自定义登录（CUSTOM）或邮箱登录（EMAIL）身份源尚不存在，调用该接口时将自动创建。
|
|
342
|
-
*/
|
|
343
|
-
ModifyProvider(req: ModifyProviderRequest, cb?: (error: string, rep: ModifyProviderResponse) => void): Promise<ModifyProviderResponse>;
|
|
344
|
-
/**
|
|
345
|
-
* 本接口用于销毁云开发环境。
|
|
346
|
-
云开发环境遵循腾讯云包年包月预付费产品生命周期，因此环境销毁需要分两步：
|
|
347
|
-
1. 资源退费。此时会根据当前环境剩余有效期，自动退还相关费用(代金券不退)。退款后，环境进入隔离期。
|
|
348
|
-
2. 环境删除。环境在进入隔离期后15天会自动删除。也可以通过本接口，指定 IsForce=true 来强制删除隔离期环境。
|
|
349
|
-
|
|
350
|
-
**注意**⚠️
|
|
351
|
-
1. 环境退费后进入隔离期，则所有资源均无法访问，控制台无法操作和管理。
|
|
352
|
-
2. 环境被彻底删除后，所有数据均无法找回。请谨慎操作。
|
|
353
|
-
|
|
354
|
-
可以通过接口 [tcb:DescribeBillingInfo](https://cloud.tencent.com/document/product/876/94390) 查询环境计费状态。
|
|
355
|
-
*/
|
|
356
|
-
DestroyEnv(req: DestroyEnvRequest, cb?: (error: string, rep: DestroyEnvResponse) => void): Promise<DestroyEnvResponse>;
|
|
357
|
-
/**
|
|
358
|
-
* 销毁云服务器实例
|
|
498
|
+
* 本接口（RollbackPGUserMigrations）用于按最近 N 条已应用 migration 倒序执行 rollback。
|
|
359
499
|
*/
|
|
360
|
-
|
|
500
|
+
RollbackPGUserMigrations(req: RollbackPGUserMigrationsRequest, cb?: (error: string, rep: RollbackPGUserMigrationsResponse) => void): Promise<RollbackPGUserMigrationsResponse>;
|
|
361
501
|
/**
|
|
362
502
|
* 修改tcb用户
|
|
363
503
|
*/
|
|
364
504
|
ModifyUser(req: ModifyUserRequest, cb?: (error: string, rep: ModifyUserResponse) => void): Promise<ModifyUserResponse>;
|
|
365
505
|
/**
|
|
366
|
-
*
|
|
367
|
-
*/
|
|
368
|
-
GetProviders(req: GetProvidersRequest, cb?: (error: string, rep: GetProvidersResponse) => void): Promise<GetProvidersResponse>;
|
|
369
|
-
/**
|
|
370
|
-
* 查询指定云开发环境的登录策略配置。包括手机号短信登录、邮箱登录、用户名密码登录和匿名登录方式的开启状态，同时包含短信验证码发送通道、MFA 多因子认证和密码的更新策略。
|
|
371
|
-
*/
|
|
372
|
-
DescribeLoginConfig(req: DescribeLoginConfigRequest, cb?: (error: string, rep: DescribeLoginConfigResponse) => void): Promise<DescribeLoginConfigResponse>;
|
|
373
|
-
/**
|
|
374
|
-
* 本接口(DeleteTable)用于删除文档型数据库表，删除表后表中数据将会被删除且无法恢复，请谨慎操作。
|
|
375
|
-
|
|
376
|
-
接口入参中的 Tag 为文档型数据库的实例 Id，可以通过 [DescribeEnvs](https://cloud.tencent.com/document/api/876/34820) 接口返回的 EnvList[0].Databases[0].InstanceId 获取。
|
|
377
|
-
*/
|
|
378
|
-
DeleteTable(req: DeleteTableRequest, cb?: (error: string, rep: DeleteTableResponse) => void): Promise<DeleteTableResponse>;
|
|
379
|
-
/**
|
|
380
|
-
* 获取计费相关信息
|
|
381
|
-
*/
|
|
382
|
-
DescribeBillingInfo(req: DescribeBillingInfoRequest, cb?: (error: string, rep: DescribeBillingInfoResponse) => void): Promise<DescribeBillingInfoResponse>;
|
|
383
|
-
/**
|
|
384
|
-
* 从指定云开发环境中解绑已绑定的外部云存储源。解绑后，该环境将不再关联外部 存储源，云存储功能恢复为未绑定状态。
|
|
385
|
-
解绑操作仅移除 CloudBase 侧的绑定关系，不会删除桶本身及桶内数据，桶仍由用户自行管理。
|
|
386
|
-
|
|
387
|
-
注意⚠️
|
|
388
|
-
解绑之后，会导致云存储不可用，请谨慎操作。
|
|
389
|
-
*/
|
|
390
|
-
UnbindStorageSource(req: UnbindStorageSourceRequest, cb?: (error: string, rep: UnbindStorageSourceResponse) => void): Promise<UnbindStorageSourceResponse>;
|
|
391
|
-
/**
|
|
392
|
-
* 获取云托管代码上传url
|
|
506
|
+
* 更新环境信息
|
|
393
507
|
*/
|
|
394
|
-
|
|
508
|
+
ModifyEnv(req: ModifyEnvRequest, cb?: (error: string, rep: ModifyEnvResponse) => void): Promise<ModifyEnvResponse>;
|
|
395
509
|
/**
|
|
396
|
-
*
|
|
510
|
+
* 云服务器规格list
|
|
397
511
|
*/
|
|
398
|
-
|
|
399
|
-
/**
|
|
400
|
-
* 本接口（DestroyMySQL）用于销毁Mysql。
|
|
401
|
-
|
|
402
|
-
销毁后可以通过 [DescribeMySQLTaskStatus](https://cloud.tencent.com/document/api/876/128183) 接口查询销毁结果，如果 `Response.Data. Status = FAILED ` 表示销毁失败，可以重新调用销毁接口重试。
|
|
403
|
-
*/
|
|
404
|
-
DestroyMySQL(req: DestroyMySQLRequest, cb?: (error: string, rep: DestroyMySQLResponse) => void): Promise<DestroyMySQLResponse>;
|
|
512
|
+
DescribeVmSpec(req: DescribeVmSpecRequest, cb?: (error: string, rep: DescribeVmSpecResponse) => void): Promise<DescribeVmSpecResponse>;
|
|
405
513
|
/**
|
|
406
514
|
* 修改指定云开发环境的登录策略配置。支持开启或关闭手机号短信登录、邮箱登录、用户名密码登录和匿名登录，同时可配置短信验证码发送通道、MFA 多因子认证和密码更新策略。
|
|
407
515
|
修改后立即生效，影响该环境下所有终端用户的登录行为。
|
|
408
516
|
*/
|
|
409
517
|
ModifyLoginConfig(req: ModifyLoginConfigRequest, cb?: (error: string, rep: ModifyLoginConfigResponse) => void): Promise<ModifyLoginConfigResponse>;
|
|
410
|
-
/**
|
|
411
|
-
* 本接口（RunCommands）用于执行文档型数据库命令。
|
|
412
|
-
*/
|
|
413
|
-
RunCommands(req: RunCommandsRequest, cb?: (error: string, rep: RunCommandsResponse) => void): Promise<RunCommandsResponse>;
|
|
414
|
-
/**
|
|
415
|
-
* 创建云开发产品计费订单，用于以下几种场景：
|
|
416
|
-
1. 购买云开发环境
|
|
417
|
-
2. 续费云开发环境
|
|
418
|
-
3. 变更云开发环境套餐
|
|
419
|
-
4. 购买云开发资源包
|
|
420
|
-
5. 购买云开发大促包
|
|
421
|
-
|
|
422
|
-
该接口支持下单并支付(CreateAndPay=true时)，此时会自动在腾讯云账户中扣除余额（余额不足会下单失败）。
|
|
423
|
-
该接口支持自动扣除代金券（AutoVoucher=true时），符合条件的代金券会被自动扣除。
|
|
424
|
-
*/
|
|
425
|
-
CreateBillDeal(req: CreateBillDealRequest, cb?: (error: string, rep: CreateBillDealResponse) => void): Promise<CreateBillDealResponse>;
|
|
426
|
-
/**
|
|
427
|
-
* 根据指定指标名称，查询某环境在指定时间范围内的监控数据，返回按统计粒度聚合后的时序数据。
|
|
428
|
-
*/
|
|
429
|
-
DescribeCurveData(req: DescribeCurveDataRequest, cb?: (error: string, rep: DescribeCurveDataResponse) => void): Promise<DescribeCurveDataResponse>;
|
|
430
|
-
/**
|
|
431
|
-
* 本接口CreateHTTPServiceRoute用于创建HTTP访问服务路由。如果不传Domain.Routes，仅创建域名信息。首次创建域名后需要调用DescribeHTTPServiceRoute查询域名状态，如果状态是PROCESSING，需要轮询查询域名状态直到SUCCESS或者FAIL。如果状态是FAIL，可以删除后重新创建。创建成功后域名可能无法访问，原因是异步下发的路由，可通过http或者https探测路由是否下发，如果http访问返回404或者https访问握手失败，可等待一会再试，直到访问正常。此外HTTP访问服务提供了默认域名，通过DescribeHTTPServiceRoute接口可直接获取默认域名。
|
|
432
|
-
*/
|
|
433
|
-
CreateHTTPServiceRoute(req: CreateHTTPServiceRouteRequest, cb?: (error: string, rep: CreateHTTPServiceRouteResponse) => void): Promise<CreateHTTPServiceRouteResponse>;
|
|
434
|
-
/**
|
|
435
|
-
* 检查是否开通Tcb服务
|
|
436
|
-
*/
|
|
437
|
-
CheckTcbService(req?: CheckTcbServiceRequest, cb?: (error: string, rep: CheckTcbServiceResponse) => void): Promise<CheckTcbServiceResponse>;
|
|
438
|
-
/**
|
|
439
|
-
* 创建tcb用户
|
|
440
|
-
*/
|
|
441
|
-
CreateUser(req: CreateUserRequest, cb?: (error: string, rep: CreateUserResponse) => void): Promise<CreateUserResponse>;
|
|
442
|
-
/**
|
|
443
|
-
* 创建静态托管资源，包括COS和CDN，异步任务创建，查看创建结果需要根据DescribeStaticStore接口来查看
|
|
444
|
-
*/
|
|
445
|
-
CreateStaticStore(req: CreateStaticStoreRequest, cb?: (error: string, rep: CreateStaticStoreResponse) => void): Promise<CreateStaticStoreResponse>;
|
|
446
|
-
/**
|
|
447
|
-
* 查询环境个数上限
|
|
448
|
-
*/
|
|
449
|
-
DescribeEnvLimit(req?: DescribeEnvLimitRequest, cb?: (error: string, rep: DescribeEnvLimitResponse) => void): Promise<DescribeEnvLimitResponse>;
|
|
450
|
-
/**
|
|
451
|
-
* 本接口（RunSql）用于执行MySQL语句。
|
|
452
|
-
|
|
453
|
-
该接口用来执行 MySql 语句，比如创建表格、插入数据、修改数据、删除字段、添加索引等可以通过sql 语句实现的都可以使用该接口。
|
|
454
|
-
|
|
455
|
-
调用该接口前需要先查询Mysql是否开通，可通过 [DescribeCreateMySQLResult ](https://cloud.tencent.com/document/api/876/128185) 查询，只有开通成功才能操作。
|
|
456
|
-
*/
|
|
457
|
-
RunSql(req: RunSqlRequest, cb?: (error: string, rep: RunSqlResponse) => void): Promise<RunSqlResponse>;
|
|
458
|
-
/**
|
|
459
|
-
* 销毁静态托管资源，该接口创建异步销毁任务，资源最终状态可从DestroyStaticStore接口查看
|
|
460
|
-
*/
|
|
461
|
-
DestroyStaticStore(req: DestroyStaticStoreRequest, cb?: (error: string, rep: DestroyStaticStoreResponse) => void): Promise<DestroyStaticStoreResponse>;
|
|
462
|
-
/**
|
|
463
|
-
* 删除指定云开发环境下的某个 API Key 服务端访问凭证。删除后，该 API Key 对应的 Token 将被吊销，已使用该 Key 发起的请求将失败。该操作具有幂等性，若指定的 API Key 不存在则直接返回成功。需要管理员权限。
|
|
464
|
-
*/
|
|
465
|
-
DeleteApiKey(req: DeleteApiKeyRequest, cb?: (error: string, rep: DeleteApiKeyResponse) => void): Promise<DeleteApiKeyResponse>;
|
|
466
|
-
/**
|
|
467
|
-
* 添加身份认证源。在指定云开发环境下创建一个新的身份认证源，支持 OAuth 2.0、OIDC、SAML 2.0 等标准协议，以及自定义登录和邮箱登录等多种认证方式。
|
|
468
|
-
创建时需指定身份源协议类型（ProviderType）并配置对应的协议连接参数（Config）。若身份源 ID 已存在将返回错误。
|
|
469
|
-
限制：一个环境最大可允许加入20个认证源。
|
|
470
|
-
*/
|
|
471
|
-
AddProvider(req: AddProviderRequest, cb?: (error: string, rep: AddProviderResponse) => void): Promise<AddProviderResponse>;
|
|
472
|
-
/**
|
|
473
|
-
* 本接口(DescribeTables)用于查询文档型数据库所有表信息，包括表名、表中数据条数、表中数据量、索引个数及索引的大小等。
|
|
474
|
-
*/
|
|
475
|
-
DescribeTables(req: DescribeTablesRequest, cb?: (error: string, rep: DescribeTablesResponse) => void): Promise<DescribeTablesResponse>;
|
|
476
|
-
/**
|
|
477
|
-
* 本接口(ListTables)用于查询文档型数据库所有表信息，包括表名、表中数据条数、表中数据量、索引个数及索引的大小等。
|
|
478
|
-
|
|
479
|
-
该接口跟 [DescribeTables](https://cloud.tencent.com/document/api/876/127962) 接口功能一致，后续该接口可能会下线，请使用 [DescribeTable](https://cloud.tencent.com/document/api/876/127962)接口。
|
|
480
|
-
*/
|
|
481
|
-
ListTables(req: ListTablesRequest, cb?: (error: string, rep: ListTablesResponse) => void): Promise<ListTablesResponse>;
|
|
482
518
|
}
|