@alicloud/apig20240327 9.1.0 → 9.2.0

package/src/models/GetHttpApiOperationResponseBody.ts

@@ -6,7 +6,7 @@ import { HttpApiOperationInfo } from "./HttpApiOperationInfo";
 export class GetHttpApiOperationResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Response status code.
+   * The response status code.
    * 
    * @example
    * Ok
@@ -19,7 +19,7 @@ export class GetHttpApiOperationResponseBody extends $dara.Model {
   data?: HttpApiOperationInfo;
   /**
    * @remarks
-   * Response message.
+   * The response message.
    * 
    * @example
    * success
@@ -27,7 +27,7 @@ export class GetHttpApiOperationResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * B725275B-50C6-5A49-A9FD-F0332FCB3351

package/src/models/GetPolicyResponseBody.ts

@@ -6,7 +6,7 @@ import { PolicyDetailInfo } from "./PolicyDetailInfo";
 export class GetPolicyResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The status code.
+   * The response status code.
    * 
    * @example
    * Ok
@@ -14,12 +14,12 @@ export class GetPolicyResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The data returned.
+   * The response data.
    */
   data?: PolicyDetailInfo;
   /**
    * @remarks
-   * The returned message.
+   * The response message.
    * 
    * @example
    * success

package/src/models/GetServiceResponseBody.ts

@@ -6,7 +6,7 @@ import { Service } from "./Service";
 export class GetServiceResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The status code.
+   * The response status code.
    * 
    * @example
    * Ok
@@ -19,7 +19,7 @@ export class GetServiceResponseBody extends $dara.Model {
   data?: Service;
   /**
    * @remarks
-   * The returned message.
+   * The response message.
    * 
    * @example
    * success

package/src/models/GetSourceResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetSourceResponseBodyDataK8SSourceInfo extends $dara.Model {
   /**
    * @remarks
-   * Container Service cluster ID.
+   * The container service cluster ID.
    * 
    * @example
    * c2d290b2d8b5d4935864cace5f0173f31
@@ -35,7 +35,7 @@ export class GetSourceResponseBodyDataK8SSourceInfo extends $dara.Model {
 export class GetSourceResponseBodyDataNacosSourceInfo extends $dara.Model {
   /**
    * @remarks
-   * Nacos instance access address.
+   * The access address of the Nacos instance.
    * 
    * @example
    * mse
@@ -43,7 +43,7 @@ export class GetSourceResponseBodyDataNacosSourceInfo extends $dara.Model {
   address?: string;
   /**
    * @remarks
-   * Cluster ID.
+   * The cluster ID.
    * 
    * @example
    * fluss-cn-w7k4hann601
@@ -51,7 +51,7 @@ export class GetSourceResponseBodyDataNacosSourceInfo extends $dara.Model {
   clusterId?: string;
   /**
    * @remarks
-   * Nacos instance ID.
+   * The Nacos instance ID.
    * 
    * @example
    * hgprecn-cn-cfn47q7oh001
@@ -95,7 +95,7 @@ export class GetSourceResponseBodyData extends $dara.Model {
   associationStatus?: string;
   /**
    * @remarks
-   * Creation timestamp.
+   * The creation timestamp.
    * 
    * @example
    * 1719386834548
@@ -103,7 +103,7 @@ export class GetSourceResponseBodyData extends $dara.Model {
   createTimestamp?: number;
   /**
    * @remarks
-   * Gateway ID.
+   * The gateway ID.
    * 
    * @example
    * gw-cq2vundlhtg***
@@ -111,17 +111,17 @@ export class GetSourceResponseBodyData extends $dara.Model {
   gatewayId?: string;
   /**
    * @remarks
-   * K8s source information.
+   * The Kubernetes source information.
    */
   k8SSourceInfo?: GetSourceResponseBodyDataK8SSourceInfo;
   /**
    * @remarks
-   * MSE Nacos source information.
+   * The Microservices Engine (MSE) Nacos source information.
    */
   nacosSourceInfo?: GetSourceResponseBodyDataNacosSourceInfo;
   /**
    * @remarks
-   * Name.
+   * The name.
    * 
    * @example
    * import-test
@@ -129,7 +129,7 @@ export class GetSourceResponseBodyData extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The resource group ID.
    * 
    * @example
    * rg-aekz4us4iruleja
@@ -137,7 +137,7 @@ export class GetSourceResponseBodyData extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * Source ID.
+   * The source ID.
    * 
    * @example
    * src-crdddallhtgt***
@@ -145,7 +145,7 @@ export class GetSourceResponseBodyData extends $dara.Model {
   sourceId?: string;
   /**
    * @remarks
-   * Type.
+   * The type.
    * 
    * @example
    * K8S
@@ -153,7 +153,7 @@ export class GetSourceResponseBodyData extends $dara.Model {
   type?: string;
   /**
    * @remarks
-   * Update timestamp.
+   * The update timestamp.
    * 
    * @example
    * 1719386834548
@@ -209,7 +209,7 @@ export class GetSourceResponseBodyData extends $dara.Model {
 export class GetSourceResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Response status code.
+   * The response status code.
    * 
    * @example
    * Ok
@@ -217,12 +217,12 @@ export class GetSourceResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * Response data.
+   * The response data.
    */
   data?: GetSourceResponseBodyData;
   /**
    * @remarks
-   * Response message.
+   * The response message.
    * 
    * @example
    * success

package/src/models/GetTraceConfigRequest.ts

@@ -5,7 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class GetTraceConfigRequest extends $dara.Model {
   /**
    * @remarks
-   * The language in which you want results to be returned. Valid values: zh: Chinese. en: English.
+   * The language type. Valid values:
+   * 
+   * zh: Chinese
+   * en: English.
    * 
    * @example
    * zh

package/src/models/GetTraceConfigResponseBody.ts

@@ -5,7 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class GetTraceConfigResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether tracing analysis is enabled. Valid values: true and false
+   * Indicates whether Tracing Analysis is enabled. Valid values:
+   * - true: Enabled.
+   * - false: shutdown.
    * 
    * @example
    * true
@@ -13,7 +15,7 @@ export class GetTraceConfigResponseBodyData extends $dara.Model {
   enable?: boolean;
   /**
    * @remarks
-   * The sampling rate.
+   * The sampling ratio.
    * 
    * @example
    * 50
@@ -21,7 +23,7 @@ export class GetTraceConfigResponseBodyData extends $dara.Model {
   sampleRatio?: number;
   /**
    * @remarks
-   * The service ID. This parameter exists when the traceType value is SKYWALKING.
+   * The service ID. This parameter is returned only when the Tracing Analysis type is SKYWALKING.
    * 
    * @example
    * ss-co370icmjeu****
@@ -29,7 +31,7 @@ export class GetTraceConfigResponseBodyData extends $dara.Model {
   serviceId?: string;
   /**
    * @remarks
-   * The service port. This parameter exists when the traceType value is SKYWALKING.
+   * The service port. This parameter is returned only when the Tracing Analysis type is SKYWALKING.
    * 
    * @example
    * 8090
@@ -37,12 +39,11 @@ export class GetTraceConfigResponseBodyData extends $dara.Model {
   servicePort?: string;
   /**
    * @remarks
-   * The type of tracing analysis. Valid values:
-   * 
-   * *   XTRACE
-   * *   SKYWALKING
-   * *   OPENTELEMETRY
-   * *   OTSKYWALKING
+   * The Tracing Analysis type. Valid values:
+   * - XTRACE
+   * - SKYWALKING
+   * - OPENTELEMETRY
+   * - OTSKYWALKING.
    * 
    * @example
    * SKYWALKING
@@ -88,7 +89,7 @@ export class GetTraceConfigResponseBody extends $dara.Model {
   code?: number;
   /**
    * @remarks
-   * The data returned.
+   * The response data.
    */
   data?: GetTraceConfigResponseBodyData;
   /**
@@ -109,7 +110,9 @@ export class GetTraceConfigResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values: true false
+   * Indicates whether the request was successful. Valid values:
+   * - true: The request was successful.
+   * - false: The request failed.
    * 
    * @example
    * true

package/src/models/HttpApiApiInfo.ts

@@ -532,14 +532,7 @@ export class HttpApiApiInfo extends $dara.Model {
    * 测试专用API
    */
   description?: string;
-  /**
-   * @remarks
-   * Specifies whether to enable authentication.
-   * 
-   * @example
-   * true
-   */
-  enabelAuth?: boolean;
+  enableAuth?: boolean;
   /**
    * @remarks
    * The API environment information.
@@ -625,7 +618,7 @@ export class HttpApiApiInfo extends $dara.Model {
       deployCntMap: 'deployCntMap',
       deployConfigs: 'deployConfigs',
       description: 'description',
-      enabelAuth: 'enabelAuth',
+      enableAuth: 'enableAuth',
       environments: 'environments',
       gatewayId: 'gatewayId',
       httpApiId: 'httpApiId',
@@ -648,7 +641,7 @@ export class HttpApiApiInfo extends $dara.Model {
       deployCntMap: { 'type': 'map', 'keyType': 'string', 'valueType': HttpApiApiInfoDeployCntMapValue },
       deployConfigs: { 'type': 'array', 'itemType': HttpApiDeployConfig },
       description: 'string',
-      enabelAuth: 'boolean',
+      enableAuth: 'boolean',
       environments: { 'type': 'array', 'itemType': HttpApiApiInfoEnvironments },
       gatewayId: 'string',
       httpApiId: 'string',

package/src/models/HttpApiApiInfoDeployCntMapValue.ts

@@ -11,18 +11,11 @@ export class HttpApiApiInfoDeployCntMapValue extends $dara.Model {
    * 3
    */
   deployedCnt?: number;
-  /**
-   * @remarks
-   * Cnt
-   * 
-   * @example
-   * 5
-   */
   cnt?: number;
   static names(): { [key: string]: string } {
     return {
       deployedCnt: 'deployedCnt',
-      cnt: 'Cnt',
+      cnt: 'cnt',
     };
   }
 

package/src/models/HttpApiDeployConfig.ts

@@ -10,7 +10,7 @@ import { HttpApiBackendMatchConditions } from "./HttpApiBackendMatchConditions";
 export class HttpApiDeployConfigCustomDomainInfos extends $dara.Model {
   /**
    * @remarks
-   * Domain ID.
+   * The domain name ID.
    * 
    * @example
    * d-cshee6dlhtgk******
@@ -18,7 +18,7 @@ export class HttpApiDeployConfigCustomDomainInfos extends $dara.Model {
   domainId?: string;
   /**
    * @remarks
-   * Domain name.
+   * The domain name.
    * 
    * @example
    * hello-server.com
@@ -26,7 +26,7 @@ export class HttpApiDeployConfigCustomDomainInfos extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * Protocol.
+   * The protocol.
    * 
    * @example
    * HTTP
@@ -58,8 +58,29 @@ export class HttpApiDeployConfigCustomDomainInfos extends $dara.Model {
 }
 
 export class HttpApiDeployConfigEnvDomainInfos extends $dara.Model {
+  /**
+   * @remarks
+   * The domain name ID.
+   * 
+   * @example
+   * d-env-xxx
+   */
   domainId?: string;
+  /**
+   * @remarks
+   * The domain name.
+   * 
+   * @example
+   * api.example.com
+   */
   name?: string;
+  /**
+   * @remarks
+   * The protocol.
+   * 
+   * @example
+   * HTTPS
+   */
   protocol?: string;
   static names(): { [key: string]: string } {
     return {
@@ -89,7 +110,7 @@ export class HttpApiDeployConfigEnvDomainInfos extends $dara.Model {
 export class HttpApiDeployConfigServiceConfigsObservabilityRouteConfig extends $dara.Model {
   /**
    * @remarks
-   * Routing mode.
+   * The routing mode.
    * 
    * @example
    * LeastBusy
@@ -97,7 +118,7 @@ export class HttpApiDeployConfigServiceConfigsObservabilityRouteConfig extends $
   mode?: string;
   /**
    * @remarks
-   * Queue size.
+   * The queue size.
    * 
    * @example
    * 100
@@ -105,7 +126,7 @@ export class HttpApiDeployConfigServiceConfigsObservabilityRouteConfig extends $
   queueSize?: number;
   /**
    * @remarks
-   * Maximum traffic ratio for a single service.
+   * The maximum traffic ratio for a single service.
    * 
    * @example
    * 0.8
@@ -139,7 +160,7 @@ export class HttpApiDeployConfigServiceConfigsObservabilityRouteConfig extends $
 export class HttpApiDeployConfigServiceConfigs extends $dara.Model {
   /**
    * @remarks
-   * Gateway service ID.
+   * The gateway service ID.
    * 
    * @example
    * gw-svc-abc123
@@ -147,7 +168,7 @@ export class HttpApiDeployConfigServiceConfigs extends $dara.Model {
   gatewayServiceId?: string;
   /**
    * @remarks
-   * Intent code.
+   * The intent code.
    * 
    * @example
    * INQUIRY
@@ -155,12 +176,12 @@ export class HttpApiDeployConfigServiceConfigs extends $dara.Model {
   intentCode?: string;
   /**
    * @remarks
-   * Matching conditions.
+   * The matching condition.
    */
   match?: HttpApiBackendMatchConditions;
   /**
    * @remarks
-   * Model name.
+   * The model name.
    * 
    * @example
    * qwen-max
@@ -168,7 +189,7 @@ export class HttpApiDeployConfigServiceConfigs extends $dara.Model {
   modelName?: string;
   /**
    * @remarks
-   * Model name matching rule.
+   * The model name matching rule.
    * 
    * @example
    * qwen-*
@@ -176,7 +197,7 @@ export class HttpApiDeployConfigServiceConfigs extends $dara.Model {
   modelNamePattern?: string;
   /**
    * @remarks
-   * Multi-service routing strategy type.
+   * The multi-service routing strategy type.
    * 
    * @example
    * ByWeight
@@ -184,7 +205,7 @@ export class HttpApiDeployConfigServiceConfigs extends $dara.Model {
   multiServiceRouteStrategy?: string;
   /**
    * @remarks
-   * Service display name.
+   * The service display name.
    * 
    * @example
    * Qwen-Max-Service
@@ -192,7 +213,7 @@ export class HttpApiDeployConfigServiceConfigs extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * Observability-based routing configuration.
+   * The observability metric routing configuration.
    * 
    * **if can be null:**
    * true
@@ -200,7 +221,7 @@ export class HttpApiDeployConfigServiceConfigs extends $dara.Model {
   observabilityRouteConfig?: HttpApiDeployConfigServiceConfigsObservabilityRouteConfig;
   /**
    * @remarks
-   * Service port number.
+   * The service port number.
    * 
    * @example
    * 80
@@ -208,7 +229,7 @@ export class HttpApiDeployConfigServiceConfigs extends $dara.Model {
   port?: number;
   /**
    * @remarks
-   * Service protocol (HTTP/HTTPS).
+   * The service protocol (HTTP/HTTPS).
    * 
    * @example
    * HTTP
@@ -216,7 +237,7 @@ export class HttpApiDeployConfigServiceConfigs extends $dara.Model {
   protocol?: string;
   /**
    * @remarks
-   * Service ID.
+   * The service ID.
    * 
    * @example
    * svc-xxx
@@ -224,7 +245,7 @@ export class HttpApiDeployConfigServiceConfigs extends $dara.Model {
   serviceId?: string;
   /**
    * @remarks
-   * Service version tag.
+   * The service version label.
    * 
    * @example
    * V2
@@ -232,7 +253,7 @@ export class HttpApiDeployConfigServiceConfigs extends $dara.Model {
   version?: string;
   /**
    * @remarks
-   * Service weight.
+   * The service weight.
    * 
    * @example
    * 100
@@ -292,7 +313,7 @@ export class HttpApiDeployConfigServiceConfigs extends $dara.Model {
 export class HttpApiDeployConfigSubDomains extends $dara.Model {
   /**
    * @remarks
-   * Domain ID.
+   * The domain name ID.
    * 
    * @example
    * d-csmn42um******
@@ -300,7 +321,7 @@ export class HttpApiDeployConfigSubDomains extends $dara.Model {
   domainId?: string;
   /**
    * @remarks
-   * Domain name.
+   * The domain name.
    * 
    * @example
    * test
@@ -308,7 +329,7 @@ export class HttpApiDeployConfigSubDomains extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * Network type.
+   * The network type.
    * 
    * @example
    * Intranet
@@ -316,7 +337,7 @@ export class HttpApiDeployConfigSubDomains extends $dara.Model {
   networkType?: string;
   /**
    * @remarks
-   * Protocol.
+   * The protocol.
    * 
    * @example
    * HTTP
@@ -352,7 +373,7 @@ export class HttpApiDeployConfigSubDomains extends $dara.Model {
 export class HttpApiDeployConfig extends $dara.Model {
   /**
    * @remarks
-   * Whether to enable automatic deployment.
+   * Specifies whether to automatically deploy.
    * 
    * @example
    * true
@@ -360,28 +381,40 @@ export class HttpApiDeployConfig extends $dara.Model {
   autoDeploy?: boolean;
   /**
    * @remarks
-   * Deployment scenario.
+   * The publishing scenario.
    * 
    * @example
    * SingleService
    */
   backendScene?: string;
+  /**
+   * @remarks
+   * The list of built-in route names.
+   */
   builtinRouteNames?: string[];
   /**
    * @remarks
-   * List of custom domain IDs.
+   * The list of custom domain name IDs.
    */
   customDomainIds?: string[];
   /**
    * @remarks
-   * List of custom domain details.
+   * The list of custom domain name details.
    */
   customDomainInfos?: HttpApiDeployConfigCustomDomainInfos[];
+  /**
+   * @remarks
+   * The list of environment domain name IDs. If this parameter is not specified, all environment domain names are associated. An empty array indicates that no environment domain names are associated.
+   */
   envDomainIds?: string[];
+  /**
+   * @remarks
+   * The list of environment domain name details.
+   */
   envDomainInfos?: HttpApiDeployConfigEnvDomainInfos[];
   /**
    * @remarks
-   * Environment ID.
+   * The environment ID.
    * 
    * @example
    * env-xxx
@@ -389,7 +422,7 @@ export class HttpApiDeployConfig extends $dara.Model {
   environmentId?: string;
   /**
    * @remarks
-   * Gateway instance ID.
+   * The gateway instance ID.
    * 
    * @example
    * gw-xx
@@ -397,7 +430,7 @@ export class HttpApiDeployConfig extends $dara.Model {
   gatewayId?: string;
   /**
    * @remarks
-   * Gateway information.
+   * The gateway information.
    * 
    * **if can be null:**
    * true
@@ -405,7 +438,7 @@ export class HttpApiDeployConfig extends $dara.Model {
   gatewayInfo?: GatewayInfo;
   /**
    * @remarks
-   * Gateway type.
+   * The gateway type.
    * 
    * @example
    * API
@@ -413,7 +446,7 @@ export class HttpApiDeployConfig extends $dara.Model {
   gatewayType?: string;
   /**
    * @remarks
-   * Mock configuration.
+   * The mock configuration.
    * 
    * **if can be null:**
    * true
@@ -421,12 +454,12 @@ export class HttpApiDeployConfig extends $dara.Model {
   mock?: HttpApiMockContract;
   /**
    * @remarks
-   * List of policy configurations.
+   * The list of policy configurations.
    */
   policyConfigs?: HttpApiPolicyConfigs[];
   /**
    * @remarks
-   * Backend service information.
+   * The backend service information.
    * 
    * **if can be null:**
    * true
@@ -434,12 +467,12 @@ export class HttpApiDeployConfig extends $dara.Model {
   routeBackend?: Backend;
   /**
    * @remarks
-   * List of service configurations.
+   * The list of service configurations.
    */
   serviceConfigs?: HttpApiDeployConfigServiceConfigs[];
   /**
    * @remarks
-   * List of second-level domain details.
+   * The list of subdomain details.
    */
   subDomains?: HttpApiDeployConfigSubDomains[];
   static names(): { [key: string]: string } {