@alicloud/dds20151201 8.3.0 → 8.4.0

package/dist/client.js

@@ -50,7 +50,7 @@ class Client extends openapi_core_1.default {
         super(config);
         this._endpointRule = "regional";
         this._endpointMap = {
-            'cn-qingdao': "mongodb.aliyuncs.com",
+            'cn-qingdao': "mongodb.cn-qingdao.aliyuncs.com",
             'cn-beijing': "mongodb.aliyuncs.com",
             'cn-zhangjiakou': "mongodb.cn-zhangjiakou.aliyuncs.com",
             'cn-huhehaote': "mongodb.cn-huhehaote.aliyuncs.com",
@@ -78,7 +78,7 @@ class Client extends openapi_core_1.default {
             'cn-shenzhen-finance-1': "mongodb.cn-shenzhen-finance-1.aliyuncs.com",
             'cn-north-2-gov-1': "mongodb.cn-north-2-gov-1.aliyuncs.com",
             'ap-northeast-2-pop': "mongodb.aliyuncs.com",
-            'cn-beijing-finance-1': "mongodb.aliyuncs.com",
+            'cn-beijing-finance-1': "mongodb.cn-beijing-finance-1.aliyuncs.com",
             'cn-beijing-finance-pop': "mongodb.aliyuncs.com",
             'cn-beijing-gov-1': "mongodb.aliyuncs.com",
             'cn-beijing-nu16-b01': "mongodb.aliyuncs.com",
@@ -123,6 +123,8 @@ class Client extends openapi_core_1.default {
         return openapi_core_2.OpenApiUtil.getEndpointRules(productId, regionId, endpointRule, network, suffix);
     }
     /**
+     * Applies for an SRV endpoint for an ApsaraDB for MongoDB instance.
+     *
      * @param request - AllocateDBInstanceSrvNetworkAddressRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns AllocateDBInstanceSrvNetworkAddressResponse
@@ -168,6 +170,8 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.AllocateDBInstanceSrvNetworkAddressResponse({}));
     }
     /**
+     * Applies for an SRV endpoint for an ApsaraDB for MongoDB instance.
+     *
      * @param request - AllocateDBInstanceSrvNetworkAddressRequest
      * @returns AllocateDBInstanceSrvNetworkAddressResponse
      */
@@ -351,7 +355,7 @@ class Client extends openapi_core_1.default {
         return await this.cancelActiveOperationTasksWithOptions(request, runtime);
     }
     /**
-     * You can call this operation to check whether KMS keys are authorized to ApsaraDB for MongoDB instances.
+     * Checks whether Key Management Service (KMS) keys are authorized to an ApsaraDB for MongoDB instance.
      *
      * @remarks
      * Before you enable Transparent Data Encryption (TDE) by calling the [ModifyDBInstanceTDE](https://help.aliyun.com/document_detail/131267.html) operation, you can call this operation to check whether KMS keys are authorized to ApsaraDB for MongoDB instances.
@@ -398,7 +402,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.CheckCloudResourceAuthorizedResponse({}));
     }
     /**
-     * You can call this operation to check whether KMS keys are authorized to ApsaraDB for MongoDB instances.
+     * Checks whether Key Management Service (KMS) keys are authorized to an ApsaraDB for MongoDB instance.
      *
      * @remarks
      * Before you enable Transparent Data Encryption (TDE) by calling the [ModifyDBInstanceTDE](https://help.aliyun.com/document_detail/131267.html) operation, you can call this operation to check whether KMS keys are authorized to ApsaraDB for MongoDB instances.
@@ -500,7 +504,7 @@ class Client extends openapi_core_1.default {
         return await this.checkRecoveryConditionWithOptions(request, runtime);
     }
     /**
-     * Queries whether a service-linked role is created.
+     * Checks whether a service-linked role (SLR) is created for an instance.
      *
      * @param request - CheckServiceLinkedRoleRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -535,7 +539,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.CheckServiceLinkedRoleResponse({}));
     }
     /**
-     * Queries whether a service-linked role is created.
+     * Checks whether a service-linked role (SLR) is created for an instance.
      *
      * @param request - CheckServiceLinkedRoleRequest
      * @returns CheckServiceLinkedRoleResponse
@@ -1293,7 +1297,7 @@ class Client extends openapi_core_1.default {
         return await this.createShardingDBInstanceWithOptions(request, runtime);
     }
     /**
-     * 删除MongoDB备份集
+     * Deletes the backup set of MongoDB.
      *
      * @param request - DeleteBackupRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1337,7 +1341,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteBackupResponse({}));
     }
     /**
-     * 删除MongoDB备份集
+     * Deletes the backup set of MongoDB.
      *
      * @param request - DeleteBackupRequest
      * @returns DeleteBackupResponse
@@ -1765,6 +1769,8 @@ class Client extends openapi_core_1.default {
         return await this.describeActiveOperationTaskCountWithOptions(request, runtime);
     }
     /**
+     * Query maintenance task types and task quantities.
+     *
      * @param request - DescribeActiveOperationTaskRegionRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns DescribeActiveOperationTaskRegionResponse
@@ -1807,6 +1813,8 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeActiveOperationTaskRegionResponse({}));
     }
     /**
+     * Query maintenance task types and task quantities.
+     *
      * @param request - DescribeActiveOperationTaskRegionRequest
      * @returns DescribeActiveOperationTaskRegionResponse
      */
@@ -2277,7 +2285,7 @@ class Client extends openapi_core_1.default {
         return await this.describeAvailabilityZonesWithOptions(request, runtime);
     }
     /**
-     * You can call this operation to query the engine versions to which an ApsaraDB for MongoDB instance can be upgraded.
+     * Queries the engine versions to which an ApsaraDB for MongoDB instance can be upgraded.
      *
      * @param request - DescribeAvailableEngineVersionRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -2318,7 +2326,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeAvailableEngineVersionResponse({}));
     }
     /**
-     * You can call this operation to query the engine versions to which an ApsaraDB for MongoDB instance can be upgraded.
+     * Queries the engine versions to which an ApsaraDB for MongoDB instance can be upgraded.
      *
      * @param request - DescribeAvailableEngineVersionRequest
      * @returns DescribeAvailableEngineVersionResponse
@@ -2550,7 +2558,7 @@ class Client extends openapi_core_1.default {
         return await this.describeBackupPolicyWithOptions(request, runtime);
     }
     /**
-     * Queries the storage used for backup in an ApsaraDB for MongoDB replica set or sharded cluster instance that uses cloud disks. Note that you are charged only for the backup-used storage of each shard in a sharded cluster instance. You can call this operation only to query the storage used by a single shard in the instance for backup.
+     * Queries the backup storage capacity of an ApsaraDB for MongoDB replica set or sharded cluster instance that uses cloud disks.
      *
      * @param request - DescribeBackupStorageRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -2597,7 +2605,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeBackupStorageResponse({}));
     }
     /**
-     * Queries the storage used for backup in an ApsaraDB for MongoDB replica set or sharded cluster instance that uses cloud disks. Note that you are charged only for the backup-used storage of each shard in a sharded cluster instance. You can call this operation only to query the storage used by a single shard in the instance for backup.
+     * Queries the backup storage capacity of an ApsaraDB for MongoDB replica set or sharded cluster instance that uses cloud disks.
      *
      * @param request - DescribeBackupStorageRequest
      * @returns DescribeBackupStorageResponse
@@ -2744,6 +2752,87 @@ class Client extends openapi_core_1.default {
         let runtime = new $dara.RuntimeOptions({});
         return await this.describeBackupsWithOptions(request, runtime);
     }
+    /**
+     * Queries binary log files bound to an ApsaraDB for MongoDB instance.
+     *
+     * @param request - DescribeBinlogFilesRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DescribeBinlogFilesResponse
+     */
+    async describeBinlogFilesWithOptions(request, runtime) {
+        request.validate();
+        let query = {};
+        if (!$dara.isNull(request.binlogId)) {
+            query["BinlogId"] = request.binlogId;
+        }
+        if (!$dara.isNull(request.DBInstanceId)) {
+            query["DBInstanceId"] = request.DBInstanceId;
+        }
+        if (!$dara.isNull(request.destRegion)) {
+            query["DestRegion"] = request.destRegion;
+        }
+        if (!$dara.isNull(request.endTime)) {
+            query["EndTime"] = request.endTime;
+        }
+        if (!$dara.isNull(request.nodeId)) {
+            query["NodeId"] = request.nodeId;
+        }
+        if (!$dara.isNull(request.ownerAccount)) {
+            query["OwnerAccount"] = request.ownerAccount;
+        }
+        if (!$dara.isNull(request.ownerId)) {
+            query["OwnerId"] = request.ownerId;
+        }
+        if (!$dara.isNull(request.pageNumber)) {
+            query["PageNumber"] = request.pageNumber;
+        }
+        if (!$dara.isNull(request.pageSize)) {
+            query["PageSize"] = request.pageSize;
+        }
+        if (!$dara.isNull(request.regionId)) {
+            query["RegionId"] = request.regionId;
+        }
+        if (!$dara.isNull(request.resourceGroupId)) {
+            query["ResourceGroupId"] = request.resourceGroupId;
+        }
+        if (!$dara.isNull(request.resourceOwnerAccount)) {
+            query["ResourceOwnerAccount"] = request.resourceOwnerAccount;
+        }
+        if (!$dara.isNull(request.resourceOwnerId)) {
+            query["ResourceOwnerId"] = request.resourceOwnerId;
+        }
+        if (!$dara.isNull(request.srcRegion)) {
+            query["SrcRegion"] = request.srcRegion;
+        }
+        if (!$dara.isNull(request.startTime)) {
+            query["StartTime"] = request.startTime;
+        }
+        let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
+            query: openapi_core_2.OpenApiUtil.query(query),
+        });
+        let params = new openapi_core_2.$OpenApiUtil.Params({
+            action: "DescribeBinlogFiles",
+            version: "2015-12-01",
+            protocol: "HTTPS",
+            pathname: "/",
+            method: "POST",
+            authType: "AK",
+            style: "RPC",
+            reqBodyType: "formData",
+            bodyType: "json",
+        });
+        return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeBinlogFilesResponse({}));
+    }
+    /**
+     * Queries binary log files bound to an ApsaraDB for MongoDB instance.
+     *
+     * @param request - DescribeBinlogFilesRequest
+     * @returns DescribeBinlogFilesResponse
+     */
+    async describeBinlogFiles(request) {
+        let runtime = new $dara.RuntimeOptions({});
+        return await this.describeBinlogFilesWithOptions(request, runtime);
+    }
     /**
      * Queries the backup sets of an ApsaraDB for MongoDB sharded cluster instance that uses cloud disks.
      *
@@ -3214,7 +3303,7 @@ class Client extends openapi_core_1.default {
         return await this.describeDBInstanceSSLWithOptions(request, runtime);
     }
     /**
-     * 查看规格信息详情
+     * Queries the specifications of an ApsaraDB for MongoDB instance.
      *
      * @param request - DescribeDBInstanceSpecInfoRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -3258,7 +3347,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeDBInstanceSpecInfoResponse({}));
     }
     /**
-     * 查看规格信息详情
+     * Queries the specifications of an ApsaraDB for MongoDB instance.
      *
      * @param request - DescribeDBInstanceSpecInfoRequest
      * @returns DescribeDBInstanceSpecInfoResponse
@@ -4951,7 +5040,7 @@ class Client extends openapi_core_1.default {
         return await this.describeRoleZoneInfoWithOptions(request, runtime);
     }
     /**
-     * Queries entries in operational logs of an ApsaraDB for MongoDB instance.
+     * Queries the operational logs of an ApsaraDB for MongoDB instance.
      *
      * @remarks
      *   This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
@@ -5032,7 +5121,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeRunningLogRecordsResponse({}));
     }
     /**
-     * Queries entries in operational logs of an ApsaraDB for MongoDB instance.
+     * Queries the operational logs of an ApsaraDB for MongoDB instance.
      *
      * @remarks
      *   This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
@@ -5046,7 +5135,7 @@ class Client extends openapi_core_1.default {
         return await this.describeRunningLogRecordsWithOptions(request, runtime);
     }
     /**
-     * You can call this operation to query ECS security groups that are bound to an ApsaraDB for MongoDB instance.
+     * Queries the Elastic Compute Service (ECS) security groups that are associated with an ApsaraDB for MongoDB instance.
      *
      * @param request - DescribeSecurityGroupConfigurationRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -5087,7 +5176,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeSecurityGroupConfigurationResponse({}));
     }
     /**
-     * You can call this operation to query ECS security groups that are bound to an ApsaraDB for MongoDB instance.
+     * Queries the Elastic Compute Service (ECS) security groups that are associated with an ApsaraDB for MongoDB instance.
      *
      * @param request - DescribeSecurityGroupConfigurationRequest
      * @returns DescribeSecurityGroupConfigurationResponse
@@ -5918,6 +6007,8 @@ class Client extends openapi_core_1.default {
         return await this.modifyAccountDescriptionWithOptions(request, runtime);
     }
     /**
+     * Modifies the O\\\\\\&M task configurations for an instance.
+     *
      * @param request - ModifyActiveOperationMaintenanceConfigRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns ModifyActiveOperationMaintenanceConfigResponse
@@ -5969,6 +6060,8 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifyActiveOperationMaintenanceConfigResponse({}));
     }
     /**
+     * Modifies the O\\\\\\&M task configurations for an instance.
+     *
      * @param request - ModifyActiveOperationMaintenanceConfigRequest
      * @returns ModifyActiveOperationMaintenanceConfigResponse
      */
