@alicloud/apig20240327 7.0.5 → 7.2.0

package/src/models/HttpApiDeployConfig.ts

@@ -10,15 +10,15 @@ import { HttpApiBackendMatchConditions } from "./HttpApiBackendMatchConditions";
 export class HttpApiDeployConfigCustomDomainInfos extends $dara.Model {
   /**
    * @remarks
-   * The domain name ID.
+   * Domain ID.
    * 
    * @example
-   * d-cshee6dlhtgkf4muio3g
+   * d-cshee6dlhtgk******
    */
   domainId?: string;
   /**
    * @remarks
-   * The domain name.
+   * Domain name.
    * 
    * @example
    * hello-server.com
@@ -26,7 +26,7 @@ export class HttpApiDeployConfigCustomDomainInfos extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The protocol.
+   * Protocol.
    * 
    * @example
    * HTTP
@@ -89,7 +89,7 @@ export class HttpApiDeployConfigEnvDomainInfos extends $dara.Model {
 export class HttpApiDeployConfigServiceConfigsObservabilityRouteConfig extends $dara.Model {
   /**
    * @remarks
-   * Routing mode
+   * Routing mode.
    * 
    * @example
    * LeastBusy
@@ -97,7 +97,7 @@ export class HttpApiDeployConfigServiceConfigsObservabilityRouteConfig extends $
   mode?: string;
   /**
    * @remarks
-   * Queue size
+   * Queue size.
    * 
    * @example
    * 100
@@ -105,7 +105,7 @@ export class HttpApiDeployConfigServiceConfigsObservabilityRouteConfig extends $
   queueSize?: number;
   /**
    * @remarks
-   * Max traffic ratio per single service
+   * Maximum traffic ratio for a single service.
    * 
    * @example
    * 0.8
@@ -139,7 +139,7 @@ export class HttpApiDeployConfigServiceConfigsObservabilityRouteConfig extends $
 export class HttpApiDeployConfigServiceConfigs extends $dara.Model {
   /**
    * @remarks
-   * Legacy gateway service ID for backward compatibility
+   * Gateway service ID.
    * 
    * @example
    * gw-svc-abc123
@@ -147,7 +147,7 @@ export class HttpApiDeployConfigServiceConfigs extends $dara.Model {
   gatewayServiceId?: string;
   /**
    * @remarks
-   * Intent classification code
+   * Intent code.
    * 
    * @example
    * INQUIRY
@@ -155,12 +155,12 @@ export class HttpApiDeployConfigServiceConfigs extends $dara.Model {
   intentCode?: string;
   /**
    * @remarks
-   * Match conditions
+   * Matching conditions.
    */
   match?: HttpApiBackendMatchConditions;
   /**
    * @remarks
-   * The model name.
+   * Model name.
    * 
    * @example
    * qwen-max
@@ -168,7 +168,7 @@ export class HttpApiDeployConfigServiceConfigs extends $dara.Model {
   modelName?: string;
   /**
    * @remarks
-   * The model name matching rule.
+   * Model name matching rule.
    * 
    * @example
    * qwen-*
@@ -176,7 +176,7 @@ export class HttpApiDeployConfigServiceConfigs extends $dara.Model {
   modelNamePattern?: string;
   /**
    * @remarks
-   * Multi-service routing strategy type
+   * Multi-service routing strategy type.
    * 
    * @example
    * ByWeight
@@ -184,7 +184,7 @@ export class HttpApiDeployConfigServiceConfigs extends $dara.Model {
   multiServiceRouteStrategy?: string;
   /**
    * @remarks
-   * Service display name
+   * Service display name.
    * 
    * @example
    * Qwen-Max-Service
@@ -192,7 +192,7 @@ export class HttpApiDeployConfigServiceConfigs extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * Observability metrics-based routing config
+   * Observability-based routing configuration.
    * 
    * **if can be null:**
    * true
@@ -200,7 +200,7 @@ export class HttpApiDeployConfigServiceConfigs extends $dara.Model {
   observabilityRouteConfig?: HttpApiDeployConfigServiceConfigsObservabilityRouteConfig;
   /**
    * @remarks
-   * Service port number
+   * Service port number.
    * 
    * @example
    * 80
@@ -208,7 +208,7 @@ export class HttpApiDeployConfigServiceConfigs extends $dara.Model {
   port?: number;
   /**
    * @remarks
-   * Service protocol
+   * Service protocol (HTTP/HTTPS).
    * 
    * @example
    * HTTP
@@ -216,7 +216,7 @@ export class HttpApiDeployConfigServiceConfigs extends $dara.Model {
   protocol?: string;
   /**
    * @remarks
-   * The service ID.
+   * Service ID.
    * 
    * @example
    * svc-xxx
@@ -224,15 +224,15 @@ export class HttpApiDeployConfigServiceConfigs extends $dara.Model {
   serviceId?: string;
   /**
    * @remarks
-   * Service version tag for tag-based routing scenarios
+   * Service version tag.
    * 
    * @example
-   * v2
+   * V2
    */
   version?: string;
   /**
    * @remarks
-   * The service weight.
+   * Service weight.
    * 
    * @example
    * 100
@@ -292,15 +292,15 @@ export class HttpApiDeployConfigServiceConfigs extends $dara.Model {
 export class HttpApiDeployConfigSubDomains extends $dara.Model {
   /**
    * @remarks
-   * The domain name ID.
+   * Domain ID.
    * 
    * @example
-   * d-csmn42um1hksudfk9eng
+   * d-csmn42um******
    */
   domainId?: string;
   /**
    * @remarks
-   * The domain name.
+   * Domain name.
    * 
    * @example
    * test
@@ -308,7 +308,7 @@ export class HttpApiDeployConfigSubDomains extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The network type.
+   * Network type.
    * 
    * @example
    * Intranet
@@ -316,7 +316,7 @@ export class HttpApiDeployConfigSubDomains extends $dara.Model {
   networkType?: string;
   /**
    * @remarks
-   * The protocol.
+   * Protocol.
    * 
    * @example
    * HTTP
@@ -352,7 +352,7 @@ export class HttpApiDeployConfigSubDomains extends $dara.Model {
 export class HttpApiDeployConfig extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to enable automatic deployment.
+   * Whether to enable automatic deployment.
    * 
    * @example
    * true
@@ -360,7 +360,7 @@ export class HttpApiDeployConfig extends $dara.Model {
   autoDeploy?: boolean;
   /**
    * @remarks
-   * The publishing scenario.
+   * Deployment scenario.
    * 
    * @example
    * SingleService
@@ -369,19 +369,19 @@ export class HttpApiDeployConfig extends $dara.Model {
   builtinRouteNames?: string[];
   /**
    * @remarks
-   * The IDs of the custom domain names.
+   * List of custom domain IDs.
    */
   customDomainIds?: string[];
   /**
    * @remarks
-   * The information about the custom domain names.
+   * List of custom domain details.
    */
   customDomainInfos?: HttpApiDeployConfigCustomDomainInfos[];
   envDomainIds?: string[];
   envDomainInfos?: HttpApiDeployConfigEnvDomainInfos[];
   /**
    * @remarks
-   * The environment ID.
+   * Environment ID.
    * 
    * @example
    * env-xxx
@@ -389,7 +389,7 @@ export class HttpApiDeployConfig extends $dara.Model {
   environmentId?: string;
   /**
    * @remarks
-   * The instance ID.
+   * Gateway instance ID.
    * 
    * @example
    * gw-xx
@@ -397,7 +397,7 @@ export class HttpApiDeployConfig extends $dara.Model {
   gatewayId?: string;
   /**
    * @remarks
-   * The instance information.
+   * Gateway information.
    * 
    * **if can be null:**
    * true
@@ -405,7 +405,7 @@ export class HttpApiDeployConfig extends $dara.Model {
   gatewayInfo?: GatewayInfo;
   /**
    * @remarks
-   * 网关类型
+   * Gateway type.
    * 
    * @example
    * API
@@ -413,7 +413,7 @@ export class HttpApiDeployConfig extends $dara.Model {
   gatewayType?: string;
   /**
    * @remarks
-   * The Mock settings.
+   * Mock configuration.
    * 
    * **if can be null:**
    * true
@@ -421,12 +421,12 @@ export class HttpApiDeployConfig extends $dara.Model {
   mock?: HttpApiMockContract;
   /**
    * @remarks
-   * The policy configurations.
+   * List of policy configurations.
    */
   policyConfigs?: HttpApiPolicyConfigs[];
   /**
    * @remarks
-   * routeBackend
+   * Backend service information.
    * 
    * **if can be null:**
    * true
@@ -434,12 +434,12 @@ export class HttpApiDeployConfig extends $dara.Model {
   routeBackend?: Backend;
   /**
    * @remarks
-   * The service configurations.
+   * List of service configurations.
    */
   serviceConfigs?: HttpApiDeployConfigServiceConfigs[];
   /**
    * @remarks
-   * The information about the sub-domain names.
+   * List of second-level domain details.
    */
   subDomains?: HttpApiDeployConfigSubDomains[];
   static names(): { [key: string]: string } {

package/src/models/HttpApiInfoByName.ts

@@ -5,6 +5,9 @@ import { HttpApiApiInfo } from "./HttpApiApiInfo";
 
 export class HttpApiInfoByName extends $dara.Model {
   /**
+   * @remarks
+   * 网关Id
+   * 
    * @example
    * gw-xx
    */

package/src/models/HttpApiMockContract.ts

@@ -24,7 +24,7 @@ export class HttpApiMockContract extends $dara.Model {
    * The response content.
    * 
    * @example
-   * Mock content.
+   * Mock测试
    */
   responseContent?: string;
   static names(): { [key: string]: string } {

package/src/models/HttpApiOperation.ts

@@ -23,7 +23,7 @@ export class HttpApiOperation extends $dara.Model {
    * The operation description.
    * 
    * @example
-   * This is a operation description.
+   * 获取用户信息
    */
   description?: string;
   /**

package/src/models/HttpApiOperationInfo.ts

@@ -31,7 +31,7 @@ export class HttpApiOperationInfo extends $dara.Model {
    * The operation description.
    * 
    * @example
-   * A example operation.
+   * 获取用户信息
    */
   description?: string;
   /**

package/src/models/HttpApiParameter.ts

@@ -16,7 +16,7 @@ export class HttpApiParameter extends $dara.Model {
    * The parameter description.
    * 
    * @example
-   * The example description.
+   * 用户ID
    */
   description?: string;
   /**

package/src/models/HttpApiPolicyConfigs.ts

@@ -101,7 +101,7 @@ export class HttpApiPolicyConfigs extends $dara.Model {
    * Policy Enable
    * 
    * @example
-   * true
+   * false
    */
   enable?: boolean;
   /**
@@ -117,7 +117,7 @@ export class HttpApiPolicyConfigs extends $dara.Model {
    * Policy Type
    * 
    * @example
-   * AiCache
+   * K8S
    */
   type?: string;
   static names(): { [key: string]: string } {

package/src/models/HttpApiPublishRevisionInfo.ts

@@ -369,7 +369,7 @@ export class HttpApiPublishRevisionInfoEnvironmentInfoGatewayInfo extends $dara.
    * The instance name.
    * 
    * @example
-   * Instance 1
+   * 实例1
    */
   name?: string;
   static names(): { [key: string]: string } {
@@ -401,7 +401,7 @@ export class HttpApiPublishRevisionInfoEnvironmentInfo extends $dara.Model {
    * The environment alias.
    * 
    * @example
-   * Test
+   * 测试
    */
   alias?: string;
   /**

package/src/models/HttpApiRequestContract.ts

@@ -17,7 +17,7 @@ export class HttpApiRequestContractBody extends $dara.Model {
    * The parameter description.
    * 
    * @example
-   * This is a description.
+   * body参数描述
    */
   description?: string;
   /**
@@ -34,17 +34,17 @@ export class HttpApiRequestContractBody extends $dara.Model {
    * 
    * @example
    * {
-   *       "type": "object",
-   *       "required": [
-   *           "result"
-   *       ],
-   *       "properties": {
-   *           "result": {
-   *               "type": "string",
-   *               "description": "Operation result. \\"ok\\" indicates success."
-   *           }
-   *       }
-   *   }
+   *     "type": "object",
+   *     "required": [
+   *         "result"
+   *     ],
+   *     "properties": {
+   *         "result": {
+   *             "type": "string",
+   *             "description": "操作结果，\\"ok\\" 表示成功"
+   *         }
+   *     }
+   * }
    */
   jsonSchema?: string;
   static names(): { [key: string]: string } {

package/src/models/HttpApiResponseContract.ts

@@ -16,7 +16,7 @@ export class HttpApiResponseContractItems extends $dara.Model {
    * The response description.
    * 
    * @example
-   * This is a description.
+   * 正常接口响应
    */
   description?: string;
   /**
@@ -40,7 +40,7 @@ export class HttpApiResponseContractItems extends $dara.Model {
    *     "properties": {
    *         "result": {
    *             "type": "string",
-   *             "description": "This is a description."
+   *             "description": "操作结果，\\"ok\\" 表示成功"
    *         }
    *     }
    * }

package/src/models/HttpRoute.ts

@@ -160,7 +160,7 @@ export class HttpRouteEnvironmentInfo extends $dara.Model {
    * The environment alias
    * 
    * @example
-   * prod
+   * 商品中心预发环境
    */
   alias?: string;
   /**
@@ -379,7 +379,7 @@ export class HttpRoute extends $dara.Model {
    * The description of the route
    * 
    * @example
-   * Route for user management API
+   * 商品中心预发路由
    */
   description?: string;
   /**

package/src/models/ImportHttpApiRequest.ts

@@ -7,15 +7,15 @@ import { HttpApiVersionConfig } from "./HttpApiVersionConfig";
 export class ImportHttpApiRequestSpecOssConfig extends $dara.Model {
   /**
    * @remarks
-   * The OSS bucket name.
+   * The name of the OSS bucket that contains the API definition file.
    * 
    * @example
-   * api-1
+   * gms-service-prod
    */
   bucketName?: string;
   /**
    * @remarks
-   * The full file path in OSS.
+   * The object key (file path) of the API definition file within the bucket.
    * 
    * @example
    * /test/swagger.json
@@ -23,10 +23,10 @@ export class ImportHttpApiRequestSpecOssConfig extends $dara.Model {
   objectKey?: string;
   /**
    * @remarks
-   * The region ID.
+   * The ID of the region where the OSS bucket is located.
    * 
    * @example
-   * cn-hangzhou
+   * cn-shanghai
    */
   regionId?: string;
   static names(): { [key: string]: string } {
@@ -57,20 +57,20 @@ export class ImportHttpApiRequestSpecOssConfig extends $dara.Model {
 export class ImportHttpApiRequest extends $dara.Model {
   /**
    * @remarks
-   * The API deployment configuration.
+   * The API deployment configurations.
    */
   deployConfigs?: HttpApiDeployConfig[];
   /**
    * @remarks
-   * The imported API description (255-byte limit). If not specified, a description is extracted from the API definition file. A maximum of 255 bytes is supported.
+   * The description of the API to import. If omitted, the description is taken from the API definition. The maximum length is 255 bytes.
    * 
    * @example
-   * API for testing
+   * 测试专用API
    */
   description?: string;
   /**
    * @remarks
-   * Specifies whether to perform a precheck. If set to true, a check is performed without actual import.
+   * Indicates whether to perform a dry run. If `true`, the system validates the request but does not import the API.
    * 
    * @example
    * false
@@ -78,7 +78,7 @@ export class ImportHttpApiRequest extends $dara.Model {
   dryRun?: boolean;
   /**
    * @remarks
-   * Gateway ID.
+   * The gateway ID.
    * 
    * @example
    * gw-xxx
@@ -94,7 +94,7 @@ export class ImportHttpApiRequest extends $dara.Model {
   mcpRouteId?: string;
   /**
    * @remarks
-   * The imported API name. If not specified, a name is extracted from the API definition file. If the API name and versioning configuration already exist, this import will update the existing API definition based on the strategy field.
+   * The name of the API to import. If omitted, the name is taken from the API definition file. If an API with the same name and versioning configuration already exists, the import acts as an update based on the specified `strategy`.
    * 
    * @example
    * import-test
@@ -105,12 +105,12 @@ export class ImportHttpApiRequest extends $dara.Model {
    * The [resource group ID](https://help.aliyun.com/document_detail/151181.html).
    * 
    * @example
-   * rg-acfm3q4zjh7fkki
+   * rg-aek23nsa353vmra
    */
   resourceGroupId?: string;
   /**
    * @remarks
-   * The Base64-encoded API definition (supports OAS 2.0/OAS 3.0 in YAML/JSON). This parameter has higher priority than the specFileUrl parameter. However, if the file size exceeds 10 MB, use the specFileUrl parameter to pass the definition.
+   * The Base64-encoded API definition. It supports OpenAPI Specification (OAS) 2.0 and 3.0 and can be in either YAML or JSON format. This parameter takes precedence over `specFileUrl`. If the file size is larger than 10 MB, use the `specFileUrl` parameter.
    * 
    * @example
    * b3BlbmFwaTogMy4wLjAKaW5mbzoKICAgIHRpdGxlOiBkZW1vCiAgICBkZXNjcmlwdGlvbjogdGhpc2lzZGVtbwogICAgdmVyc2lvbjogIiIKcGF0aHM6CiAgICAvdXNlci97dXNlcklkfToKICAgICAgICBnZXQ6CiAgICAgICAgICAgIHN1bW1hcnk6IOiOt+WPlueUqOaIt+S/oeaBrwogICAgICAgICAgICBkZXNjcmlwdGlvbjog6I635Y+W55So5oi35L+h5oGvCiAgICAgICAgICAgIG9wZXJhdGlvbklkOiBHZXRVc2VySW5mbwogICAgICAgICAgICByZXNwb25zZXM6CiAgICAgICAgICAgICAgICAiMjAwIjoKICAgICAgICAgICAgICAgICAgICBkZXNjcmlwdGlvbjog5oiQ5YqfCiAgICAgICAgICAgICAgICAgICAgY29udGVudDoKICAgICAgICAgICAgICAgICAgICAgICAgYXBwbGljYXRpb24vanNvbjtjaGFyc2V0PXV0Zi04OgogICAgICAgICAgICAgICAgICAgICAgICAgICAgc2NoZW1hOiBudWxsCnNlcnZlcnM6CiAgICAtIHVybDogaHR0cDovL2FwaS5leGFtcGxlLmNvbS92MQo=
@@ -118,24 +118,23 @@ export class ImportHttpApiRequest extends $dara.Model {
   specContentBase64?: string;
   /**
    * @remarks
-   * The download URL of the API definition file. Must be either a publicly accessible Object Storage Service (OSS) URL or an OSS intranet endpoint within the same region. Requires download permissions. For OSS URLs that are not publicly readable, refer to [https://www.alibabacloud.com/help/en/oss/user-guide/how-to-obtain-the-url-of-a-single-object-or-the-urls-of-multiple-objects](https://help.aliyun.com/document_detail/39607.html) and use URLs with download permissions. Currently, only OSS URLs are supported.
-   * 
-   * @example
-   * https://my-bucket.oss-cn-hangzhou.aliyuncs.com/my-api/api.yaml
+   * The URL of the API definition file stored in OSS. The URL must be accessible from the public network or be an internal OSS endpoint in the same region. For OSS objects that are not publicly readable, use a presigned URL. For details, see [Download a file by using a presigned URL](https://help.aliyun.com/document_detail/39607.html).
    */
   specFileUrl?: string;
   /**
    * @remarks
-   * The OSS configuration details.
+   * Configuration for fetching the API definition from an OSS bucket.
    */
   specOssConfig?: ImportHttpApiRequestSpecOssConfig;
   /**
    * @remarks
-   * The conflict resolution strategy when the API to be imported has the same name and version as an existing one. Valid values:
+   * The update strategy to apply when an API with the same name and versioning configuration already exists.
+   * 
+   * - `SpecOnly`: Overwrites the existing API completely with the imported definition.
+   * 
+   * - `SpecFirst`: Updates existing APIs and creates new ones based on the imported definition. Existing APIs not included in the import file are unaffected.
    * 
-   * *   SpecOnly: full override.
-   * *   SpecFirst: Merge with priority on the newly imported file. New APIs are created and existing ones are updated. APIs not included in the file remain unchanged.
-   * *   ExistFirst (default): Merge with priority on existing APIs. New APIs are created but existing ones remain unchanged. If this parameter is not specified, the ExistFirst policy takes effect.
+   * - `ExistFirst`: Creates new APIs from the imported definition but does not modify any existing APIs. This is the default strategy.
    * 
    * @example
    * ExistFirst
@@ -143,7 +142,7 @@ export class ImportHttpApiRequest extends $dara.Model {
   strategy?: string;
   /**
    * @remarks
-   * The target REST API ID for direct updates. If specified, the import operation will directly update the designated API instead of creating new APIs or updating existing APIs based on the name and version. Only REST APIs can be specified.
+   * If you specify this parameter, the import updates the specified API instead of creating a new one or searching for an existing API by name and versioning configuration. The target API must be an HTTP API.
    * 
    * @example
    * api-xxxx
@@ -151,9 +150,10 @@ export class ImportHttpApiRequest extends $dara.Model {
   targetHttpApiId?: string;
   /**
    * @remarks
-   * The API versioning configuration. If versioning is enabled, an imported API that matches both the version number and the API name of an existing API will update that API. If versioning is disabled, an imported API that matches the API name of an existing API will update it.
+   * The versioning configuration for the API. If an existing API matches the specified name (and version, if enabled), this import updates that API.
    */
   versionConfig?: HttpApiVersionConfig;
+  withGatewayExtension?: boolean;
   static names(): { [key: string]: string } {
     return {
       deployConfigs: 'deployConfigs',
@@ -169,6 +169,7 @@ export class ImportHttpApiRequest extends $dara.Model {
       strategy: 'strategy',
       targetHttpApiId: 'targetHttpApiId',
       versionConfig: 'versionConfig',
+      withGatewayExtension: 'withGatewayExtension',
     };
   }
 
@@ -187,6 +188,7 @@ export class ImportHttpApiRequest extends $dara.Model {
       strategy: 'string',
       targetHttpApiId: 'string',
       versionConfig: HttpApiVersionConfig,
+      withGatewayExtension: 'boolean',
     };
   }