@alicloud/eas20210701 5.1.0 → 6.0.1

package/dist/client.d.ts

@@ -269,6 +269,10 @@ export declare class Service extends $tea.Model {
     });
 }
 export declare class CloneServiceRequest extends $tea.Model {
+    /**
+     * @remarks
+     * The label of the service to be cloned.
+     */
     labels?: {
         [key: string]: string;
     };
@@ -291,6 +295,10 @@ export declare class CloneServiceRequest extends $tea.Model {
     });
 }
 export declare class CloneServiceShrinkRequest extends $tea.Model {
+    /**
+     * @remarks
+     * The label of the service to be cloned.
+     */
     labelsShrink?: string;
     /**
      * @remarks
@@ -429,8 +437,15 @@ export declare class CommitServiceResponse extends $tea.Model {
     });
 }
 export declare class CreateAclPolicyRequest extends $tea.Model {
+    /**
+     * @remarks
+     * The whitelisted IP CIDR blocks in the VPC that can access the private gateway.
+     */
     aclPolicyList?: CreateAclPolicyRequestAclPolicyList[];
     /**
+     * @remarks
+     * The ID of the virtual private cloud (VPC). For more information about how to obtain the VPC ID, see DescribeVpcs.
+     *
      * @example
      * vpc-uf66uio7md****
      */
@@ -446,8 +461,15 @@ export declare class CreateAclPolicyRequest extends $tea.Model {
     });
 }
 export declare class CreateAclPolicyShrinkRequest extends $tea.Model {
+    /**
+     * @remarks
+     * The whitelisted IP CIDR blocks in the VPC that can access the private gateway.
+     */
     aclPolicyListShrink?: string;
     /**
+     * @remarks
+     * The ID of the virtual private cloud (VPC). For more information about how to obtain the VPC ID, see DescribeVpcs.
+     *
      * @example
      * vpc-uf66uio7md****
      */
@@ -464,16 +486,25 @@ export declare class CreateAclPolicyShrinkRequest extends $tea.Model {
 }
 export declare class CreateAclPolicyResponseBody extends $tea.Model {
     /**
+     * @remarks
+     * The private gateway ID.
+     *
      * @example
      * gw-1uhcqmsc7x22******
      */
     gatewayId?: string;
     /**
+     * @remarks
+     * The returned message.
+     *
      * @example
      * Successfully add acl policy for gateway
      */
     message?: string;
     /**
+     * @remarks
+     * The request ID.
+     *
      * @example
      * 40325405-579C-4D82****
      */
@@ -786,7 +817,7 @@ export declare class CreateBenchmarkTaskResponse extends $tea.Model {
 export declare class CreateGatewayRequest extends $tea.Model {
     /**
      * @remarks
-     * The name of the resource group.
+     * The resource group ID. To obtain a resource group ID, see the ResourceId field in the response of the [ListResources](https://help.aliyun.com/document_detail/412133.html) operation.
      *
      * @example
      * eas-r-4gt8twzwllfo******
@@ -799,28 +830,20 @@ export declare class CreateGatewayRequest extends $tea.Model {
      * Valid values:
      *
      * *   true
-     *
-     *     <!-- -->
-     *
-     *     <!-- -->
-     *
-     *     <!-- -->
-     *
      * *   false
      *
-     *     <!-- -->
-     *
-     *     <!-- -->
-     *
-     *     <!-- -->
-     *
      * @example
      * false
      */
     enableInternet?: boolean;
     /**
      * @remarks
-     * Specifies whether to enable internal network access. Default value: true.
+     * Specifies whether to enable private access. Default value: true.
+     *
+     * Valid values:
+     *
+     * *   true
+     * *   false
      *
      * @example
      * true
@@ -828,7 +851,12 @@ export declare class CreateGatewayRequest extends $tea.Model {
     enableIntranet?: boolean;
     /**
      * @remarks
-     * The instance type used for the private gateway.
+     * The instance type used by the private gateway. Valid values:
+     *
+     * *   2c4g
+     * *   4c8g
+     * *   8c16g
+     * *   16c32g
      *
      * This parameter is required.
      *
@@ -838,12 +866,19 @@ export declare class CreateGatewayRequest extends $tea.Model {
     instanceType?: string;
     /**
      * @remarks
-     * The private gateway alias.
+     * The alias of the private gateway.
      *
      * @example
      * mygateway1
      */
     name?: string;
+    /**
+     * @remarks
+     * The number of nodes in the private gateway.
+     *
+     * @example
+     * 2
+     */
     replicas?: number;
     static names(): {
         [key: string]: string;
@@ -1915,8 +1950,15 @@ export declare class CreateServiceMirrorResponse extends $tea.Model {
     });
 }
 export declare class DeleteAclPolicyRequest extends $tea.Model {
+    /**
+     * @remarks
+     * The whitelisted IP CIDR blocks in the VPC that can access the private gateway.
+     */
     aclPolicyList?: DeleteAclPolicyRequestAclPolicyList[];
     /**
+     * @remarks
+     * The ID of the virtual private cloud (VPC). For more information about how to obtain the VPC ID, see DescribeVpcs.
+     *
      * @example
      * vpc-uf66uio7md****
      */
@@ -1932,8 +1974,15 @@ export declare class DeleteAclPolicyRequest extends $tea.Model {
     });
 }
 export declare class DeleteAclPolicyShrinkRequest extends $tea.Model {
+    /**
+     * @remarks
+     * The whitelisted IP CIDR blocks in the VPC that can access the private gateway.
+     */
     aclPolicyListShrink?: string;
     /**
+     * @remarks
+     * The ID of the virtual private cloud (VPC). For more information about how to obtain the VPC ID, see DescribeVpcs.
+     *
      * @example
      * vpc-uf66uio7md****
      */
@@ -1950,16 +1999,25 @@ export declare class DeleteAclPolicyShrinkRequest extends $tea.Model {
 }
 export declare class DeleteAclPolicyResponseBody extends $tea.Model {
     /**
+     * @remarks
+     * The private gateway ID.
+     *
      * @example
      * gw-1uhcqmsc7x22******
      */
     gatewayId?: string;
     /**
+     * @remarks
+     * The returned message.
+     *
      * @example
      * Successfully delete acl policy for gateway
      */
     message?: string;
     /**
+     * @remarks
+     * The request ID.
+     *
      * @example
      * 40325405-579C-4D82****
      */
@@ -3042,7 +3100,7 @@ export declare class DescribeGatewayResponseBody extends $tea.Model {
     gatewayId?: string;
     /**
      * @remarks
-     * The private gateway alias.
+     * The alias of the private gateway.
      *
      * @example
      * mygateway1
@@ -3050,7 +3108,14 @@ export declare class DescribeGatewayResponseBody extends $tea.Model {
     gatewayName?: string;
     /**
      * @remarks
-     * The instance type used for the private gateway.
+     * The instance type used by the private gateway.
+     *
+     * Valid values:
+     *
+     * *   8c16g
+     * *   4c8g
+     * *   2c4g
+     * *   16c32g
      *
      * @example
      * ecs.c6.4xlarge
@@ -3072,6 +3137,21 @@ export declare class DescribeGatewayResponseBody extends $tea.Model {
      * true
      */
     internetEnabled?: boolean;
+    /**
+     * @remarks
+     * Indicates whether Internet access is enabled.
+     *
+     * Valid values:
+     *
+     * *   Creating: Internet access is being enabled.
+     * *   Failed: Internet access failed to be enabled or deleted.
+     * *   Running: Internet access is running.
+     * *   Deleted: Internet access is deleted.
+     * *   Deleting: Internet access is being deleted.
+     *
+     * @example
+     * Running
+     */
     internetStatus?: string;
     /**
      * @remarks
@@ -3081,7 +3161,21 @@ export declare class DescribeGatewayResponseBody extends $tea.Model {
      * gw-1uhcqmsc7x22******-1801786532******-vpc.cn-hangzhou.pai-eas.aliyuncs.com
      */
     intranetDomain?: string;
+    /**
+     * @remarks
+     * Indicates whether it is the default private gateway.
+     *
+     * @example
+     * true
+     */
     isDefault?: boolean;
+    /**
+     * @remarks
+     * The number of nodes in the private gateway.
+     *
+     * @example
+     * 2
+     */
     replicas?: number;
     /**
      * @remarks
@@ -3093,7 +3187,17 @@ export declare class DescribeGatewayResponseBody extends $tea.Model {
     requestId?: string;
     /**
      * @remarks
-     * The state of the private gateway.
+     * The status of the private gateway.
+     *
+     * Valid values:
+     *
+     * *   Creating
+     * *   Stopped
+     * *   Failed
+     * *   Running
+     * *   Deleted
+     * *   Deleting
+     * *   Waiting
      *
      * @example
      * PrivateGatewayRunning
@@ -4166,6 +4270,9 @@ export declare class DevelopServiceResponse extends $tea.Model {
 }
 export declare class ListAclPolicyRequest extends $tea.Model {
     /**
+     * @remarks
+     * The ID of the virtual private cloud (VPC). For more information about how to obtain the VPC ID, see DescribeVpcs.
+     *
      * @example
      * vpc-uf66uio7md****
      */
@@ -4182,13 +4289,27 @@ export declare class ListAclPolicyRequest extends $tea.Model {
 }
 export declare class ListAclPolicyResponseBody extends $tea.Model {
     /**
+     * @remarks
+     * The private gateway ID.
+     *
      * @example
      * gw-1uhcqmsc7x22******
      */
     gatewayId?: string;
+    /**
+     * @remarks
+     * The access control policies of the private gateway over the Internet.
+     */
     internetAclPolicyList?: ListAclPolicyResponseBodyInternetAclPolicyList[];
+    /**
+     * @remarks
+     * The access control policies of the private gateway over the internal network.
+     */
     intranetVpcAclPolicyList?: ListAclPolicyResponseBodyIntranetVpcAclPolicyList[];
     /**
+     * @remarks
+     * The request ID.
+     *
      * @example
      * 40325405-579C-4D82****
      */
@@ -4328,21 +4449,33 @@ export declare class ListBenchmarkTaskResponse extends $tea.Model {
 }
 export declare class ListGatewayRequest extends $tea.Model {
     /**
+     * @remarks
+     * The private gateway ID. To obtain the private gateway ID, see the private_gateway_id parameter in the response parameters of the ListResources operation.
+     *
      * @example
      * gw-1uhcqmsc7x22******
      */
     gatewayId?: string;
     /**
+     * @remarks
+     * The private gateway alias.
+     *
      * @example
      * mygateway1
      */
     gatewayName?: string;
     /**
+     * @remarks
+     * The page number. Default value: 1.
+     *
      * @example
      * 1
      */
     pageNumber?: number;
     /**
+     * @remarks
+     * The number of entries per page. Default value: 100.
+     *
      * @example
      * 100
      */
@@ -4358,23 +4491,39 @@ export declare class ListGatewayRequest extends $tea.Model {
     });
 }
 export declare class ListGatewayResponseBody extends $tea.Model {
+    /**
+     * @remarks
+     * The private gateways.
+     */
     gateways?: ListGatewayResponseBodyGateways[];
     /**
+     * @remarks
+     * The page number.
+     *
      * @example
      * 1
      */
     pageNumber?: number;
     /**
+     * @remarks
+     * The number of entries per page.
+     *
      * @example
      * 100
      */
     pageSize?: number;
     /**
+     * @remarks
+     * The request ID.
+     *
      * @example
      * 40325405-579C-4D82****
      */
     requestId?: string;
     /**
+     * @remarks
+     * The total number of private gateways returned.
+     *
      * @example
      * 5
      */
@@ -5707,6 +5856,7 @@ export declare class ListServicesRequest extends $tea.Model {
      * eas-r-hd0qwy8cxxxx
      */
     resourceName?: string;
+    role?: string;
     /**
      * @remarks
      * The service name.
@@ -6031,6 +6181,7 @@ export declare class ListServicesShrinkRequest extends $tea.Model {
      * eas-r-hd0qwy8cxxxx
      */
     resourceName?: string;
+    role?: string;
     /**
      * @remarks
      * The service name.
@@ -6339,8 +6490,15 @@ export declare class ListServicesResponse extends $tea.Model {
     });
 }
 export declare class ListTenantAddonsResponseBody extends $tea.Model {
+    /**
+     * @remarks
+     * The information about the plug-in.
+     */
     addons?: ListTenantAddonsResponseBodyAddons[];
     /**
+     * @remarks
+     * The request ID.
+     *
      * @example
      * 40325405-579C-4D82****
      */
@@ -6373,11 +6531,17 @@ export declare class ListTenantAddonsResponse extends $tea.Model {
 }
 export declare class ReinstallTenantAddonResponseBody extends $tea.Model {
     /**
+     * @remarks
+     * The returned message.
+     *
      * @example
      * Addon prometheus_discovery is successfully reinstalled
      */
     message?: string;
     /**
+     * @remarks
+     * The request ID.
+     *
      * @example
      * 40325405-579C-4D82****
      */
@@ -6935,6 +7099,13 @@ export declare class UpdateGatewayRequest extends $tea.Model {
      * ecs.c6.4xlarge
      */
     instanceType?: string;
+    /**
+     * @remarks
+     * Indicates whether it is the default private gateway.
+     *
+     * @example
+     * true
+     */
     isDefault?: boolean;
     /**
      * @remarks
@@ -6944,6 +7115,13 @@ export declare class UpdateGatewayRequest extends $tea.Model {
      * mygateway1
      */
     name?: string;
+    /**
+     * @remarks
+     * The number of nodes in the private gateway.
+     *
+     * @example
+     * 2
+     */
     replicas?: number;
     static names(): {
         [key: string]: string;
@@ -7811,11 +7989,17 @@ export declare class ServiceLabels extends $tea.Model {
 }
 export declare class CreateAclPolicyRequestAclPolicyList extends $tea.Model {
     /**
+     * @remarks
+     * The comment on the IP CIDR block in the VPC that can access the private gateway.
+     *
      * @example
      * default
      */
     comment?: string;
     /**
+     * @remarks
+     * The IP CIDR block in the VPC that can access the private gateway.
+     *
      * @example
      * 10.23.XX.XX/32
      */
@@ -8102,11 +8286,17 @@ export declare class CreateServiceCronScalerRequestScaleJobs extends $tea.Model
 }
 export declare class DeleteAclPolicyRequestAclPolicyList extends $tea.Model {
     /**
+     * @remarks
+     * The comment on the IP CIDR block in the VPC that can access the private gateway.
+     *
      * @example
      * default
      */
     comment?: string;
     /**
+     * @remarks
+     * The IP CIDR block in the VPC that can access the private gateway.
+     *
      * @example
      * 10.23.XX.XX/32
      */
@@ -8414,13 +8604,19 @@ export declare class DescribeSpotDiscountHistoryResponseBodySpotDiscounts extend
         [key: string]: any;
     });
 }
-export declare class ListAclPolicyResponseBodyInternetAclPolicyList extends $tea.Model {
+export declare class ListAclPolicyResponseBodyInternetAclPolicyListAclPolicyList extends $tea.Model {
     /**
+     * @remarks
+     * The comment on the IP CIDR block in the VPC that can access the private gateway over the Internet.
+     *
      * @example
      * default
      */
     comment?: string;
     /**
+     * @remarks
+     * The IP CIDR block in the VPC that can access the private gateway over the Internet.
+     *
      * @example
      * 10.23.XX.XX/32
      */
@@ -8435,13 +8631,35 @@ export declare class ListAclPolicyResponseBodyInternetAclPolicyList extends $tea
         [key: string]: any;
     });
 }
-export declare class ListAclPolicyResponseBodyIntranetVpcAclPolicyListIntranetAclPolicyList extends $tea.Model {
+export declare class ListAclPolicyResponseBodyInternetAclPolicyList extends $tea.Model {
+    /**
+     * @remarks
+     * The whitelisted IP CIDR blocks in the VPC that can access the private gateway over the Internet.
+     */
+    aclPolicyList?: ListAclPolicyResponseBodyInternetAclPolicyListAclPolicyList[];
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class ListAclPolicyResponseBodyIntranetVpcAclPolicyListAclPolicyList extends $tea.Model {
     /**
+     * @remarks
+     * The comment on the IP CIDR block in the VPC that can access the private gateway over the internal network.
+     *
      * @example
      * Test Entry
      */
     comment?: string;
     /**
+     * @remarks
+     * The IP CIDR block in the VPC that can access the private gateway over the internal network.
+     *
      * @example
      * 192.168.XX.XX/24
      */
@@ -8457,8 +8675,15 @@ export declare class ListAclPolicyResponseBodyIntranetVpcAclPolicyListIntranetAc
     });
 }
 export declare class ListAclPolicyResponseBodyIntranetVpcAclPolicyList extends $tea.Model {
-    intranetAclPolicyList?: ListAclPolicyResponseBodyIntranetVpcAclPolicyListIntranetAclPolicyList[];
     /**
+     * @remarks
+     * The whitelisted IP CIDR blocks in the VPC that can access the private gateway over the internal network.
+     */
+    aclPolicyList?: ListAclPolicyResponseBodyIntranetVpcAclPolicyListAclPolicyList[];
+    /**
+     * @remarks
+     * The VPC ID. For more information about how to obtain the VPC ID, see DescribeVpcs.
+     *
      * @example
      * vpc-uf66uio7md****
      */
@@ -8632,56 +8857,99 @@ export declare class ListBenchmarkTaskResponseBodyTasks extends $tea.Model {
 }
 export declare class ListGatewayResponseBodyGateways extends $tea.Model {
     /**
+     * @remarks
+     * The time when the private gateway was created. The time is displayed in UTC.
+     *
      * @example
      * 2020-05-19T14:19:42Z
      */
     createTime?: string;
     /**
+     * @remarks
+     * The private gateway ID.
+     *
      * @example
      * gw-1uhcqmsc7x22******
      */
     gatewayId?: string;
     /**
+     * @remarks
+     * The private gateway alias.
+     *
      * @example
      * mygateway1
      */
     gatewayName?: string;
     /**
+     * @remarks
+     * The type of instances used for the private gateway.
+     *
      * @example
      * 2c4g
      */
     instanceType?: string;
     /**
+     * @remarks
+     * The public endpoint.
+     *
      * @example
      * gw-1uhcqmsc7x22******-1801786532******.cn-wulanchabu.pai-eas.aliyuncs.com
      */
     internetDomain?: string;
     /**
+     * @remarks
+     * Indicates whether Internet access is enabled.
+     *
      * @example
      * true
      */
     internetEnabled?: boolean;
     /**
+     * @remarks
+     * The internal endpoint.
+     *
      * @example
      * gw-1uhcqmsc7x22******-1801786532******-vpc.cn-wulanchabu.pai-eas.aliyuncs.com
      */
     intranetDomain?: string;
     /**
+     * @remarks
+     * Indicates whether it is the default private gateway.
+     *
      * @example
      * true
      */
     isDefault?: boolean;
     /**
+     * @remarks
+     * The number of nodes in the private gateway.
+     *
      * @example
      * 2
      */
     replicas?: number;
     /**
+     * @remarks
+     * The state of the private gateway.
+     *
+     * Valid values:
+     *
+     * *   Creating
+     * *   Stopped
+     * *   Failed
+     * *   Running
+     * *   Deleted
+     * *   Deleting
+     * *   Waiting
+     *
      * @example
      * Running
      */
     status?: string;
     /**
+     * @remarks
+     * The time when the private gateway was updated. The time is displayed in UTC.
+     *
      * @example
      * 2021-02-24T11:52:17Z
      */
@@ -8848,10 +9116,17 @@ export declare class ListServiceVersionsResponseBodyVersions extends $tea.Model
     });
 }
 export declare class ListTenantAddonsResponseBodyAddons extends $tea.Model {
+    /**
+     * @remarks
+     * The attributes of the plug-in.
+     */
     attributes?: {
         [key: string]: string;
     };
     /**
+     * @remarks
+     * The name of the plug-in.
+     *
      * @example
      * prometheus_discovery
      */
@@ -9153,7 +9428,7 @@ export default class Client extends OpenApi {
      */
     commitService(ClusterId: string, ServiceName: string): Promise<CommitServiceResponse>;
     /**
-     * 创建网关访问权限ACL Policy
+     * Creates an access control list (ACL) for a private gateway. The IP CIDR blocks added to the ACL can access the private gateway.
      *
      * @param tmpReq - CreateAclPolicyRequest
      * @param headers - map
@@ -9164,7 +9439,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $Util.RuntimeOptions): Promise<CreateAclPolicyResponse>;
     /**
-     * 创建网关访问权限ACL Policy
+     * Creates an access control list (ACL) for a private gateway. The IP CIDR blocks added to the ACL can access the private gateway.
      *
      * @param request - CreateAclPolicyRequest
      * @returns CreateAclPolicyResponse
@@ -9381,7 +9656,7 @@ export default class Client extends OpenApi {
      */
     createServiceMirror(ClusterId: string, ServiceName: string, request: CreateServiceMirrorRequest): Promise<CreateServiceMirrorResponse>;
     /**
-     * 移除网关acl policy entry
+     * Deletes an access control list (ACL) for a private gateway. The IP CIDR block that is deleted from the ACL cannot access the private gateway.
      *
      * @param tmpReq - DeleteAclPolicyRequest
      * @param headers - map
@@ -9392,7 +9667,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $Util.RuntimeOptions): Promise<DeleteAclPolicyResponse>;
     /**
-     * 移除网关acl policy entry
+     * Deletes an access control list (ACL) for a private gateway. The IP CIDR block that is deleted from the ACL cannot access the private gateway.
      *
      * @param request - DeleteAclPolicyRequest
      * @returns DeleteAclPolicyResponse
@@ -9876,7 +10151,7 @@ export default class Client extends OpenApi {
      */
     developService(ClusterId: string, ServiceName: string, request: DevelopServiceRequest): Promise<DevelopServiceResponse>;
     /**
-     * 查询网关所有ACL Policy
+     * Queries access control lists (ACLs) created for a private gateway.
      *
      * @param request - ListAclPolicyRequest
      * @param headers - map
@@ -9887,7 +10162,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $Util.RuntimeOptions): Promise<ListAclPolicyResponse>;
     /**
-     * 查询网关所有ACL Policy
+     * Queries access control lists (ACLs) created for a private gateway.
      *
      * @param request - ListAclPolicyRequest
      * @returns ListAclPolicyResponse
@@ -9912,7 +10187,7 @@ export default class Client extends OpenApi {
      */
     listBenchmarkTask(request: ListBenchmarkTaskRequest): Promise<ListBenchmarkTaskResponse>;
     /**
-     * 列举gateway
+     * Queries a list of private gateways.
      *
      * @param request - ListGatewayRequest
      * @param headers - map
@@ -9923,7 +10198,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $Util.RuntimeOptions): Promise<ListGatewayResponse>;
     /**
-     * 列举gateway
+     * Queries a list of private gateways.
      *
      * @param request - ListGatewayRequest
      * @returns ListGatewayResponse
@@ -10108,7 +10383,7 @@ export default class Client extends OpenApi {
      */
     listServices(request: ListServicesRequest): Promise<ListServicesResponse>;
     /**
-     * 获取租户配置列表
+     * Queries a list of tenant plug-ins.
      *
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -10118,12 +10393,12 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $Util.RuntimeOptions): Promise<ListTenantAddonsResponse>;
     /**
-     * 获取租户配置列表
+     * Queries a list of tenant plug-ins.
      * @returns ListTenantAddonsResponse
      */
     listTenantAddons(): Promise<ListTenantAddonsResponse>;
     /**
-     * 重置租户配置
+     * Updates the information about a tenant plug-in.
      *
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -10133,7 +10408,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $Util.RuntimeOptions): Promise<ReinstallTenantAddonResponse>;
     /**
-     * 重置租户配置
+     * Updates the information about a tenant plug-in.
      * @returns ReinstallTenantAddonResponse
      */
     reinstallTenantAddon(ClusterId: string, TenantAddonName: string): Promise<ReinstallTenantAddonResponse>;