@alicloud/dms20250414 2.0.0 → 2.1.1

package/dist/client.d.ts

@@ -134,6 +134,21 @@ export default class Client extends OpenApi {
      * @returns ConfigDataAgentMemoryResponse
      */
     configDataAgentMemory(request: $_model.ConfigDataAgentMemoryRequest): Promise<$_model.ConfigDataAgentMemoryResponse>;
+    /**
+     * Creates a Database Gateway agent identity.
+     *
+     * @param request - CreateAgentRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns CreateAgentResponse
+     */
+    createAgentWithOptions(request: $_model.CreateAgentRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateAgentResponse>;
+    /**
+     * Creates a Database Gateway agent identity.
+     *
+     * @param request - CreateAgentRequest
+     * @returns CreateAgentResponse
+     */
+    createAgent(request: $_model.CreateAgentRequest): Promise<$_model.CreateAgentResponse>;
     /**
      * Creates an Airflow instance in a workspace.
      *
@@ -231,7 +246,7 @@ export default class Client extends OpenApi {
      */
     createDataAgentKnowledgeBase(request: $_model.CreateDataAgentKnowledgeBaseRequest): Promise<$_model.CreateDataAgentKnowledgeBaseResponse>;
     /**
-     * Create a DataAgent session
+     * Creates a DataAgent session.
      *
      * @param tmpReq - CreateDataAgentSessionRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -239,7 +254,7 @@ export default class Client extends OpenApi {
      */
     createDataAgentSessionWithOptions(tmpReq: $_model.CreateDataAgentSessionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateDataAgentSessionResponse>;
     /**
-     * Create a DataAgent session
+     * Creates a DataAgent session.
      *
      * @param request - CreateDataAgentSessionRequest
      * @returns CreateDataAgentSessionResponse
@@ -708,7 +723,7 @@ export default class Client extends OpenApi {
      */
     describeDataAgentSession(request: $_model.DescribeDataAgentSessionRequest): Promise<$_model.DescribeDataAgentSessionResponse>;
     /**
-     * Invokes the DescribeDataAgentTheme operation to query the details of a single DataAgent theme, including the theme name, stage, source, common scenarios, description, and creation and modification time.
+     * Invokes the DescribeDataAgentTheme operation to query the details of a specific DataAgent theme, including the theme name, stage, source, common scenarios, description, and creation and modification time.
      *
      * @param request - DescribeDataAgentThemeRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -716,7 +731,7 @@ export default class Client extends OpenApi {
      */
     describeDataAgentThemeWithOptions(request: $_model.DescribeDataAgentThemeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeDataAgentThemeResponse>;
     /**
-     * Invokes the DescribeDataAgentTheme operation to query the details of a single DataAgent theme, including the theme name, stage, source, common scenarios, description, and creation and modification time.
+     * Invokes the DescribeDataAgentTheme operation to query the details of a specific DataAgent theme, including the theme name, stage, source, common scenarios, description, and creation and modification time.
      *
      * @param request - DescribeDataAgentThemeRequest
      * @returns DescribeDataAgentThemeResponse
@@ -954,7 +969,7 @@ export default class Client extends OpenApi {
     getDataAgentTaskModelUsageMetrics(request: $_model.GetDataAgentTaskModelUsageMetricsRequest): Promise<$_model.GetDataAgentTaskModelUsageMetricsResponse>;
     /**
      * Calls the GetDataAgentThemeUploadSignature operation to obtain OSS direct upload credentials for uploading a DataAgent theme file. After obtaining the credentials, use the PostObject method to upload the theme file directly to OSS. After the upload is complete, call the CreateDataAgentTheme operation with the returned ThemeId to complete theme creation.
-     * Refer to https://www.alibabacloud.com/help/en/oss/user-guide/client-direct-transmission/ for instructions on uploading the theme file.
+     * For more information, see https://www.alibabacloud.com/help/en/oss/user-guide/client-direct-transmission/.
      *
      * @param request - GetDataAgentThemeUploadSignatureRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -963,7 +978,7 @@ export default class Client extends OpenApi {
     getDataAgentThemeUploadSignatureWithOptions(request: $_model.GetDataAgentThemeUploadSignatureRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetDataAgentThemeUploadSignatureResponse>;
     /**
      * Calls the GetDataAgentThemeUploadSignature operation to obtain OSS direct upload credentials for uploading a DataAgent theme file. After obtaining the credentials, use the PostObject method to upload the theme file directly to OSS. After the upload is complete, call the CreateDataAgentTheme operation with the returned ThemeId to complete theme creation.
-     * Refer to https://www.alibabacloud.com/help/en/oss/user-guide/client-direct-transmission/ for instructions on uploading the theme file.
+     * For more information, see https://www.alibabacloud.com/help/en/oss/user-guide/client-direct-transmission/.
      *
      * @param request - GetDataAgentThemeUploadSignatureRequest
      * @returns GetDataAgentThemeUploadSignatureResponse
@@ -1429,7 +1444,7 @@ export default class Client extends OpenApi {
      */
     listDataAgentSkillMeta(request: $_model.ListDataAgentSkillMetaRequest): Promise<$_model.ListDataAgentSkillMetaResponse>;
     /**
-     * Invokes the ListDataAgentTheme operation to query the DataAgent theme list by paging. You can filter themes by theme stage, source, and common scenarios.
+     * Calls the ListDataAgentTheme operation to query the DataAgent theme list by paging. You can filter results by theme stage, source, and common scenario.
      *
      * @param request - ListDataAgentThemeRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1437,7 +1452,7 @@ export default class Client extends OpenApi {
      */
     listDataAgentThemeWithOptions(request: $_model.ListDataAgentThemeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListDataAgentThemeResponse>;
     /**
-     * Invokes the ListDataAgentTheme operation to query the DataAgent theme list by paging. You can filter themes by theme stage, source, and common scenarios.
+     * Calls the ListDataAgentTheme operation to query the DataAgent theme list by paging. You can filter results by theme stage, source, and common scenario.
      *
      * @param request - ListDataAgentThemeRequest
      * @returns ListDataAgentThemeResponse
@@ -1801,7 +1816,7 @@ export default class Client extends OpenApi {
      */
     modifyDataAgentMcp(request: $_model.ModifyDataAgentMcpRequest): Promise<$_model.ModifyDataAgentMcpResponse>;
     /**
-     * Calls the ModifyDataAgentTheme operation to modify the display name and description of a DataAgent theme. Passing null for a parameter value indicates that the corresponding field is not modified. Passing an empty string clears the field.
+     * Modifies the display name and description of a DataAgent theme. A null parameter value indicates that the corresponding field is not modified, and an empty string clears the field.
      *
      * @param request - ModifyDataAgentThemeRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1809,7 +1824,7 @@ export default class Client extends OpenApi {
      */
     modifyDataAgentThemeWithOptions(request: $_model.ModifyDataAgentThemeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifyDataAgentThemeResponse>;
     /**
-     * Calls the ModifyDataAgentTheme operation to modify the display name and description of a DataAgent theme. Passing null for a parameter value indicates that the corresponding field is not modified. Passing an empty string clears the field.
+     * Modifies the display name and description of a DataAgent theme. A null parameter value indicates that the corresponding field is not modified, and an empty string clears the field.
      *
      * @param request - ModifyDataAgentThemeRequest
      * @returns ModifyDataAgentThemeResponse

package/dist/client.js

@@ -508,6 +508,54 @@ class Client extends openapi_core_1.default {
         let runtime = new $dara.RuntimeOptions({});
         return await this.configDataAgentMemoryWithOptions(request, runtime);
     }
+    /**
+     * Creates a Database Gateway agent identity.
+     *
+     * @param request - CreateAgentRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns CreateAgentResponse
+     */
+    async createAgentWithOptions(request, runtime) {
+        request.validate();
+        let query = {};
+        if (!$dara.isNull(request.agentName)) {
+            query["AgentName"] = request.agentName;
+        }
+        if (!$dara.isNull(request.agentType)) {
+            query["AgentType"] = request.agentType;
+        }
+        if (!$dara.isNull(request.description)) {
+            query["Description"] = request.description;
+        }
+        if (!$dara.isNull(request.expireAfterSeconds)) {
+            query["ExpireAfterSeconds"] = request.expireAfterSeconds;
+        }
+        let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
+            query: openapi_core_2.OpenApiUtil.query(query),
+        });
+        let params = new openapi_core_2.$OpenApiUtil.Params({
+            action: "CreateAgent",
+            version: "2025-04-14",
+            protocol: "HTTPS",
+            pathname: "/",
+            method: "POST",
+            authType: "AK",
+            style: "RPC",
+            reqBodyType: "formData",
+            bodyType: "json",
+        });
+        return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateAgentResponse({}));
+    }
+    /**
+     * Creates a Database Gateway agent identity.
+     *
+     * @param request - CreateAgentRequest
+     * @returns CreateAgentResponse
+     */
+    async createAgent(request) {
+        let runtime = new $dara.RuntimeOptions({});
+        return await this.createAgentWithOptions(request, runtime);
+    }
     /**
      * Creates an Airflow instance in a workspace.
      *
@@ -951,7 +999,7 @@ class Client extends openapi_core_1.default {
         return await this.createDataAgentKnowledgeBaseWithOptions(request, runtime);
     }
     /**
-     * Create a DataAgent session
+     * Creates a DataAgent session.
      *
      * @param tmpReq - CreateDataAgentSessionRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -997,7 +1045,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateDataAgentSessionResponse({}));
     }
     /**
-     * Create a DataAgent session
+     * Creates a DataAgent session.
      *
      * @param request - CreateDataAgentSessionRequest
      * @returns CreateDataAgentSessionResponse
@@ -1082,6 +1130,9 @@ class Client extends openapi_core_1.default {
         if (!$dara.isNull(request.themeType)) {
             query["ThemeType"] = request.themeType;
         }
+        if (!$dara.isNull(request.workspaceId)) {
+            query["WorkspaceId"] = request.workspaceId;
+        }
         let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
             query: openapi_core_2.OpenApiUtil.query(query),
         });
@@ -2476,7 +2527,7 @@ class Client extends openapi_core_1.default {
         return await this.describeDataAgentSessionWithOptions(request, runtime);
     }
     /**
-     * Invokes the DescribeDataAgentTheme operation to query the details of a single DataAgent theme, including the theme name, stage, source, common scenarios, description, and creation and modification time.
+     * Invokes the DescribeDataAgentTheme operation to query the details of a specific DataAgent theme, including the theme name, stage, source, common scenarios, description, and creation and modification time.
      *
      * @param request - DescribeDataAgentThemeRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -2505,7 +2556,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeDataAgentThemeResponse({}));
     }
     /**
-     * Invokes the DescribeDataAgentTheme operation to query the details of a single DataAgent theme, including the theme name, stage, source, common scenarios, description, and creation and modification time.
+     * Invokes the DescribeDataAgentTheme operation to query the details of a specific DataAgent theme, including the theme name, stage, source, common scenarios, description, and creation and modification time.
      *
      * @param request - DescribeDataAgentThemeRequest
      * @returns DescribeDataAgentThemeResponse
@@ -3200,7 +3251,7 @@ class Client extends openapi_core_1.default {
     }
     /**
      * Calls the GetDataAgentThemeUploadSignature operation to obtain OSS direct upload credentials for uploading a DataAgent theme file. After obtaining the credentials, use the PostObject method to upload the theme file directly to OSS. After the upload is complete, call the CreateDataAgentTheme operation with the returned ThemeId to complete theme creation.
-     * Refer to https://www.alibabacloud.com/help/en/oss/user-guide/client-direct-transmission/ for instructions on uploading the theme file.
+     * For more information, see https://www.alibabacloud.com/help/en/oss/user-guide/client-direct-transmission/.
      *
      * @param request - GetDataAgentThemeUploadSignatureRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -3230,7 +3281,7 @@ class Client extends openapi_core_1.default {
     }
     /**
      * Calls the GetDataAgentThemeUploadSignature operation to obtain OSS direct upload credentials for uploading a DataAgent theme file. After obtaining the credentials, use the PostObject method to upload the theme file directly to OSS. After the upload is complete, call the CreateDataAgentTheme operation with the returned ThemeId to complete theme creation.
-     * Refer to https://www.alibabacloud.com/help/en/oss/user-guide/client-direct-transmission/ for instructions on uploading the theme file.
+     * For more information, see https://www.alibabacloud.com/help/en/oss/user-guide/client-direct-transmission/.
      *
      * @param request - GetDataAgentThemeUploadSignatureRequest
      * @returns GetDataAgentThemeUploadSignatureResponse
@@ -4699,7 +4750,7 @@ class Client extends openapi_core_1.default {
         return await this.listDataAgentSkillMetaWithOptions(request, runtime);
     }
     /**
-     * Invokes the ListDataAgentTheme operation to query the DataAgent theme list by paging. You can filter themes by theme stage, source, and common scenarios.
+     * Calls the ListDataAgentTheme operation to query the DataAgent theme list by paging. You can filter results by theme stage, source, and common scenario.
      *
      * @param request - ListDataAgentThemeRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -4729,6 +4780,9 @@ class Client extends openapi_core_1.default {
         if (!$dara.isNull(request.themeType)) {
             query["ThemeType"] = request.themeType;
         }
+        if (!$dara.isNull(request.workspaceId)) {
+            query["WorkspaceId"] = request.workspaceId;
+        }
         let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
             query: openapi_core_2.OpenApiUtil.query(query),
         });
@@ -4746,7 +4800,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListDataAgentThemeResponse({}));
     }
     /**
-     * Invokes the ListDataAgentTheme operation to query the DataAgent theme list by paging. You can filter themes by theme stage, source, and common scenarios.
+     * Calls the ListDataAgentTheme operation to query the DataAgent theme list by paging. You can filter results by theme stage, source, and common scenario.
      *
      * @param request - ListDataAgentThemeRequest
      * @returns ListDataAgentThemeResponse
@@ -6159,7 +6213,7 @@ class Client extends openapi_core_1.default {
         return await this.modifyDataAgentMcpWithOptions(request, runtime);
     }
     /**
-     * Calls the ModifyDataAgentTheme operation to modify the display name and description of a DataAgent theme. Passing null for a parameter value indicates that the corresponding field is not modified. Passing an empty string clears the field.
+     * Modifies the display name and description of a DataAgent theme. A null parameter value indicates that the corresponding field is not modified, and an empty string clears the field.
      *
      * @param request - ModifyDataAgentThemeRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -6194,7 +6248,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifyDataAgentThemeResponse({}));
     }
     /**
-     * Calls the ModifyDataAgentTheme operation to modify the display name and description of a DataAgent theme. Passing null for a parameter value indicates that the corresponding field is not modified. Passing an empty string clears the field.
+     * Modifies the display name and description of a DataAgent theme. A null parameter value indicates that the corresponding field is not modified, and an empty string clears the field.
      *
      * @param request - ModifyDataAgentThemeRequest
      * @returns ModifyDataAgentThemeResponse