feat: getService 对齐 api 参数 (#201)

tencentyun · Apr 2, 2024 · 7d26c42 · 7d26c42
1 parent dc5251e
commit 7d26c42
Show file tree

Hide file tree

Showing 5 changed files with 54 additions and 6 deletions.
diff --git a/demo/demo.js b/demo/demo.js
@@ -91,11 +91,14 @@ function getObjectUrl() {
 }
 
 function getService() {
-  cos.getService(
-    {
-      Region: 'ap-guangzhou',
-    },
-    function (err, data) {
+  cos.getService({
+      // Region: 'ap-beijing',
+      CreateRange: 'lt',
+      CreateTime: 1642662645,
+      // TagKey: 'k1',
+      // TagValue: 'v1',
+      MaxKeys: 20,
+    }, function (err, data) {
       console.log(err || data);
     }
   );

diff --git a/index.d.ts b/index.d.ts
@@ -351,6 +351,18 @@ declare namespace COS {
     Region?: Region;
     /** 发请求时带上的 Header 字段 */
     Headers?: Headers;
+    /** 传入标签键 */
+    TagKey?: string;
+    /** 传入标签值 */
+    TagValue?: string;
+    /** GMT 时间戳，和 CreateRange 参数一起使用，支持根据创建时间过滤存储桶 */
+    CreateTime?: number;
+    /** 和 CreateTime 参数一起使用，支持根据创建时间过滤存储桶 */
+    CreateRange?: 'lt' | 'gt' | 'lte' | 'gte' | string;
+    /** 起始标记，从该标记之后（不含）按照 UTF-8 字典序返回存储桶条目 */
+    Marker?: string;
+    /** 单次返回最大的条目数量，默认值为2000，最大为2000 */
+    MaxKeys?: number;
   }
   /** getService 接口返回值 */
   interface GetServiceResult extends GeneralResult {

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "cos-nodejs-sdk-v5",
-  "version": "2.13.3",
+  "version": "2.13.4",
   "description": "cos nodejs sdk v5",
   "main": "index.js",
   "types": "index.d.ts",

diff --git a/sdk/base.js b/sdk/base.js
@@ -52,6 +52,14 @@ function getService(params, callback) {
       method: 'GET',
       headers: params.Headers,
       SignHost: SignHost,
+      qs: {
+        tagkey: params.TagKey,
+        tagvalue: params.TagValue,
+        'create-time': params.CreateTime,
+        range: params.CreateRange,
+        marker: params.Marker,
+        'max-keys': params.MaxKeys,
+      },
     },
     function (err, data) {
       if (err) return callback(err);

diff --git a/test/test.js b/test/test.js
@@ -393,6 +393,31 @@ group('getService()', function () {
       })
       .catch(function () {});
   });
+  test('能正常列出 Bucket 多参数', function (done, assert) {
+    prepareBucket()
+      .then(function () {
+        cos.getService(
+          {
+            Region: config.Region,
+            CreateRange: 'gt',
+            CreateTime: 1642662645,
+            MaxKeys: 2000,
+          },
+          function (err, data) {
+            var hasBucket = false;
+            data.Buckets &&
+              data.Buckets.forEach(function (item) {
+                if (item.Name === BucketLongName && (item.Location === config.Region || !item.Location)) {
+                  hasBucket = true;
+                }
+              });
+            assert.ok(hasBucket);
+            done();
+          }
+        );
+      })
+      .catch(function () {});
+  });
 });
 
 group('putBucket()', function () {