@alicloud/apig20240327 9.1.1 → 9.3.0

package/src/models/CreateMcpServerRequest.ts

@@ -14,7 +14,7 @@ export class CreateMcpServerRequestAssembledSources extends $dara.Model {
   mcpServerId?: string;
   /**
    * @remarks
-   * Source MCP server name
+   * The MCP server name.
    * 
    * @example
    * test-mcp
@@ -22,7 +22,7 @@ export class CreateMcpServerRequestAssembledSources extends $dara.Model {
   mcpServerName?: string;
   /**
    * @remarks
-   * List of tool names to include
+   * The list of MCP tools.
    */
   tools?: string[];
   static names(): { [key: string]: string } {
@@ -56,7 +56,7 @@ export class CreateMcpServerRequestAssembledSources extends $dara.Model {
 export class CreateMcpServerRequestBackendConfigServices extends $dara.Model {
   /**
    * @remarks
-   * Service port
+   * The backend node port of the service.
    * 
    * @example
    * 8080
@@ -64,7 +64,9 @@ export class CreateMcpServerRequestBackendConfigServices extends $dara.Model {
   port?: number;
   /**
    * @remarks
-   * Service protocol
+   * The service protocol. Valid values:
+   * - HTTP.
+   * - HTTPS.
    * 
    * @example
    * HTTP
@@ -72,7 +74,7 @@ export class CreateMcpServerRequestBackendConfigServices extends $dara.Model {
   protocol?: string;
   /**
    * @remarks
-   * Service ID
+   * The service ID.
    * 
    * @example
    * svc-crbgq0dlhtgr***
@@ -80,7 +82,7 @@ export class CreateMcpServerRequestBackendConfigServices extends $dara.Model {
   serviceId?: string;
   /**
    * @remarks
-   * Service version
+   * The service version.
    * 
    * @example
    * 2.1.6
@@ -88,7 +90,7 @@ export class CreateMcpServerRequestBackendConfigServices extends $dara.Model {
   version?: string;
   /**
    * @remarks
-   * Service weight
+   * The weight.
    * 
    * @example
    * 49
@@ -126,7 +128,7 @@ export class CreateMcpServerRequestBackendConfigServices extends $dara.Model {
 export class CreateMcpServerRequestBackendConfig extends $dara.Model {
   /**
    * @remarks
-   * Backend scene type
+   * The backend service scenario.
    * 
    * @example
    * SingleService
@@ -134,7 +136,7 @@ export class CreateMcpServerRequestBackendConfig extends $dara.Model {
   scene?: string;
   /**
    * @remarks
-   * List of backend services
+   * The backend services.
    */
   services?: CreateMcpServerRequestBackendConfigServices[];
   static names(): { [key: string]: string } {
@@ -166,7 +168,7 @@ export class CreateMcpServerRequestBackendConfig extends $dara.Model {
 export class CreateMcpServerRequestGrayMcpServerConfigsBackendConfigServices extends $dara.Model {
   /**
    * @remarks
-   * Service port number
+   * The service port.
    * 
    * @example
    * 8080
@@ -174,7 +176,7 @@ export class CreateMcpServerRequestGrayMcpServerConfigsBackendConfigServices ext
   port?: number;
   /**
    * @remarks
-   * Service protocol type
+   * The service protocol.
    * 
    * @example
    * HTTP
@@ -182,7 +184,7 @@ export class CreateMcpServerRequestGrayMcpServerConfigsBackendConfigServices ext
   protocol?: string;
   /**
    * @remarks
-   * Service ID
+   * The service ID.
    * 
    * @example
    * svc-gray
@@ -190,7 +192,7 @@ export class CreateMcpServerRequestGrayMcpServerConfigsBackendConfigServices ext
   serviceId?: string;
   /**
    * @remarks
-   * Service version
+   * The service version.
    * 
    * @example
    * v2.0.0
@@ -198,7 +200,7 @@ export class CreateMcpServerRequestGrayMcpServerConfigsBackendConfigServices ext
   version?: string;
   /**
    * @remarks
-   * Service weight for load balancing
+   * The service weight.
    * 
    * @example
    * 100
@@ -236,7 +238,7 @@ export class CreateMcpServerRequestGrayMcpServerConfigsBackendConfigServices ext
 export class CreateMcpServerRequestGrayMcpServerConfigsBackendConfig extends $dara.Model {
   /**
    * @remarks
-   * Must be SingleService
+   * The backend scenario.
    * 
    * @example
    * SingleService
@@ -244,7 +246,7 @@ export class CreateMcpServerRequestGrayMcpServerConfigsBackendConfig extends $da
   scene?: string;
   /**
    * @remarks
-   * Exactly one service
+   * The backend services.
    */
   services?: CreateMcpServerRequestGrayMcpServerConfigsBackendConfigServices[];
   static names(): { [key: string]: string } {
@@ -276,17 +278,17 @@ export class CreateMcpServerRequestGrayMcpServerConfigsBackendConfig extends $da
 export class CreateMcpServerRequestGrayMcpServerConfigs extends $dara.Model {
   /**
    * @remarks
-   * Backend configuration for gray route
+   * The backend configuration.
    */
   backendConfig?: CreateMcpServerRequestGrayMcpServerConfigsBackendConfig;
   /**
    * @remarks
-   * Route matching rules
+   * The route match rule.
    */
   match?: HttpRouteMatch;
   /**
    * @remarks
-   * Route ID for update operations
+   * The route ID.
    * 
    * @example
    * gray-route-123
@@ -326,7 +328,7 @@ export class CreateMcpServerRequestGrayMcpServerConfigs extends $dara.Model {
 export class CreateMcpServerRequestMcpServerConfig extends $dara.Model {
   /**
    * @remarks
-   * Converted MCP server spec YAML
+   * The MCP server spec configuration. This parameter is mutually exclusive with swaggerConfig.
    * 
    * @example
    * mcp-spec.yaml
@@ -334,7 +336,7 @@ export class CreateMcpServerRequestMcpServerConfig extends $dara.Model {
   mcpServerSpec?: string;
   /**
    * @remarks
-   * Raw Swagger/OpenAPI document
+   * The Swagger document for HTTP-to-MCP conversion. The document must comply with the OpenAPI 3.0 specification.
    * 
    * @example
    * swagger.yaml
@@ -366,17 +368,23 @@ export class CreateMcpServerRequestMcpServerConfig extends $dara.Model {
 export class CreateMcpServerRequest extends $dara.Model {
   /**
    * @remarks
-   * Assembled MCP server sources
+   * The list of assembled sources. This parameter is required when type is set to AssemblyMCP.
    */
   assembledSources?: CreateMcpServerRequestAssembledSources[];
   /**
    * @remarks
-   * Backend configuration
+   * The backend service configuration of the route.
    */
   backendConfig?: CreateMcpServerRequestBackendConfig;
   /**
    * @remarks
-   * Creation source type
+   * The creation source type. Valid values:
+   * 
+   * - ApiGatewayHttpToMCP: gateway-managed HTTP-to-MCP conversion.
+   * - ApiGatewayProxyMcpHosting: gateway-managed direct MCP proxy.
+   * - ApiGatewayAssembly: gateway MCP assembly.
+   * - NacosHttpToMCP: gateway-managed Nacos-synced HTTP-to-MCP conversion.
+   * - NacosMcpHosting: gateway-managed Nacos-synced direct MCP proxy.
    * 
    * @example
    * ApiGatewayMcpHosting
@@ -384,7 +392,7 @@ export class CreateMcpServerRequest extends $dara.Model {
   createFromType?: string;
   /**
    * @remarks
-   * MCP server description
+   * The description of the MCP server.
    * 
    * @example
    * mcp tool fetch time
@@ -392,12 +400,12 @@ export class CreateMcpServerRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * List of domain IDs for the MCP server
+   * The domain name IDs.
    */
   domainIds?: string[];
   /**
    * @remarks
-   * Exposed URI path for SSE/StreamableHTTP protocols
+   * The exposed URI path. This parameter is required when protocol is set to SSE or StreamableHTTP and type is set to RealMCP.
    * 
    * @example
    * /sse
@@ -405,7 +413,7 @@ export class CreateMcpServerRequest extends $dara.Model {
   exposedUriPath?: string;
   /**
    * @remarks
-   * Gateway ID
+   * The gateway ID.
    * 
    * This parameter is required.
    * 
@@ -415,22 +423,22 @@ export class CreateMcpServerRequest extends $dara.Model {
   gatewayId?: string;
   /**
    * @remarks
-   * Gray route configurations
+   * The canary release routing configurations.
    */
   grayMcpServerConfigs?: CreateMcpServerRequestGrayMcpServerConfigs[];
   /**
    * @remarks
-   * Route matching conditions
+   * The route match rule.
    */
   match?: HttpRouteMatch;
   /**
    * @remarks
-   * MCP server specification
+   * The HTTP-to-MCP configuration.
    */
   mcpServerConfig?: CreateMcpServerRequestMcpServerConfig;
   /**
    * @remarks
-   * Enable MCP statistics
+   * Specifies whether to enable MCP observability. Default value: false.
    * 
    * @example
    * false
@@ -438,7 +446,7 @@ export class CreateMcpServerRequest extends $dara.Model {
   mcpStatisticsEnable?: boolean;
   /**
    * @remarks
-   * MCP server name
+   * The MCP server name. The name must match the regular expression ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ and cannot exceed 64 characters in length.
    * 
    * This parameter is required.
    * 
@@ -448,7 +456,7 @@ export class CreateMcpServerRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * MCP protocol
+   * The protocol type. Valid values: HTTP, HTTPS, SSE, and StreamableHTTP.
    * 
    * @example
    * HTTP
@@ -456,7 +464,9 @@ export class CreateMcpServerRequest extends $dara.Model {
   protocol?: string;
   /**
    * @remarks
-   * MCP server type
+   * The type. Valid values:
+   * 
+   * - RealMCP: standard MCP service.
    * 
    * This parameter is required.
    * 

package/src/models/CreateMcpServerResponseBody.ts

@@ -13,7 +13,7 @@ export class CreateMcpServerResponseBodyData extends $dara.Model {
   mcpServerId?: string;
   /**
    * @remarks
-   * MCP server name
+   * The MCP server name.
    * 
    * @example
    * test-mcp
@@ -45,7 +45,7 @@ export class CreateMcpServerResponseBodyData extends $dara.Model {
 export class CreateMcpServerResponseBody extends $dara.Model {
   /**
    * @remarks
-   * code
+   * The response status code.
    * 
    * @example
    * Ok
@@ -53,12 +53,12 @@ export class CreateMcpServerResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * object
+   * The response data.
    */
   data?: CreateMcpServerResponseBodyData;
   /**
    * @remarks
-   * message
+   * The response message.
    * 
    * @example
    * success

package/src/models/CreatePluginAttachmentRequest.ts

@@ -5,12 +5,12 @@ import * as $dara from '@darabonba/typescript';
 export class CreatePluginAttachmentRequest extends $dara.Model {
   /**
    * @remarks
-   * The attachment IDs.
+   * The list of mount point IDs.
    */
   attachResourceIds?: string[];
   /**
    * @remarks
-   * The type of the resource to which the plug-in is attached. Valid values: GatewayRoute, Gateway, GatewayDomain, HttpApi, and Operation.
+   * The resource type to which the plug-in is mounted. Valid values: GatewayRoute, Gateway, GatewayDomain, HttpApi, and Operation.
    * 
    * @example
    * HttpApi
@@ -34,7 +34,7 @@ export class CreatePluginAttachmentRequest extends $dara.Model {
   environmentId?: string;
   /**
    * @remarks
-   * The instance ID.
+   * The gateway instance ID.
    * 
    * @example
    * gw-cq7l5s5lhtg***
@@ -42,7 +42,7 @@ export class CreatePluginAttachmentRequest extends $dara.Model {
   gatewayId?: string;
   /**
    * @remarks
-   * The Base64-encoded configurations of the plug-in.
+   * The Base64-encoded content of the original plug-in configuration.
    * 
    * @example
    * cHJlcGVuZDoKLSByb2xlOiBzeXN0ZW0KICBjb250ZW50OiDor7fkvb/nlKjoi7Hor63lm57nrZTpl67popgKYXBwZW5kOgotIHJvbGU6IHVzZXIKICBjb250ZW50OiDmr4/mrKHlm57nrZTlrozpl67popjvvIzlsJ3or5Xov5vooYzlj43pl64K

package/src/models/CreatePluginAttachmentResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreatePluginAttachmentResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The plug-in ID.
+   * The plug-in mount ID.
    * 
    * @example
    * pa-cvs7jpmm1hkgihaqv4a0
@@ -35,7 +35,7 @@ export class CreatePluginAttachmentResponseBodyData extends $dara.Model {
 export class CreatePluginAttachmentResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The status code.
+   * The response status code.
    * 
    * @example
    * Ok
@@ -43,12 +43,12 @@ export class CreatePluginAttachmentResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The returned data.
+   * The response data.
    */
   data?: CreatePluginAttachmentResponseBodyData;
   /**
    * @remarks
-   * The response message returned.
+   * The response message.
    * 
    * @example
    * success
@@ -56,7 +56,7 @@ export class CreatePluginAttachmentResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The request ID.
+   * Id of the request
    * 
    * @example
    * EBCB8485-24F9-54CD-B258-CB15FDB27677

package/src/models/CreatePluginClassRequest.ts

@@ -0,0 +1,82 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CreatePluginClassRequest extends $dara.Model {
+  alias?: string;
+  /**
+   * @remarks
+   * This parameter is required.
+   */
+  description?: string;
+  executePriority?: number;
+  /**
+   * @remarks
+   * This parameter is required.
+   */
+  executeStage?: string;
+  /**
+   * @remarks
+   * This parameter is required.
+   */
+  name?: string;
+  supportedMinGatewayVersion?: string;
+  /**
+   * @remarks
+   * This parameter is required.
+   */
+  version?: string;
+  /**
+   * @remarks
+   * This parameter is required.
+   */
+  versionDescription?: string;
+  /**
+   * @remarks
+   * This parameter is required.
+   */
+  wasmLanguage?: string;
+  /**
+   * @remarks
+   * This parameter is required.
+   */
+  wasmUrl?: string;
+  static names(): { [key: string]: string } {
+    return {
+      alias: 'alias',
+      description: 'description',
+      executePriority: 'executePriority',
+      executeStage: 'executeStage',
+      name: 'name',
+      supportedMinGatewayVersion: 'supportedMinGatewayVersion',
+      version: 'version',
+      versionDescription: 'versionDescription',
+      wasmLanguage: 'wasmLanguage',
+      wasmUrl: 'wasmUrl',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      alias: 'string',
+      description: 'string',
+      executePriority: 'number',
+      executeStage: 'string',
+      name: 'string',
+      supportedMinGatewayVersion: 'string',
+      version: 'string',
+      versionDescription: 'string',
+      wasmLanguage: 'string',
+      wasmUrl: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreatePluginClassResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { CreatePluginClassResponseBody } from "./CreatePluginClassResponseBody";
+
+
+export class CreatePluginClassResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: CreatePluginClassResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: CreatePluginClassResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreatePluginClassResponseBody.ts

@@ -0,0 +1,66 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CreatePluginClassResponseBodyData extends $dara.Model {
+  pluginClassId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      pluginClassId: 'pluginClassId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      pluginClassId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class CreatePluginClassResponseBody extends $dara.Model {
+  code?: string;
+  data?: CreatePluginClassResponseBodyData;
+  message?: string;
+  /**
+   * @remarks
+   * Id of the request
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      code: 'code',
+      data: 'data',
+      message: 'message',
+      requestId: 'requestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      code: 'string',
+      data: CreatePluginClassResponseBodyData,
+      message: 'string',
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    if(this.data && typeof (this.data as any).validate === 'function') {
+      (this.data as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreatePolicyRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreatePolicyRequest extends $dara.Model {
   /**
    * @remarks
-   * Policy type, including RateLimit, ConcurrencyLimit, CircuitBreaker, HttpRewrite, HeaderModify, Cors, Authentication, FlowCopy, Timeout, Retry, IpAccessControl, DirectResponse, Redirect, Fallback, ServiceTls, ServiceLb, ServicePortTls, Waf, JWTAuth, OIDCAuth, ExternalZAuth, AiProxy, ModelRouter, AiStatistics, AiSecurityGuard, AiFallback, ModelMapper, AiTokenRateLimit, AiCache, DynamicRoute
+   * The policy type. Valid values: RateLimit, ConcurrencyLimit, CircuitBreaker, HttpRewrite, HeaderModify, Cors, Authentication, FlowCopy, Timeout, Retry, IpAccessControl, DirectResponse, Redirect, Fallback, ServiceTls, ServiceLb, ServicePortTls, Waf, JWTAuth, OIDCAuth, ExternalZAuth, AiProxy, ModelRouter, AiStatistics, AiSecurityGuard, AiFallback, ModelMapper, AiTokenRateLimit, AiCache, DynamicRoute.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class CreatePolicyRequest extends $dara.Model {
   className?: string;
   /**
    * @remarks
-   * Policy configuration
+   * The policy configuration.
    * 
    * This parameter is required.
    * 
@@ -25,7 +25,7 @@ export class CreatePolicyRequest extends $dara.Model {
   config?: string;
   /**
    * @remarks
-   * Policy description
+   * The description of the policy.
    * 
    * @example
    * 超时策略
@@ -33,7 +33,7 @@ export class CreatePolicyRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * Policy name
+   * The policy name.
    * 
    * This parameter is required.
    * 

package/src/models/CreatePolicyResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreatePolicyResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * Policy ID
+   * The policy ID.
    * 
    * @example
    * p-cq7l5s5lhtgi6qasr***
@@ -35,7 +35,7 @@ export class CreatePolicyResponseBodyData extends $dara.Model {
 export class CreatePolicyResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Response status code.
+   * The response status code.
    * 
    * @example
    * Ok
@@ -43,12 +43,12 @@ export class CreatePolicyResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * Response data.
+   * The response data.
    */
   data?: CreatePolicyResponseBodyData;
   /**
    * @remarks
-   * Response message.
+   * The response message.
    * 
    * @example
    * success
@@ -56,7 +56,7 @@ export class CreatePolicyResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * ID of the request
+   * Id of the request
    * 
    * @example
    * 393E2630-DBE7-5221-AB35-9E7406754***