@alicloud/apig20240327 9.2.0 → 9.3.0

package/src/models/ListConsumerAuthorizationRulesResponseBody.ts

@@ -8,12 +8,12 @@ import { GatewayInfo } from "./GatewayInfo";
 export class ListConsumerAuthorizationRulesResponseBodyDataItems extends $dara.Model {
   /**
    * @remarks
-   * API信息。
+   * The API information.
    */
   apiInfo?: HttpApiApiInfo;
   /**
    * @remarks
-   * 消费者授权规则ID。
+   * The consumer authorization rule ID.
    * 
    * @example
    * car-csgeka5lhtggrjcprok0
@@ -21,7 +21,7 @@ export class ListConsumerAuthorizationRulesResponseBodyDataItems extends $dara.M
   consumerAuthorizationRuleId?: string;
   /**
    * @remarks
-   * 消费者ID。
+   * The consumer ID.
    * 
    * @example
    * cs-csheiftlhtgmp0j0hp4g
@@ -29,7 +29,7 @@ export class ListConsumerAuthorizationRulesResponseBodyDataItems extends $dara.M
   consumerId?: string;
   /**
    * @remarks
-   * 创建时间戳。
+   * The creation timestamp.
    * 
    * @example
    * 1719386834548
@@ -37,7 +37,7 @@ export class ListConsumerAuthorizationRulesResponseBodyDataItems extends $dara.M
   createTimestamp?: number;
   /**
    * @remarks
-   * API在当前环境的发布状态
+   * The publish status of the API in the current environment.
    * 
    * @example
    * {}
@@ -45,12 +45,14 @@ export class ListConsumerAuthorizationRulesResponseBodyDataItems extends $dara.M
   deployStatus?: string;
   /**
    * @remarks
-   * 环境信息。
+   * The environment context.
    */
   environmentInfo?: EnvironmentInfo;
   /**
    * @remarks
-   * 失效模式。LongTerm、ShortTerm，二选一。
+   * The expiration mode. Valid values:
+   * - LongTerm
+   * - ShortTerm
    * 
    * @example
    * ShortTerm
@@ -58,7 +60,7 @@ export class ListConsumerAuthorizationRulesResponseBodyDataItems extends $dara.M
   expireMode?: string;
   /**
    * @remarks
-   * 失效状态。
+   * The expiration status.
    * 
    * @example
    * InEffect
@@ -66,7 +68,7 @@ export class ListConsumerAuthorizationRulesResponseBodyDataItems extends $dara.M
   expireStatus?: string;
   /**
    * @remarks
-   * 到期时间。
+   * The expiration time.
    * 
    * @example
    * 172086834548
@@ -74,12 +76,12 @@ export class ListConsumerAuthorizationRulesResponseBodyDataItems extends $dara.M
   expireTimestamp?: number;
   /**
    * @remarks
-   * 网关信息。
+   * The gateway information.
    */
   gatewayInfo?: GatewayInfo;
   /**
    * @remarks
-   * 资源ID。
+   * The resource ID.
    * 
    * @example
    * 2351944
@@ -87,7 +89,7 @@ export class ListConsumerAuthorizationRulesResponseBodyDataItems extends $dara.M
   resourceId?: string;
   /**
    * @remarks
-   * 资源类型。
+   * The resource type.
    * 
    * @example
    * HttpApiRoute
@@ -95,7 +97,7 @@ export class ListConsumerAuthorizationRulesResponseBodyDataItems extends $dara.M
   resourceType?: string;
   /**
    * @remarks
-   * 更新时间戳。单位: 毫秒。
+   * The update timestamp. Unit: milliseconds.
    * 
    * @example
    * 1721116090326
@@ -158,7 +160,7 @@ export class ListConsumerAuthorizationRulesResponseBodyDataItems extends $dara.M
 export class ListConsumerAuthorizationRulesResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * 消费者授权信息列表。
+   * The list of consumer authorization information.
    */
   items?: ListConsumerAuthorizationRulesResponseBodyDataItems[];
   /**

package/src/models/ListConsumerQuotaRulesRequest.ts

@@ -4,21 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListConsumerQuotaRulesRequest extends $dara.Model {
   /**
+   * @remarks
+   * The gateway ID. This parameter is optional.
+   * 
    * @example
    * gw-123456
    */
   gatewayId?: string;
   /**
+   * @remarks
+   * The rule name keyword, used for fuzzy match.
+   * 
    * @example
    * daily
    */
   keyword?: string;
   /**
+   * @remarks
+   * The page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 10
    */

package/src/models/ListConsumerQuotaRulesResponseBody.ts

@@ -4,56 +4,91 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListConsumerQuotaRulesResponseBodyDataItems extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the gateway to which the rule belongs.
+   * 
    * @example
    * gw-123456
    */
   gatewayId?: string;
   /**
+   * @remarks
+   * The name of the gateway to which the rule belongs.
+   * 
    * @example
    * prod-gateway
    */
   gatewayName?: string;
   /**
+   * @remarks
+   * The period multiplier, which specifies the number of periods after which the quota is reset. This parameter is returned only when the rule uses a custom cycle. Minimum value: 1. Maximum value: 60.
+   * 
    * @example
    * 30
    */
   periodMultiplier?: string;
   /**
+   * @remarks
+   * The period type.
+   * 
    * @example
    * week
    */
   periodType?: string;
   /**
+   * @remarks
+   * The quota dimension.
+   * 
    * @example
    * token
    */
   quotaDimension?: string;
   /**
+   * @remarks
+   * The quota limit.
+   * 
    * @example
    * 1000
    */
   quotaLimit?: number;
   /**
+   * @remarks
+   * The rule ID.
+   * 
    * @example
    * qr-d8j7fpmm1hksxxxxxx
    */
   ruleId?: string;
   /**
+   * @remarks
+   * The rule name.
+   * 
    * @example
    * daily-token-limit
    */
   ruleName?: string;
   /**
+   * @remarks
+   * The rule status.
+   * 
    * @example
    * enabled
    */
   ruleStatus?: string;
   /**
+   * @remarks
+   * The time zone corresponding to the natural cycle, in UTC+x format.
+   * 
    * @example
    * UTC+8
    */
   timezone?: string;
   /**
+   * @remarks
+   * The cycle type. Valid values:
+   * - calendar: Natural cycle.
+   * - epoch: Custom cycle.
+   * 
    * @example
    * calendar
    */
@@ -101,21 +136,33 @@ export class ListConsumerQuotaRulesResponseBodyDataItems extends $dara.Model {
 
 export class ListConsumerQuotaRulesResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The list of rules.
+   * 
    * @example
    * [{"ruleId":"rule-001"}]
    */
   items?: ListConsumerQuotaRulesResponseBodyDataItems[];
   /**
+   * @remarks
+   * The current page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The current page size.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The total number of configured quota rules.
+   * 
    * @example
    * 100
    */
@@ -152,21 +199,33 @@ export class ListConsumerQuotaRulesResponseBodyData extends $dara.Model {
 
 export class ListConsumerQuotaRulesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The status code.
+   * 
    * @example
    * 200
    */
   code?: string;
   /**
+   * @remarks
+   * The response data.
+   * 
    * @example
    * {"totalSize":100}
    */
   data?: ListConsumerQuotaRulesResponseBodyData;
   /**
+   * @remarks
+   * The response message.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * Id of the request
+   * 
    * @example
    * 1234567890
    */

package/src/models/ListConsumersRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListConsumersRequest extends $dara.Model {
   /**
    * @remarks
-   * The instance type. Valid values: **AI** and **API**.
+   * Filters by gateway type. Valid values: **AI** and **API**.
    * 
    * @example
    * AI
@@ -13,7 +13,7 @@ export class ListConsumersRequest extends $dara.Model {
   gatewayType?: string;
   /**
    * @remarks
-   * The name used to perform a fuzzy search for operations.
+   * Fuzzy matches APIs by API name.
    * 
    * @example
    * UI-test
@@ -21,7 +21,7 @@ export class ListConsumersRequest extends $dara.Model {
   nameLike?: string;
   /**
    * @remarks
-   * The page number to return. Pages start from 1. Default value: 1.
+   * The page number, starting from 1. Default value: 1.
    * 
    * @example
    * 1

package/src/models/ListConsumersResponseBody.ts

@@ -21,7 +21,7 @@ export class ListConsumersResponseBodyDataItems extends $dara.Model {
   createTimestamp?: number;
   /**
    * @remarks
-   * The deployment status of the API in the current environment.
+   * The publish status of the API in the current environment.
    * 
    * @example
    * {}
@@ -37,7 +37,7 @@ export class ListConsumersResponseBodyDataItems extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * Indicates if enabled.
+   * Indicates whether the consumer is enabled.
    * 
    * @example
    * true
@@ -53,7 +53,7 @@ export class ListConsumersResponseBodyDataItems extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The last update timestamp.
+   * The update timestamp.
    * 
    * @example
    * 1721123855214
@@ -95,7 +95,7 @@ export class ListConsumersResponseBodyDataItems extends $dara.Model {
 export class ListConsumersResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The list of consumer information.
+   * The list of consumers.
    */
   items?: ListConsumersResponseBodyDataItems[];
   /**
@@ -108,7 +108,7 @@ export class ListConsumersResponseBodyData extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page.
+   * The page size.
    * 
    * @example
    * 10
@@ -116,7 +116,7 @@ export class ListConsumersResponseBodyData extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of entries.
    * 
    * @example
    * 18
@@ -155,7 +155,7 @@ export class ListConsumersResponseBodyData extends $dara.Model {
 export class ListConsumersResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The status code.
+   * The response code.
    * 
    * @example
    * Ok
@@ -163,12 +163,12 @@ export class ListConsumersResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response payload.
+   * The response data.
    */
   data?: ListConsumersResponseBodyData;
   /**
    * @remarks
-   * The status message.
+   * The response message.
    * 
    * @example
    * success
@@ -176,7 +176,7 @@ export class ListConsumersResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The request ID.
+   * Id of the request
    * 
    * @example
    * 9BDD6A7C-CBA7-504F-B8C5-51B9F16590F7

package/src/models/ListDomainsRequest.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListDomainsRequest extends $dara.Model {
   /**
+   * @remarks
+   * The domain name scope.
+   * 
    * @example
    * Serverless
    */

package/src/models/ListEnvironmentsResponseBody.ts

@@ -6,7 +6,7 @@ import { EnvironmentInfo } from "./EnvironmentInfo";
 export class ListEnvironmentsResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * 环境信息列表。
+   * The list of environment contexts.
    */
   items?: EnvironmentInfo[];
   /**

package/src/models/ListExternalServicesRequest.ts

@@ -4,26 +4,46 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListExternalServicesRequest extends $dara.Model {
   /**
+   * @remarks
+   * Specifies whether to return only services that have not been imported.
+   * 
    * @example
    * true
    */
   importableOnly?: boolean;
   /**
+   * @remarks
+   * The maximum number of entries to return. Valid range: (0, 100]. Default value: 10.
+   * 
    * @example
    * 100
    */
   limit?: number;
   /**
+   * @remarks
+   * The keyword used for fuzzy match by API name.
+   * 
    * @example
    * imah
    */
   nameLike?: string;
   /**
+   * @remarks
+   * The workspace ID of the PAI-EAS service.
+   * 
    * @example
    * 667435
    */
   paiWorkspaceId?: string;
   /**
+   * @remarks
+   * The service source type used to filter results. Valid values:
+   * - MSE_NACOS: the service originates from MSE Nacos.
+   * - K8S: the service originates from a Kubernetes cluster in Container Service.
+   * - FC3: the service originates from Function Compute.
+   * - VIP: the service originates from a fixed address.
+   * - DNS: the service originates from a domain name.
+   * 
    * @example
    * FC3
    */

package/src/models/ListExternalServicesResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListExternalServicesResponseBodyDataItemsServices extends $dara.Model {
   /**
+   * @remarks
+   * The name.
+   * 
    * @example
    * enable-slash-merge
    */
   name?: string;
   /**
+   * @remarks
+   * The namespace.
+   * 
    * @example
    * public
    */
@@ -38,15 +44,25 @@ export class ListExternalServicesResponseBodyDataItemsServices extends $dara.Mod
 
 export class ListExternalServicesResponseBodyDataItems extends $dara.Model {
   /**
+   * @remarks
+   * The namespace.
+   * 
    * @example
    * PUBLIC
    */
   namespace?: string;
   /**
+   * @remarks
+   * The display name of the namespace.
+   * 
    * @example
    * PUBLIC
    */
   namespaceShowName?: string;
+  /**
+   * @remarks
+   * The backend services.
+   */
   services?: ListExternalServicesResponseBodyDataItemsServices[];
   static names(): { [key: string]: string } {
     return {
@@ -77,6 +93,10 @@ export class ListExternalServicesResponseBodyDataItems extends $dara.Model {
 }
 
 export class ListExternalServicesResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The service information.
+   */
   items?: ListExternalServicesResponseBodyDataItems[];
   static names(): { [key: string]: string } {
     return {
@@ -104,12 +124,22 @@ export class ListExternalServicesResponseBodyData extends $dara.Model {
 
 export class ListExternalServicesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The response code.
+   * 
    * @example
    * Ok
    */
   code?: string;
+  /**
+   * @remarks
+   * The list of APIs.
+   */
   data?: ListExternalServicesResponseBodyData;
   /**
+   * @remarks
+   * The response message.
+   * 
    * @example
    * Failed to upload data. Please try again
    */