@@ -5977,7 +6070,7 @@ class Client extends openapi_core_1.default {
         return await this.modifyActiveOperationMaintenanceConfigWithOptions(request, runtime);
     }
     /**
-     * Modifies the switching time of scheduled O\\\\\\&M tasks for an ApsaraDB for MongoDB instance.
+     * Modifies the switching time of scheduled O\\\\\\\\\\\\&M tasks for an ApsaraDB for MongoDB instance.
      *
      * @param request - ModifyActiveOperationTasksRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -6027,7 +6120,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifyActiveOperationTasksResponse({}));
     }
     /**
-     * Modifies the switching time of scheduled O\\\\\\&M tasks for an ApsaraDB for MongoDB instance.
+     * Modifies the switching time of scheduled O\\\\\\\\\\\\&M tasks for an ApsaraDB for MongoDB instance.
      *
      * @param request - ModifyActiveOperationTasksRequest
      * @returns ModifyActiveOperationTasksResponse
@@ -6126,6 +6219,9 @@ class Client extends openapi_core_1.default {
         if (!$dara.isNull(request.DBInstanceId)) {
             query["DBInstanceId"] = request.DBInstanceId;
         }
+        if (!$dara.isNull(request.hotStoragePeriod)) {
+            query["HotStoragePeriod"] = request.hotStoragePeriod;
+        }
         if (!$dara.isNull(request.ownerAccount)) {
             query["OwnerAccount"] = request.ownerAccount;
         }
@@ -6175,7 +6271,7 @@ class Client extends openapi_core_1.default {
         return await this.modifyAuditPolicyWithOptions(request, runtime);
     }
     /**
-     * 修改MongoDB备份集的过期时间
+     * Modifies the expiration time of MongoDB backup sets
      *
      * @param request - ModifyBackupExpireTimeRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -6222,7 +6318,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifyBackupExpireTimeResponse({}));
     }
     /**
-     * 修改MongoDB备份集的过期时间
+     * Modifies the expiration time of MongoDB backup sets
      *
      * @param request - ModifyBackupExpireTimeRequest
      * @returns ModifyBackupExpireTimeResponse
@@ -6349,6 +6445,8 @@ class Client extends openapi_core_1.default {
         return await this.modifyBackupPolicyWithOptions(request, runtime);
     }
     /**
+     * Modifies existing release protection configurations.
+     *
      * @param request - ModifyDBInstanceAttributeRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns ModifyDBInstanceAttributeResponse
@@ -6391,6 +6489,8 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifyDBInstanceAttributeResponse({}));
     }
     /**
+     * Modifies existing release protection configurations.
+     *
      * @param request - ModifyDBInstanceAttributeRequest
      * @returns ModifyDBInstanceAttributeResponse
      */
