tencentcloud-sdk-nodejs-chdfs 4.0.1027 → 4.0.1049
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
@@ -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
@@ -1,7 +1,7 @@
|
|
1
1
|
{
|
2
2
|
"name": "tencentcloud-sdk-nodejs-chdfs",
|
3
|
-
"version": "4.0.
|
4
|
-
"description": "
|
3
|
+
"version": "4.0.1049",
|
4
|
+
"description": "腾讯云 API NODEJS SDK",
|
5
5
|
"main": "tencentcloud/index.js",
|
6
6
|
"scripts": {
|
7
7
|
"test": "mocha -t 10000",
|
@@ -22,7 +22,7 @@
|
|
22
22
|
"author": "tencentcloudapi",
|
23
23
|
"license": "Apache-2.0",
|
24
24
|
"dependencies": {
|
25
|
-
"tencentcloud-sdk-nodejs-common": "
|
25
|
+
"tencentcloud-sdk-nodejs-common": "*",
|
26
26
|
"tslib": "1.13.0"
|
27
27
|
},
|
28
28
|
"directories": {
|
@@ -35,14 +35,19 @@
|
|
35
35
|
},
|
36
36
|
"devDependencies": {
|
37
37
|
"@types/form-data": "^2.5.0",
|
38
|
+
"@types/json-bigint": "^1.0.1",
|
38
39
|
"@types/node": "^14.0.26",
|
39
40
|
"@types/node-fetch": "^2.5.7",
|
41
|
+
"@types/uuid": "^9.0.8",
|
40
42
|
"@typescript-eslint/eslint-plugin": "^2.34.0",
|
41
43
|
"@typescript-eslint/parser": "^2.34.0",
|
44
|
+
"babel-eslint": "^10.0.2",
|
42
45
|
"chai": "^4.2.0",
|
43
46
|
"eslint": "^6.8.0",
|
47
|
+
"eslint-plugin-react": "^7.17.0",
|
44
48
|
"mocha": "^8.1.1",
|
49
|
+
"prettier": "^2.3.0",
|
45
50
|
"ts-node": "^8.10.2",
|
46
51
|
"typescript": "^3.9.7"
|
47
52
|
}
|
48
|
-
}
|
53
|
+
}
|
@@ -89,32 +89,26 @@ export interface DescribeFileSystemResponse {
|
|
89
89
|
FileSystem?: FileSystem
|
90
90
|
/**
|
91
91
|
* 文件系统已使用容量(byte)
|
92
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
93
92
|
*/
|
94
93
|
CapacityUsed?: number
|
95
94
|
/**
|
96
95
|
* 已使用COS归档存储容量(byte)
|
97
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
98
96
|
*/
|
99
97
|
ArchiveCapacityUsed?: number
|
100
98
|
/**
|
101
99
|
* 已使用COS标准存储容量(byte)
|
102
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
103
100
|
*/
|
104
101
|
StandardCapacityUsed?: number
|
105
102
|
/**
|
106
103
|
* 已使用COS低频存储容量(byte)
|
107
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
108
104
|
*/
|
109
105
|
DegradeCapacityUsed?: number
|
110
106
|
/**
|
111
107
|
* 已使用COS深度归档存储容量(byte)
|
112
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
113
108
|
*/
|
114
109
|
DeepArchiveCapacityUsed?: number
|
115
110
|
/**
|
116
111
|
* 已使用COS智能分层存储容量(byte)
|
117
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
118
112
|
*/
|
119
113
|
IntelligentCapacityUsed?: number
|
120
114
|
/**
|
@@ -68,32 +68,26 @@ export interface DescribeFileSystemResponse {
|
|
68
68
|
FileSystem?: FileSystem;
|
69
69
|
/**
|
70
70
|
* 文件系统已使用容量(byte)
|
71
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
72
71
|
*/
|
73
72
|
CapacityUsed?: number;
|
74
73
|
/**
|
75
74
|
* 已使用COS归档存储容量(byte)
|
76
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
77
75
|
*/
|
78
76
|
ArchiveCapacityUsed?: number;
|
79
77
|
/**
|
80
78
|
* 已使用COS标准存储容量(byte)
|
81
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
82
79
|
*/
|
83
80
|
StandardCapacityUsed?: number;
|
84
81
|
/**
|
85
82
|
* 已使用COS低频存储容量(byte)
|
86
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
87
83
|
*/
|
88
84
|
DegradeCapacityUsed?: number;
|
89
85
|
/**
|
90
86
|
* 已使用COS深度归档存储容量(byte)
|
91
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
92
87
|
*/
|
93
88
|
DeepArchiveCapacityUsed?: number;
|
94
89
|
/**
|
95
90
|
* 已使用COS智能分层存储容量(byte)
|
96
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
97
91
|
*/
|
98
92
|
IntelligentCapacityUsed?: number;
|
99
93
|
/**
|