tencentcloud-sdk-nodejs-mongodb 4.0.1026 → 4.0.1028
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -23
- package/package.json +1 -1
- package/src/services/mongodb/v20190725/mongodb_client.ts +14 -1
- package/src/services/mongodb/v20190725/mongodb_models.ts +52 -4
- package/tencentcloud/services/mongodb/v20190725/mongodb_client.d.ts +5 -1
- package/tencentcloud/services/mongodb/v20190725/mongodb_client.js +6 -0
- package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +49 -4
package/README.md
CHANGED
|
@@ -1,21 +1,20 @@
|
|
|
1
1
|
# 简介
|
|
2
2
|
|
|
3
|
-
欢迎使用腾讯云开发者工具套件(SDK),
|
|
4
|
-
为方便
|
|
3
|
+
欢迎使用腾讯云开发者工具套件(SDK),Node.js SDK 4.0 是云 API 3.0 平台的配套工具。
|
|
4
|
+
为方便 Node.js 开发者调试和接入腾讯云产品 API,这里向您介绍适用于 Node.js 的腾讯云开发工具包,并提供首次使用开发工具包的简单示例。让您快速获取腾讯云 Node.js SDK 并开始调用。
|
|
5
5
|
|
|
6
6
|
# 依赖环境
|
|
7
7
|
|
|
8
|
-
1.
|
|
9
|
-
2.
|
|
10
|
-
3. 获取 SecretID、SecretKey 以及调用地址(endpoint),endpoint 一般形式为\*.tencentcloudapi.com,如 CVM 的调用地址为 cvm.tencentcloudapi.com,具体参考各产品说明。
|
|
8
|
+
1. Node.js 10.0.0 版本及以上。
|
|
9
|
+
2. 注意:部分产品需在 [腾讯云控制台](https://console.cloud.tencent.com/) 开通服务后才能使用。
|
|
11
10
|
|
|
12
11
|
# 获取安装
|
|
13
12
|
|
|
14
|
-
|
|
13
|
+
使用 SDK 需要 API 密钥,可前往 [腾讯云控制台 - 访问密钥](https://console.cloud.tencent.com/cam/capi) 页面申请,API 密钥包括 SecretID 和 SecretKey,密钥须严格保管,避免泄露。
|
|
15
14
|
|
|
16
|
-
## 通过
|
|
15
|
+
## 通过 npm 安装
|
|
17
16
|
|
|
18
|
-
通过
|
|
17
|
+
通过 npm 获取安装是使用 Node.js SDK 的推荐方法,关于 npm 详细可参考 [NPM 官网](https://www.npmjs.com/) 。
|
|
19
18
|
|
|
20
19
|
### 安装指定产品 SDK(推荐)
|
|
21
20
|
|
|
@@ -56,10 +55,12 @@ npm install tencentcloud-sdk-nodejs --save
|
|
|
56
55
|
1. 前往 [GitHub 仓库](https://github.com/tencentcloud/tencentcloud-sdk-nodejs) 或者 [Gitee 仓库](https://gitee.com/tencentcloud/tencentcloud-sdk-nodejs) 下载源码压缩包。
|
|
57
56
|
2. 解压源码包到您项目合适的位置,例如 `sdk/tencentcloud-sdk-nodejs`。
|
|
58
57
|
3. 执行 `npm install ./sdk/tencentcloud-sdk-nodejs`。
|
|
59
|
-
4. 使用 `require("tencentcloud-sdk-nodejs")` 的方式引入SDK,具体可参考示例。
|
|
58
|
+
4. 使用 `require("tencentcloud-sdk-nodejs")` 的方式引入 SDK,具体可参考示例。
|
|
60
59
|
|
|
61
60
|
# 示例
|
|
62
61
|
|
|
62
|
+
以云服务器产品查询可用区列表接口为例。
|
|
63
|
+
|
|
63
64
|
```js
|
|
64
65
|
const tencentcloud = require("tencentcloud-sdk-nodejs")
|
|
65
66
|
|
|
@@ -102,7 +103,7 @@ client.DescribeZones().then(
|
|
|
102
103
|
)
|
|
103
104
|
```
|
|
104
105
|
|
|
105
|
-
在支持
|
|
106
|
+
在支持 TypeScript 项目中,采用如下方式调用
|
|
106
107
|
|
|
107
108
|
```js
|
|
108
109
|
import * as tencentcloud from "tencentcloud-sdk-nodejs"
|
|
@@ -112,10 +113,11 @@ const CvmClient = tencentcloud.cvm.v20170312.Client
|
|
|
112
113
|
// ...
|
|
113
114
|
```
|
|
114
115
|
|
|
115
|
-
|
|
116
|
+
实例化 `Client` 的入参支持 `clientConfig`,数据结构和说明详见 [ClientConfig](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/common/interface.ts)。
|
|
116
117
|
|
|
117
118
|
## Common Client
|
|
118
|
-
|
|
119
|
+
|
|
120
|
+
从 4.0.714 版本开始,腾讯云 Node.js SDK 支持使用泛用性的 API 调用方式(Common Client)进行请求。您只需要安装 tencentcloud-sdk-nodejs-common 包,即可向任何产品发起调用。
|
|
119
121
|
|
|
120
122
|
**注意,您必须明确知道您调用的接口所需参数,否则可能会调用失败。**
|
|
121
123
|
|
|
@@ -123,19 +125,19 @@ const CvmClient = tencentcloud.cvm.v20170312.Client
|
|
|
123
125
|
|
|
124
126
|
## 更多示例
|
|
125
127
|
|
|
126
|
-
|
|
128
|
+
请参考 [examples](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/tree/master/examples) 目录。
|
|
127
129
|
|
|
128
130
|
# 相关配置
|
|
129
131
|
|
|
130
132
|
## 代理
|
|
131
133
|
|
|
132
|
-
如果是有代理的环境下,需要配置代理,请在创建Client时传入 [profile.httpProfile.proxy](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/common/interface.ts#L78) 参数,或设置系统环境变量 `http_proxy` ,否则可能无法正常调用,抛出连接超时的异常。
|
|
134
|
+
如果是有代理的环境下,需要配置代理,请在创建 Client 时传入 [profile.httpProfile.proxy](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/common/interface.ts#L78) 参数,或设置系统环境变量 `http_proxy` ,否则可能无法正常调用,抛出连接超时的异常。
|
|
133
135
|
|
|
134
136
|
# 凭证管理
|
|
135
137
|
|
|
136
138
|
除显式传入凭证外,从 `v4.0.506` 起支持 [腾讯云实例角色](https://cloud.tencent.com/document/product/213/47668)
|
|
137
139
|
|
|
138
|
-
在您为实例绑定角色后,您可以在实例中访问相关元数据接口获取临时凭证。用法可参考 [js示例代码](./examples/cvm_role.js) 或 [ts示例代码](./examples/cvm_role.ts)
|
|
140
|
+
在您为实例绑定角色后,您可以在实例中访问相关元数据接口获取临时凭证。用法可参考 [js 示例代码](./examples/cvm_role.js) 或 [ts 示例代码](./examples/cvm_role.ts)
|
|
139
141
|
```javascript
|
|
140
142
|
// ...
|
|
141
143
|
const CvmRoleCredential = require("tencentcloud-sdk-nodejs/tencentcloud/common/cvm_role_credential").default
|
|
@@ -147,20 +149,16 @@ new XxxClient({
|
|
|
147
149
|
})
|
|
148
150
|
```
|
|
149
151
|
|
|
150
|
-
# 旧版 SDK
|
|
151
|
-
|
|
152
|
-
我们推荐使用新版 NODEJS SDK,如果一定要用旧版 SDK,请前往[GitHub 仓库](https://github.com/CFETeam/qcloudapi-sdk)下载。
|
|
153
|
-
|
|
154
152
|
# 常见问题
|
|
155
|
-
- webpack打包出错/浏览器报错
|
|
153
|
+
- webpack 打包出错/浏览器报错
|
|
156
154
|
|
|
157
|
-
请**务必不要**将此SDK直接用于
|
|
155
|
+
请**务必不要**将此 SDK 直接用于 Web 前端(包括小程序等),暴露密钥在这些环境非常不安全。
|
|
158
156
|
|
|
159
|
-
正确的做法是在自己的服务端引用此SDK
|
|
157
|
+
正确的做法是在自己的服务端引用此 SDK,并保存好密钥,做好请求鉴权,前端再调用服务端执行业务流程。
|
|
160
158
|
|
|
161
159
|
- `The "original" argument must be of type Function.`
|
|
162
160
|
|
|
163
|
-
通常是因为
|
|
161
|
+
通常是因为 Node.js 版本低于 `v10` ,或处于非 Node.js 环境,请再次确认执行环境。
|
|
164
162
|
|
|
165
163
|
- 请求不通
|
|
166
164
|
|
package/package.json
CHANGED
|
@@ -91,6 +91,7 @@ import {
|
|
|
91
91
|
NodeTag,
|
|
92
92
|
InquirePriceCreateDBInstancesResponse,
|
|
93
93
|
DescribeSecurityGroupResponse,
|
|
94
|
+
DescribeTransparentDataEncryptionStatusRequest,
|
|
94
95
|
SecurityGroup,
|
|
95
96
|
ReplicaSetInfo,
|
|
96
97
|
ResetDBInstancePasswordResponse,
|
|
@@ -129,6 +130,7 @@ import {
|
|
|
129
130
|
AssignProjectRequest,
|
|
130
131
|
ModifyInstanceParamsRequest,
|
|
131
132
|
CreateBackupDownloadTaskResponse,
|
|
133
|
+
DbURL,
|
|
132
134
|
SpecificationInfo,
|
|
133
135
|
DescribeSlowLogPatternsRequest,
|
|
134
136
|
FlashbackCollection,
|
|
@@ -142,11 +144,12 @@ import {
|
|
|
142
144
|
InquirePriceCreateDBInstancesRequest,
|
|
143
145
|
DescribeInstanceParamsResponse,
|
|
144
146
|
DescribeDBInstanceParamTplResponse,
|
|
145
|
-
|
|
147
|
+
DescribeDBInstanceURLResponse,
|
|
146
148
|
RemoveNodeList,
|
|
147
149
|
RestartNodesRequest,
|
|
148
150
|
SetInstanceMaintenanceRequest,
|
|
149
151
|
RestartNodesResponse,
|
|
152
|
+
DescribeDBInstanceURLRequest,
|
|
150
153
|
DescribeDBInstanceParamTplDetailRequest,
|
|
151
154
|
InstanceDetail,
|
|
152
155
|
ModifyDBInstanceSpecResponse,
|
|
@@ -173,6 +176,16 @@ export class Client extends TencentCloudCommon.AbstractClient {
|
|
|
173
176
|
return this.request("TerminateDBInstances", req, cb)
|
|
174
177
|
}
|
|
175
178
|
|
|
179
|
+
/**
|
|
180
|
+
* 本接口(DescribeDBInstanceURL)用于获取指定实例的 URI 形式的连接串访问地址示例。
|
|
181
|
+
*/
|
|
182
|
+
async DescribeDBInstanceURL(
|
|
183
|
+
req: DescribeDBInstanceURLRequest,
|
|
184
|
+
cb?: (error: string, rep: DescribeDBInstanceURLResponse) => void
|
|
185
|
+
): Promise<DescribeDBInstanceURLResponse> {
|
|
186
|
+
return this.request("DescribeDBInstanceURL", req, cb)
|
|
187
|
+
}
|
|
188
|
+
|
|
176
189
|
/**
|
|
177
190
|
* 本接口用于查询节点的属性,包括节点所在可用区、节点名称、地址、角色、状态、主从延迟、优先级、投票权、标签等属性。
|
|
178
191
|
*/
|
|
@@ -1739,6 +1739,16 @@ export interface DescribeSecurityGroupResponse {
|
|
|
1739
1739
|
RequestId?: string
|
|
1740
1740
|
}
|
|
1741
1741
|
|
|
1742
|
+
/**
|
|
1743
|
+
* DescribeTransparentDataEncryptionStatus请求参数结构体
|
|
1744
|
+
*/
|
|
1745
|
+
export interface DescribeTransparentDataEncryptionStatusRequest {
|
|
1746
|
+
/**
|
|
1747
|
+
* 指定实例 ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
|
|
1748
|
+
*/
|
|
1749
|
+
InstanceId: string
|
|
1750
|
+
}
|
|
1751
|
+
|
|
1742
1752
|
/**
|
|
1743
1753
|
* 安全组信息
|
|
1744
1754
|
*/
|
|
@@ -2719,6 +2729,30 @@ export interface CreateBackupDownloadTaskResponse {
|
|
|
2719
2729
|
RequestId?: string
|
|
2720
2730
|
}
|
|
2721
2731
|
|
|
2732
|
+
/**
|
|
2733
|
+
* 数据库实例 URI 形式的连接串访问地址示例。
|
|
2734
|
+
*/
|
|
2735
|
+
export interface DbURL {
|
|
2736
|
+
/**
|
|
2737
|
+
* 指 URI 类别,包括:,
|
|
2738
|
+
- CLUSTER_ALL:指通过该 URI 连接库实例的主节点,可读写。
|
|
2739
|
+
- CLUSTER_READ_READONLY:指通过该 URI 连接实例只读节点。
|
|
2740
|
+
- CLUSTER_READ_SECONDARY:指通过该 URI 连接实例从节点。
|
|
2741
|
+
- CLUSTER_READ_SECONDARY_AND_READONLY:指通过该 URI 连接实例只读从节点。
|
|
2742
|
+
- CLUSTER_PRIMARY_AND_SECONDARY:指通过该 URI 连接实例 主节点与从节点。
|
|
2743
|
+
- MONGOS_ALL:指通过该 URI 连接每个 Mongos 节点,可读写。
|
|
2744
|
+
- MONGOS_READ_READONLY:指通过该 URI 连接 Mongos 的只读节点。
|
|
2745
|
+
- MONGOS_READ_SECONDARY:指通过该 URI 连接 Mongos 的从节点。
|
|
2746
|
+
- MONGOS_READ_PRIMARY_AND_SECONDARY:指通过该URI 连接 Mongos 的主节点与从节点。
|
|
2747
|
+
- MONGOS_READ_SECONDARY_AND_READONLY:指通过该URI 连接 Mongos 的从节点与只读节点。
|
|
2748
|
+
*/
|
|
2749
|
+
URLType: string
|
|
2750
|
+
/**
|
|
2751
|
+
* 实例 URI 形式的连接串访问地址示例。
|
|
2752
|
+
*/
|
|
2753
|
+
Address: string
|
|
2754
|
+
}
|
|
2755
|
+
|
|
2722
2756
|
/**
|
|
2723
2757
|
* 实例规格信息
|
|
2724
2758
|
*/
|
|
@@ -3057,13 +3091,17 @@ export interface DescribeDBInstanceParamTplResponse {
|
|
|
3057
3091
|
}
|
|
3058
3092
|
|
|
3059
3093
|
/**
|
|
3060
|
-
*
|
|
3094
|
+
* DescribeDBInstanceURL返回参数结构体
|
|
3061
3095
|
*/
|
|
3062
|
-
export interface
|
|
3096
|
+
export interface DescribeDBInstanceURLResponse {
|
|
3063
3097
|
/**
|
|
3064
|
-
*
|
|
3098
|
+
* 实例 URI 形式的连接串访问地址示例。包含:URI 类型及连接串地址。
|
|
3065
3099
|
*/
|
|
3066
|
-
|
|
3100
|
+
Urls?: Array<DbURL>
|
|
3101
|
+
/**
|
|
3102
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
3103
|
+
*/
|
|
3104
|
+
RequestId?: string
|
|
3067
3105
|
}
|
|
3068
3106
|
|
|
3069
3107
|
/**
|
|
@@ -3141,6 +3179,16 @@ export interface RestartNodesResponse {
|
|
|
3141
3179
|
RequestId?: string
|
|
3142
3180
|
}
|
|
3143
3181
|
|
|
3182
|
+
/**
|
|
3183
|
+
* DescribeDBInstanceURL请求参数结构体
|
|
3184
|
+
*/
|
|
3185
|
+
export interface DescribeDBInstanceURLRequest {
|
|
3186
|
+
/**
|
|
3187
|
+
* 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb#/)在实例列表复制实例 ID。
|
|
3188
|
+
*/
|
|
3189
|
+
InstanceId: string
|
|
3190
|
+
}
|
|
3191
|
+
|
|
3144
3192
|
/**
|
|
3145
3193
|
* DescribeDBInstanceParamTplDetail请求参数结构体
|
|
3146
3194
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
|
|
2
|
-
import { DescribeSpecInfoRequest, CreateDBInstanceRequest, CreateDBInstanceParamTplResponse, DescribeAccountUsersRequest, DescribeDBInstanceParamTplRequest, CreateBackupDBInstanceResponse, KillOpsRequest, InquirePriceRenewDBInstancesRequest, DescribeSlowLogsRequest, FlushInstanceRouterConfigResponse, DescribeCurrentOpResponse, ModifyInstanceParamsResponse, SetInstanceMaintenanceResponse, DescribeBackupRulesResponse, AssignProjectResponse, DescribeDBInstanceDealResponse, OfflineIsolatedDBInstanceResponse, IsolateDBInstanceResponse, CreateDBInstanceParamTplRequest, DescribeSecurityGroupRequest, RenameInstanceRequest, DescribeBackupRulesRequest, DescribeBackupDownloadTaskResponse, FlushInstanceRouterConfigRequest, SetAccountUserPrivilegeResponse, ModifyDBInstanceNetworkAddressRequest, CreateDBInstanceHourResponse, DropDBInstanceParamTplResponse, EnableTransparentDataEncryptionRequest, DeleteAccountUserRequest, ModifyDBInstanceNetworkAddressResponse, DropDBInstanceParamTplRequest, CreateAccountUserResponse, DescribeSlowLogPatternsResponse, DescribeSlowLogsResponse, InquirePriceModifyDBInstanceSpecRequest, DescribeDBInstancesRequest, ModifyDBInstanceSpecRequest, FlashBackDBInstanceRequest, TerminateDBInstancesResponse, ResetDBInstancePasswordRequest, DescribeAsyncRequestInfoResponse, CreateDBInstanceResponse, CreateAccountUserRequest, ModifyDBInstanceSecurityGroupRequest, DescribeAccountUsersResponse, DescribeBackupDownloadTaskRequest, DescribeClientConnectionsResponse, ModifyDBInstanceParamTplResponse, TerminateDBInstancesRequest, DescribeDBBackupsResponse, ModifyDBInstanceSecurityGroupResponse, DescribeInstanceParamsRequest, InquirePriceCreateDBInstancesResponse, DescribeSecurityGroupResponse, ResetDBInstancePasswordResponse, DescribeDBInstanceDealRequest, DescribeAsyncRequestInfoRequest, CreateBackupDownloadTaskRequest, InquirePriceModifyDBInstanceSpecResponse, DescribeDBInstanceNodePropertyResponse, DescribeDBInstanceParamTplDetailResponse, ModifyDBInstanceParamTplRequest, DescribeCurrentOpRequest, DescribeDBBackupsRequest, DescribeClientConnectionsRequest, SetBackupRulesResponse, DescribeDBInstanceNodePropertyRequest, RenewDBInstancesResponse, FlashBackDBInstanceResponse, RenameInstanceResponse, DescribeTransparentDataEncryptionStatusResponse, CreateBackupDBInstanceRequest, SetAccountUserPrivilegeRequest, KillOpsResponse, IsolateDBInstanceRequest, CreateDBInstanceHourRequest, EnableTransparentDataEncryptionResponse, SetBackupRulesRequest, AssignProjectRequest, ModifyInstanceParamsRequest, CreateBackupDownloadTaskResponse, DescribeSlowLogPatternsRequest, DescribeSpecInfoResponse, InquirePriceRenewDBInstancesResponse, DeleteAccountUserResponse, DescribeDBInstancesResponse, OfflineIsolatedDBInstanceRequest, InquirePriceCreateDBInstancesRequest, DescribeInstanceParamsResponse, DescribeDBInstanceParamTplResponse,
|
|
2
|
+
import { DescribeSpecInfoRequest, CreateDBInstanceRequest, CreateDBInstanceParamTplResponse, DescribeAccountUsersRequest, DescribeDBInstanceParamTplRequest, CreateBackupDBInstanceResponse, KillOpsRequest, InquirePriceRenewDBInstancesRequest, DescribeSlowLogsRequest, FlushInstanceRouterConfigResponse, DescribeCurrentOpResponse, ModifyInstanceParamsResponse, SetInstanceMaintenanceResponse, DescribeBackupRulesResponse, AssignProjectResponse, DescribeDBInstanceDealResponse, OfflineIsolatedDBInstanceResponse, IsolateDBInstanceResponse, CreateDBInstanceParamTplRequest, DescribeSecurityGroupRequest, RenameInstanceRequest, DescribeBackupRulesRequest, DescribeBackupDownloadTaskResponse, FlushInstanceRouterConfigRequest, SetAccountUserPrivilegeResponse, ModifyDBInstanceNetworkAddressRequest, CreateDBInstanceHourResponse, DropDBInstanceParamTplResponse, EnableTransparentDataEncryptionRequest, DeleteAccountUserRequest, ModifyDBInstanceNetworkAddressResponse, DropDBInstanceParamTplRequest, CreateAccountUserResponse, DescribeSlowLogPatternsResponse, DescribeSlowLogsResponse, InquirePriceModifyDBInstanceSpecRequest, DescribeDBInstancesRequest, ModifyDBInstanceSpecRequest, FlashBackDBInstanceRequest, TerminateDBInstancesResponse, ResetDBInstancePasswordRequest, DescribeAsyncRequestInfoResponse, CreateDBInstanceResponse, CreateAccountUserRequest, ModifyDBInstanceSecurityGroupRequest, DescribeAccountUsersResponse, DescribeBackupDownloadTaskRequest, DescribeClientConnectionsResponse, ModifyDBInstanceParamTplResponse, TerminateDBInstancesRequest, DescribeDBBackupsResponse, ModifyDBInstanceSecurityGroupResponse, DescribeInstanceParamsRequest, InquirePriceCreateDBInstancesResponse, DescribeSecurityGroupResponse, DescribeTransparentDataEncryptionStatusRequest, ResetDBInstancePasswordResponse, DescribeDBInstanceDealRequest, DescribeAsyncRequestInfoRequest, CreateBackupDownloadTaskRequest, InquirePriceModifyDBInstanceSpecResponse, DescribeDBInstanceNodePropertyResponse, DescribeDBInstanceParamTplDetailResponse, ModifyDBInstanceParamTplRequest, DescribeCurrentOpRequest, DescribeDBBackupsRequest, DescribeClientConnectionsRequest, SetBackupRulesResponse, DescribeDBInstanceNodePropertyRequest, RenewDBInstancesResponse, FlashBackDBInstanceResponse, RenameInstanceResponse, DescribeTransparentDataEncryptionStatusResponse, CreateBackupDBInstanceRequest, SetAccountUserPrivilegeRequest, KillOpsResponse, IsolateDBInstanceRequest, CreateDBInstanceHourRequest, EnableTransparentDataEncryptionResponse, SetBackupRulesRequest, AssignProjectRequest, ModifyInstanceParamsRequest, CreateBackupDownloadTaskResponse, DescribeSlowLogPatternsRequest, DescribeSpecInfoResponse, InquirePriceRenewDBInstancesResponse, DeleteAccountUserResponse, DescribeDBInstancesResponse, OfflineIsolatedDBInstanceRequest, InquirePriceCreateDBInstancesRequest, DescribeInstanceParamsResponse, DescribeDBInstanceParamTplResponse, DescribeDBInstanceURLResponse, RestartNodesRequest, SetInstanceMaintenanceRequest, RestartNodesResponse, DescribeDBInstanceURLRequest, DescribeDBInstanceParamTplDetailRequest, ModifyDBInstanceSpecResponse, RenewDBInstancesRequest } from "./mongodb_models";
|
|
3
3
|
/**
|
|
4
4
|
* mongodb client
|
|
5
5
|
* @class
|
|
@@ -10,6 +10,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
10
10
|
* 本接口(TerminateDBInstances)可将包年包月实例退还隔离。
|
|
11
11
|
*/
|
|
12
12
|
TerminateDBInstances(req: TerminateDBInstancesRequest, cb?: (error: string, rep: TerminateDBInstancesResponse) => void): Promise<TerminateDBInstancesResponse>;
|
|
13
|
+
/**
|
|
14
|
+
* 本接口(DescribeDBInstanceURL)用于获取指定实例的 URI 形式的连接串访问地址示例。
|
|
15
|
+
*/
|
|
16
|
+
DescribeDBInstanceURL(req: DescribeDBInstanceURLRequest, cb?: (error: string, rep: DescribeDBInstanceURLResponse) => void): Promise<DescribeDBInstanceURLResponse>;
|
|
13
17
|
/**
|
|
14
18
|
* 本接口用于查询节点的属性,包括节点所在可用区、节点名称、地址、角色、状态、主从延迟、优先级、投票权、标签等属性。
|
|
15
19
|
*/
|
|
@@ -33,6 +33,12 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
33
33
|
async TerminateDBInstances(req, cb) {
|
|
34
34
|
return this.request("TerminateDBInstances", req, cb);
|
|
35
35
|
}
|
|
36
|
+
/**
|
|
37
|
+
* 本接口(DescribeDBInstanceURL)用于获取指定实例的 URI 形式的连接串访问地址示例。
|
|
38
|
+
*/
|
|
39
|
+
async DescribeDBInstanceURL(req, cb) {
|
|
40
|
+
return this.request("DescribeDBInstanceURL", req, cb);
|
|
41
|
+
}
|
|
36
42
|
/**
|
|
37
43
|
* 本接口用于查询节点的属性,包括节点所在可用区、节点名称、地址、角色、状态、主从延迟、优先级、投票权、标签等属性。
|
|
38
44
|
*/
|
|
@@ -1648,6 +1648,15 @@ export interface DescribeSecurityGroupResponse {
|
|
|
1648
1648
|
*/
|
|
1649
1649
|
RequestId?: string;
|
|
1650
1650
|
}
|
|
1651
|
+
/**
|
|
1652
|
+
* DescribeTransparentDataEncryptionStatus请求参数结构体
|
|
1653
|
+
*/
|
|
1654
|
+
export interface DescribeTransparentDataEncryptionStatusRequest {
|
|
1655
|
+
/**
|
|
1656
|
+
* 指定实例 ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
|
|
1657
|
+
*/
|
|
1658
|
+
InstanceId: string;
|
|
1659
|
+
}
|
|
1651
1660
|
/**
|
|
1652
1661
|
* 安全组信息
|
|
1653
1662
|
*/
|
|
@@ -2590,6 +2599,29 @@ export interface CreateBackupDownloadTaskResponse {
|
|
|
2590
2599
|
*/
|
|
2591
2600
|
RequestId?: string;
|
|
2592
2601
|
}
|
|
2602
|
+
/**
|
|
2603
|
+
* 数据库实例 URI 形式的连接串访问地址示例。
|
|
2604
|
+
*/
|
|
2605
|
+
export interface DbURL {
|
|
2606
|
+
/**
|
|
2607
|
+
* 指 URI 类别,包括:,
|
|
2608
|
+
- CLUSTER_ALL:指通过该 URI 连接库实例的主节点,可读写。
|
|
2609
|
+
- CLUSTER_READ_READONLY:指通过该 URI 连接实例只读节点。
|
|
2610
|
+
- CLUSTER_READ_SECONDARY:指通过该 URI 连接实例从节点。
|
|
2611
|
+
- CLUSTER_READ_SECONDARY_AND_READONLY:指通过该 URI 连接实例只读从节点。
|
|
2612
|
+
- CLUSTER_PRIMARY_AND_SECONDARY:指通过该 URI 连接实例 主节点与从节点。
|
|
2613
|
+
- MONGOS_ALL:指通过该 URI 连接每个 Mongos 节点,可读写。
|
|
2614
|
+
- MONGOS_READ_READONLY:指通过该 URI 连接 Mongos 的只读节点。
|
|
2615
|
+
- MONGOS_READ_SECONDARY:指通过该 URI 连接 Mongos 的从节点。
|
|
2616
|
+
- MONGOS_READ_PRIMARY_AND_SECONDARY:指通过该URI 连接 Mongos 的主节点与从节点。
|
|
2617
|
+
- MONGOS_READ_SECONDARY_AND_READONLY:指通过该URI 连接 Mongos 的从节点与只读节点。
|
|
2618
|
+
*/
|
|
2619
|
+
URLType: string;
|
|
2620
|
+
/**
|
|
2621
|
+
* 实例 URI 形式的连接串访问地址示例。
|
|
2622
|
+
*/
|
|
2623
|
+
Address: string;
|
|
2624
|
+
}
|
|
2593
2625
|
/**
|
|
2594
2626
|
* 实例规格信息
|
|
2595
2627
|
*/
|
|
@@ -2915,13 +2947,17 @@ export interface DescribeDBInstanceParamTplResponse {
|
|
|
2915
2947
|
RequestId?: string;
|
|
2916
2948
|
}
|
|
2917
2949
|
/**
|
|
2918
|
-
*
|
|
2950
|
+
* DescribeDBInstanceURL返回参数结构体
|
|
2919
2951
|
*/
|
|
2920
|
-
export interface
|
|
2952
|
+
export interface DescribeDBInstanceURLResponse {
|
|
2921
2953
|
/**
|
|
2922
|
-
*
|
|
2954
|
+
* 实例 URI 形式的连接串访问地址示例。包含:URI 类型及连接串地址。
|
|
2923
2955
|
*/
|
|
2924
|
-
|
|
2956
|
+
Urls?: Array<DbURL>;
|
|
2957
|
+
/**
|
|
2958
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
2959
|
+
*/
|
|
2960
|
+
RequestId?: string;
|
|
2925
2961
|
}
|
|
2926
2962
|
/**
|
|
2927
2963
|
* 修改实例节点详情
|
|
@@ -2994,6 +3030,15 @@ export interface RestartNodesResponse {
|
|
|
2994
3030
|
*/
|
|
2995
3031
|
RequestId?: string;
|
|
2996
3032
|
}
|
|
3033
|
+
/**
|
|
3034
|
+
* DescribeDBInstanceURL请求参数结构体
|
|
3035
|
+
*/
|
|
3036
|
+
export interface DescribeDBInstanceURLRequest {
|
|
3037
|
+
/**
|
|
3038
|
+
* 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb#/)在实例列表复制实例 ID。
|
|
3039
|
+
*/
|
|
3040
|
+
InstanceId: string;
|
|
3041
|
+
}
|
|
2997
3042
|
/**
|
|
2998
3043
|
* DescribeDBInstanceParamTplDetail请求参数结构体
|
|
2999
3044
|
*/
|