@@ -6399,7 +6499,7 @@ class Client extends openapi_core_1.default {
         return await this.modifyDBInstanceAttributeWithOptions(request, runtime);
     }
     /**
-     * 修改实例配置
+     * Modifies the configurations of an ApsaraDB for MongoDB instance.
      *
      * @param request - ModifyDBInstanceConfigRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -6446,7 +6546,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifyDBInstanceConfigResponse({}));
     }
     /**
-     * 修改实例配置
+     * Modifies the configurations of an ApsaraDB for MongoDB instance.
      *
      * @param request - ModifyDBInstanceConfigRequest
      * @returns ModifyDBInstanceConfigResponse
@@ -6476,6 +6576,12 @@ class Client extends openapi_core_1.default {
         if (!$dara.isNull(request.DBInstanceId)) {
             query["DBInstanceId"] = request.DBInstanceId;
         }
+        if (!$dara.isNull(request.forceModifySuffix)) {
+            query["ForceModifySuffix"] = request.forceModifySuffix;
+        }
+        if (!$dara.isNull(request.networkType)) {
+            query["NetworkType"] = request.networkType;
+        }
         if (!$dara.isNull(request.newConnectionString)) {
             query["NewConnectionString"] = request.newConnectionString;
         }
@@ -6491,6 +6597,9 @@ class Client extends openapi_core_1.default {
         if (!$dara.isNull(request.ownerId)) {
             query["OwnerId"] = request.ownerId;
         }
+        if (!$dara.isNull(request.portModifyOnly)) {
+            query["PortModifyOnly"] = request.portModifyOnly;
+        }
         if (!$dara.isNull(request.resourceOwnerAccount)) {
             query["ResourceOwnerAccount"] = request.resourceOwnerAccount;
         }
@@ -7968,7 +8077,7 @@ class Client extends openapi_core_1.default {
         return await this.modifySecurityIpsWithOptions(request, runtime);
     }
     /**
-     * 修改MongoDB实例的SRV连接地址
+     * Modifies the SRV connection string that is used to connect to an ApsaraDB for MongoDB instance.
      *
      * @param request - ModifySrvNetworkAddressRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -8015,7 +8124,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifySrvNetworkAddressResponse({}));
     }
     /**
-     * 修改MongoDB实例的SRV连接地址
+     * Modifies the SRV connection string that is used to connect to an ApsaraDB for MongoDB instance.
      *
      * @param request - ModifySrvNetworkAddressRequest
      * @returns ModifySrvNetworkAddressResponse