@alicloud/polardb20170801 8.2.2 → 8.2.4

package/dist/models/CreateApplicationRequest.d.ts

@@ -1,8 +1,68 @@
 import * as $dara from '@darabonba/typescript';
+export declare class CreateApplicationRequestAgenticDBBranchSpec extends $dara.Model {
+    /**
+     * @remarks
+     * The AgenticDB branch ID.
+     *
+     * @example
+     * br-9054b3b7649e4c0d977bd0df37
+     */
+    branchId?: string;
+    /**
+     * @remarks
+     * The AgenticDB cluster ID.
+     *
+     * @example
+     * pagc-2zea920mcvd5o87
+     */
+    DBClusterId?: string;
+    /**
+     * @remarks
+     * The ID of the source application.
+     *
+     * @example
+     * pa-source
+     */
+    forkFromApplicationId?: string;
+    /**
+     * @remarks
+     * Specifies whether to create the application based on a specified AgenticDB branch.
+     *
+     * @example
+     * true
+     */
+    forkFromBranch?: boolean;
+    /**
+     * @remarks
+     * The AgenticDB project ID.
+     *
+     * @example
+     * proj-d7849d0050664c758af795d468
+     */
+    projectId?: string;
+    /**
+     * @remarks
+     * The AgenticDB tenant ID.
+     *
+     * @example
+     * t-cfc2d7df0e59439681f0087f51
+     */
+    tenantId?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class CreateApplicationRequestComponents extends $dara.Model {
     /**
      * @remarks
-     * The specifications of the child component.
+     * The specification of the application subcomponent.
      *
      * @example
      * polar.app.g2.medium
@@ -10,9 +70,9 @@ export declare class CreateApplicationRequestComponents extends $dara.Model {
     componentClass?: string;
     /**
      * @remarks
-     * The maximum number of child components with the same specifications. The default value is the value of ComponentReplica.
+     * The maximum number of replicas for the application subcomponent with the same specification. Default value: the value of ComponentReplica.
      *
-     * - This parameter is supported only for raycluster.
+     * - Only raycluster supports this parameter.
      *
      * @example
      * 1
@@ -20,7 +80,7 @@ export declare class CreateApplicationRequestComponents extends $dara.Model {
     componentMaxReplica?: number;
     /**
      * @remarks
-     * The number of replicas for the child component. The default value is 1.
+     * The number of replicas for the application subcomponent. Default value: 1.
      *
      * @example
      * 1
@@ -28,20 +88,17 @@ export declare class CreateApplicationRequestComponents extends $dara.Model {
     componentReplica?: number;
     /**
      * @remarks
-     * The type of the child component.
+     * The type of the application subcomponent.
      *
-     * For supabase, valid values are:
+     * For supabase, valid values:
      *
      * - gateway
-     *
      * - backend
      *
-     * For raycluster, valid values are:
+     * For raycluster, valid values:
      *
      * - head
-     *
      * - worker
-     *
      * - gpuworker
      *
      * @example
@@ -50,7 +107,7 @@ export declare class CreateApplicationRequestComponents extends $dara.Model {
     componentType?: string;
     /**
      * @remarks
-     * The maximum number of component replicas for scaling.
+     * The maximum number of replicas for component scaling.
      *
      * @example
      * 16
@@ -58,7 +115,7 @@ export declare class CreateApplicationRequestComponents extends $dara.Model {
     scaleMax?: string;
     /**
      * @remarks
-     * The minimum number of component replicas for scaling.
+     * The minimum number of replicas for component scaling.
      *
      * @example
      * 1
@@ -66,7 +123,7 @@ export declare class CreateApplicationRequestComponents extends $dara.Model {
     scaleMin?: string;
     /**
      * @remarks
-     * The security groups for the child component. Separate multiple security group IDs with commas (,).
+     * The list of security groups for the application subcomponent, separated by commas (,).
      *
      * @example
      * sg-********************
@@ -74,7 +131,7 @@ export declare class CreateApplicationRequestComponents extends $dara.Model {
     securityGroups?: string;
     /**
      * @remarks
-     * The name of the IP address whitelist group for the child component. The default value is default.
+     * The name of the whitelist IP address group for the application subcomponent. Default value: default.
      *
      * @example
      * default
@@ -82,7 +139,7 @@ export declare class CreateApplicationRequestComponents extends $dara.Model {
     securityIPArrayName?: string;
     /**
      * @remarks
-     * The IP address whitelist for the child component. Separate multiple IP addresses with commas (,).
+     * The whitelist IP addresses of the application subcomponent, separated by commas (,).
      *
      * @example
      * 127.0.0.1
@@ -90,7 +147,7 @@ export declare class CreateApplicationRequestComponents extends $dara.Model {
     securityIPList?: string;
     /**
      * @remarks
-     * The type of the IP address in the whitelist for the child component. The default value is ipv4.
+     * The type of the whitelist IP addresses for the application subcomponent. Default value: ipv4.
      *
      * @example
      * ipv4
@@ -107,10 +164,38 @@ export declare class CreateApplicationRequestComponents extends $dara.Model {
         [key: string]: any;
     });
 }
+export declare class CreateApplicationRequestDnatEntries extends $dara.Model {
+    /**
+     * @remarks
+     * The frontend port. This parameter is optional. If not specified, the system automatically assigns a port that does not conflict with ports already in use on the gateway. You can query the assignment result by calling the DescribeApplicationAttribute operation.
+     *
+     * @example
+     * 10001
+     */
+    frontPort?: number;
+    /**
+     * @remarks
+     * The port name. Valid values: webui, hermesagent, dashboard, and ssh.
+     *
+     * @example
+     * webui
+     */
+    portName?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class CreateApplicationRequestEndpoints extends $dara.Model {
     /**
      * @remarks
-     * The description of the server-side endpoint.
+     * The description of the service endpoint.
      *
      * @example
      * my_endpoint
@@ -118,7 +203,7 @@ export declare class CreateApplicationRequestEndpoints extends $dara.Model {
     description?: string;
     /**
      * @remarks
-     * The type of the server-side endpoint. This value is fixed to Primary.
+     * The type of the service endpoint. The value is fixed as Primary.
      *
      * @example
      * Primary
@@ -138,7 +223,7 @@ export declare class CreateApplicationRequestEndpoints extends $dara.Model {
 export declare class CreateApplicationRequestKnowledgeApplicationSpec extends $dara.Model {
     /**
      * @remarks
-     * The password for the dashboard.
+     * The dashboard password.
      */
     dashboardPassword?: string;
     /**
@@ -148,7 +233,7 @@ export declare class CreateApplicationRequestKnowledgeApplicationSpec extends $d
     dbPassword?: string;
     /**
      * @remarks
-     * This parameter is required for knowledge applications. It specifies the name of the LLM, such as qwen3-max.
+     * Required for knowledge applications. The LLM model name, such as qwen3-max.
      */
     llmModel?: string;
     static names(): {
@@ -165,7 +250,7 @@ export declare class CreateApplicationRequestKnowledgeApplicationSpec extends $d
 export declare class CreateApplicationRequestMemApplicationSpec extends $dara.Model {
     /**
      * @remarks
-     * The name of the database.
+     * The database name.
      *
      * @example
      * test-database-name
@@ -189,7 +274,7 @@ export declare class CreateApplicationRequestMemApplicationSpec extends $dara.Mo
     dbUser?: string;
     /**
      * @remarks
-     * This parameter is required for mem0 applications. It specifies the name of the embedder model, such as text-embedding-v4.
+     * Required for mem0 applications. The embedder model name, such as text-embedding-v4.
      *
      * @example
      * text-embedding-v4
@@ -205,7 +290,7 @@ export declare class CreateApplicationRequestMemApplicationSpec extends $dara.Mo
     embedderModelDimension?: number;
     /**
      * @remarks
-     * The graph LLM.
+     * The graph LLM model.
      *
      * @example
      * qwen-plus
@@ -213,7 +298,7 @@ export declare class CreateApplicationRequestMemApplicationSpec extends $dara.Mo
     graphLlmModel?: string;
     /**
      * @remarks
-     * This parameter is required for mem0 applications. It specifies the name of the large language model (LLM), such as qwen3-max.
+     * Required for mem0 applications. The LLM model name, such as qwen3-max.
      *
      * @example
      * qwen3-max
@@ -221,7 +306,7 @@ export declare class CreateApplicationRequestMemApplicationSpec extends $dara.Mo
     llmModel?: string;
     /**
      * @remarks
-     * The project name. This corresponds to the schema in the database where project data is stored.
+     * The project name, which corresponds to the database schema that stores project data.
      *
      * @example
      * test-project-name
@@ -229,7 +314,7 @@ export declare class CreateApplicationRequestMemApplicationSpec extends $dara.Mo
     projectName?: string;
     /**
      * @remarks
-     * This parameter is required for mem0 applications. It specifies the name of the reranker model, such as qwen3-rerank.
+     * Required for mem0 applications. The reranker model name, such as qwen3-rerank.
      *
      * @example
      * qwen3-rerank
@@ -237,7 +322,7 @@ export declare class CreateApplicationRequestMemApplicationSpec extends $dara.Mo
     rerankerModel?: string;
     /**
      * @remarks
-     * The number of sharded tables.
+     * The number of table shards.
      *
      * @example
      * 1
@@ -257,7 +342,7 @@ export declare class CreateApplicationRequestMemApplicationSpec extends $dara.Mo
 export declare class CreateApplicationRequestParameters extends $dara.Model {
     /**
      * @remarks
-     * The name of the parameter.
+     * The parameter name.
      *
      * @example
      * secret.gateway.auth.token
@@ -265,7 +350,7 @@ export declare class CreateApplicationRequestParameters extends $dara.Model {
     parameterName?: string;
     /**
      * @remarks
-     * The value of the parameter.
+     * The parameter value.
      *
      * @example
      * TK***
@@ -282,10 +367,86 @@ export declare class CreateApplicationRequestParameters extends $dara.Model {
         [key: string]: any;
     });
 }
+export declare class CreateApplicationRequestStorages extends $dara.Model {
+    /**
+     * @remarks
+     * The mount path inside the container.
+     *
+     * @example
+     * /data/container
+     */
+    containerMountPath?: string;
+    /**
+     * @remarks
+     * The storage endpoint ID.
+     *
+     * @example
+     * pe-xxxx
+     */
+    endpointId?: string;
+    /**
+     * @remarks
+     * The storage mount path.
+     *
+     * @example
+     * /data/source
+     */
+    mountPath?: string;
+    /**
+     * @remarks
+     * The storage capacity.
+     *
+     * @example
+     * 100
+     */
+    storageCapacity?: string;
+    /**
+     * @remarks
+     * The storage access endpoint.
+     *
+     * @example
+     * polarfs.example.com
+     */
+    storageEndpoint?: string;
+    /**
+     * @remarks
+     * The storage instance ID.
+     *
+     * @example
+     * pfs-xxxx
+     */
+    storageInstanceId?: string;
+    /**
+     * @remarks
+     * The storage performance level.
+     *
+     * @example
+     * PL1
+     */
+    storagePerformanceLevel?: string;
+    /**
+     * @remarks
+     * The storage type.
+     *
+     * @example
+     * oss
+     */
+    storageType?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class CreateApplicationRequestTag extends $dara.Model {
     /**
      * @remarks
-     * The key of the tag.
+     * The tag key.
      *
      * @example
      * testKey
@@ -293,7 +454,7 @@ export declare class CreateApplicationRequestTag extends $dara.Model {
     key?: string;
     /**
      * @remarks
-     * The value of the tag.
+     * The tag value.
      *
      * @example
      * testValue
@@ -313,7 +474,7 @@ export declare class CreateApplicationRequestTag extends $dara.Model {
 export declare class CreateApplicationRequest extends $dara.Model {
     /**
      * @remarks
-     * The ID of an existing model operator instance to associate. This parameter is effective only when ApplicationType is set to polarclaw.
+     * The ID of an existing model operator instance to associate. This parameter takes effect only when ApplicationType is set to polarclaw.
      *
      * @example
      * pm-xxxxxx
@@ -321,13 +482,19 @@ export declare class CreateApplicationRequest extends $dara.Model {
     AIDBClusterId?: string;
     /**
      * @remarks
-     * The type of the application. Valid values:
-     *
-     * - supabase: Creates a managed Supabase application.
+     * The AgenticDB branch specification.
      *
-     * - raycluster: Creates a managed Ray Cluster application.
+     * @example
+     * {"DBClusterId":"pagc-2zea920mcvd5o87","TenantId":"t-cfc2d7df0e59439681f0087f51","ProjectId":"proj-d7849d0050664c758af795d468","BranchId":"br-9054b3b7649e4c0d977bd0df37","ForkFromBranch":true,"ForkFromApplicationId":"pa-source"}
+     */
+    agenticDBBranchSpec?: CreateApplicationRequestAgenticDBBranchSpec;
+    /**
+     * @remarks
+     * The application type. Valid values:
      *
-     * - polarclaw: Creates a managed PolarClaw application.
+     * - supabase: Set this value to create a managed Supabase application.
+     * - raycluster: Set this value to create a managed Ray Cluster application.
+     * - polarclaw: Set this value to create a managed PolarClaw application.
      *
      * This parameter is required.
      *
@@ -337,7 +504,7 @@ export declare class CreateApplicationRequest extends $dara.Model {
     applicationType?: string;
     /**
      * @remarks
-     * The CPU architecture. Valid value:
+     * The CPU architecture. Valid values:
      *
      * - x86
      *
@@ -357,7 +524,7 @@ export declare class CreateApplicationRequest extends $dara.Model {
     authProvider?: string;
     /**
      * @remarks
-     * The configuration of the authentication provider.
+     * The authentication provider configuration.
      *
      * @example
      * xxx
@@ -365,7 +532,7 @@ export declare class CreateApplicationRequest extends $dara.Model {
     authProviderConfig?: string;
     /**
      * @remarks
-     * Specifies whether to automatically create and bind an Elastic IP Address (EIP).
+     * Specifies whether to enable automatic creation of an elastic IP address (EIP) and attach it to the instance. This is equivalent to associate with an EIP.
      *
      * @example
      * qwen3-max
@@ -373,11 +540,9 @@ export declare class CreateApplicationRequest extends $dara.Model {
     autoAllocatePublicEip?: boolean;
     /**
      * @remarks
-     * Specifies whether to automatically create a PolarFS cold storage instance. Valid values:
-     *
-     * - false (default): Does not automatically create the instance.
-     *
-     * - true: Automatically creates the instance.
+     * Specifies whether to enable automatic creation of a cold storage Polarlakebase instance. Valid values:
+     * * false (default): Automatic creation is disabled.
+     * * true: Automatic creation is enabled.
      *
      * @example
      * false
@@ -393,11 +558,9 @@ export declare class CreateApplicationRequest extends $dara.Model {
     autoRenew?: boolean;
     /**
      * @remarks
-     * Specifies whether to automatically use a coupon. Valid values:
-     *
-     * - true (default): Uses a coupon.
-     *
-     * - false: Does not use a coupon.
+     * Specifies whether to automatically use coupons. Valid values:
+     * * true (default): Use coupons.
+     * * false: Do not use coupons.
      *
      * @example
      * true
@@ -405,12 +568,12 @@ export declare class CreateApplicationRequest extends $dara.Model {
     autoUseCoupon?: boolean;
     /**
      * @remarks
-     * A list of custom child components for the application.
+     * The list of user-defined application subcomponents.
      */
     components?: CreateApplicationRequestComponents[];
     /**
      * @remarks
-     * The ID of the PolarDB instance that the application depends on.
+     * The instance ID of the PolarDB instance on which the application depends.
      *
      * @example
      * pc-**************
@@ -426,7 +589,20 @@ export declare class CreateApplicationRequest extends $dara.Model {
     description?: string;
     /**
      * @remarks
-     * The default value is `false`. If you set this parameter to `true`, the system only checks the parameters and resources without creating the actual resources.
+     * The list of expected DNAT entries for NAT mapping. Specify this parameter together with VpcNatGatewayId. This parameter can be left empty, which indicates that no DNAT entries are created.
+     */
+    dnatEntries?: CreateApplicationRequestDnatEntries[];
+    /**
+     * @remarks
+     * The DNAT-dedicated NAT IP address that has been allocated (separate from the SNAT IP address) for NAT mapping. The IP address must belong to the specified gateway and be in an available state. The vSwitch of the gateway must belong to a primary CIDR block that is reachable from the office network. Specify this parameter together with VpcNatGatewayId. Prerequisite: An SNAT entry has been bound to the vSwitch where the application resides.
+     *
+     * @example
+     * 10.64.0.10
+     */
+    dnatIpAddress?: string;
+    /**
+     * @remarks
+     * Default value: `false`. If you set this parameter to `true`, only parameter and resource validation is performed without actually creating the resource.
      *
      * @example
      * false
@@ -434,22 +610,22 @@ export declare class CreateApplicationRequest extends $dara.Model {
     dryRun?: boolean;
     /**
      * @remarks
-     * A list of custom server-side endpoints. By default, a VPC Endpoint is created.
+     * The list of user-defined service endpoints. By default, a VPC endpoint is created.
      */
     endpoints?: CreateApplicationRequestEndpoints[];
     /**
      * @remarks
-     * This parameter is required for knowledge applications.
+     * Required for knowledge applications.
      */
     knowledgeApplicationSpec?: CreateApplicationRequestKnowledgeApplicationSpec;
     /**
      * @remarks
-     * This parameter is required for mem0 applications.
+     * Required for mem0 applications.
      */
     memApplicationSpec?: CreateApplicationRequestMemApplicationSpec;
     /**
      * @remarks
-     * The model API. This parameter is effective only when ApplicationType is set to polarclaw.
+     * The model API. This parameter takes effect only when ApplicationType is set to polarclaw.
      *
      * @example
      * openai-completions
@@ -457,7 +633,7 @@ export declare class CreateApplicationRequest extends $dara.Model {
     modelApi?: string;
     /**
      * @remarks
-     * The API key for the model. This parameter is effective only when ApplicationType is set to polarclaw.
+     * The model API key. This parameter takes effect only when ApplicationType is set to polarclaw.
      *
      * @example
      * sk-xxxxxx
@@ -465,7 +641,7 @@ export declare class CreateApplicationRequest extends $dara.Model {
     modelApiKey?: string;
     /**
      * @remarks
-     * The URL of the model. This parameter is effective only when ApplicationType is set to polarclaw.
+     * The model base URL. This parameter takes effect only when ApplicationType is set to polarclaw.
      *
      * @example
      * https://dashscope.aliyuncs.com/compatible-mode/v1
@@ -473,13 +649,11 @@ export declare class CreateApplicationRequest extends $dara.Model {
     modelBaseUrl?: string;
     /**
      * @remarks
-     * The source of the model. Valid values:
-     *
-     * - bailian: Alibaba Cloud Model Studio model.
+     * The model source. Valid values:
      *
-     * - custom: A custom model.
-     *
-     * - maas: PolarDB model operator.
+     * * bailian: Alibaba Cloud Model Studio model.
+     * * custom: Custom model.
+     * * maas: PolarDB model operator.
      *
      * @example
      * bailian
@@ -487,7 +661,7 @@ export declare class CreateApplicationRequest extends $dara.Model {
     modelFrom?: string;
     /**
      * @remarks
-     * The name of the model. This parameter is effective only when ApplicationType is set to polarclaw.
+     * The model name. This parameter takes effect only when ApplicationType is set to polarclaw.
      *
      * @example
      * qwen3-max
@@ -495,12 +669,12 @@ export declare class CreateApplicationRequest extends $dara.Model {
     modelName?: string;
     /**
      * @remarks
-     * A list of parameters.
+     * The list of parameters.
      */
     parameters?: CreateApplicationRequestParameters[];
     /**
      * @remarks
-     * The billing method.
+     * The billing type.
      *
      * @example
      * Postpaid
@@ -508,7 +682,7 @@ export declare class CreateApplicationRequest extends $dara.Model {
     payType?: string;
     /**
      * @remarks
-     * The subscription period type.
+     * The subscription type (yearly or monthly).
      *
      * @example
      * Year
@@ -516,12 +690,10 @@ export declare class CreateApplicationRequest extends $dara.Model {
     period?: string;
     /**
      * @remarks
-     * The ID of the PolarFileSystem (PolarFS) cold storage or high-performance instance. This parameter is empty by default. If you specify this parameter, the corresponding storage is mounted to the application.
-     *
-     * This feature is currently supported only by the following applications:
+     * The instance ID of the Polarlakebase cold storage or high-performance edition. Default value: empty. If specified, the corresponding storage is mounted to the application.
      *
+     * Currently, only the following applications support this parameter:
      * - supabase
-     *
      * - raycluster
      *
      * @example
@@ -538,7 +710,7 @@ export declare class CreateApplicationRequest extends $dara.Model {
     promotionCode?: string;
     /**
      * @remarks
-     * The region. The default value is the region of the instance.
+     * The region. Default value: the region of the instance.
      *
      * @example
      * cn-beijing
@@ -546,7 +718,7 @@ export declare class CreateApplicationRequest extends $dara.Model {
     regionId?: string;
     /**
      * @remarks
-     * The ID of the resource group.
+     * The resource group ID.
      *
      * @example
      * rg-********************
@@ -554,7 +726,7 @@ export declare class CreateApplicationRequest extends $dara.Model {
     resourceGroupId?: string;
     /**
      * @remarks
-     * The ID of the security group.
+     * The security group ID.
      *
      * @example
      * sg-********************
@@ -562,7 +734,7 @@ export declare class CreateApplicationRequest extends $dara.Model {
     securityGroupId?: string;
     /**
      * @remarks
-     * The name of the IP address whitelist group. The default value is `default`.
+     * The name of the IP whitelist group. Default value: `default`.
      *
      * @example
      * default
@@ -570,7 +742,7 @@ export declare class CreateApplicationRequest extends $dara.Model {
     securityIPArrayName?: string;
     /**
      * @remarks
-     * The IP address whitelist. If you do not specify this parameter, the default value `127.0.0.1` is used.
+     * The IP whitelist. If you do not specify this parameter, the default value is `127.0.0.1`.
      *
      * @example
      * 127.0.0.1,172.17.0.0/24
@@ -586,7 +758,7 @@ export declare class CreateApplicationRequest extends $dara.Model {
     securityIPType?: string;
     /**
      * @remarks
-     * The ID of the skill template.
+     * The skill template ID.
      *
      * @example
      * xxx
@@ -594,7 +766,15 @@ export declare class CreateApplicationRequest extends $dara.Model {
     skillTemplateId?: string;
     /**
      * @remarks
-     * The tag.
+     * The list of application storages.
+     *
+     * @example
+     * [{"StorageType":"oss","StorageInstanceId":"pfs-xxxx","EndpointId":"pe-xxxx"}]
+     */
+    storages?: CreateApplicationRequestStorages[];
+    /**
+     * @remarks
+     * The tags.
      */
     tag?: CreateApplicationRequestTag[];
     /**
@@ -615,7 +795,7 @@ export declare class CreateApplicationRequest extends $dara.Model {
     usedTime?: string;
     /**
      * @remarks
-     * The vSwitch. The default value is the current vSwitch in the primary zone of the instance.
+     * The vSwitch. Default value: the vSwitch in the primary zone of the instance.
      *
      * @example
      * vsw-*********************
@@ -623,7 +803,7 @@ export declare class CreateApplicationRequest extends $dara.Model {
     vSwitchId?: string;
     /**
      * @remarks
-     * The ID of the Virtual Private Cloud (VPC).
+     * The VPC ID.
      *
      * @example
      * vpc-********************
@@ -631,7 +811,15 @@ export declare class CreateApplicationRequest extends $dara.Model {
     vpcId?: string;
     /**
      * @remarks
-     * The zone. The default value is the primary zone of the instance.
+     * The VPC NAT gateway ID for NAT mapping. If specified, NAT mapping is enabled when the instance is created. The NAT gateway must be in the same VPC as the application, use the private network type (intranet), and be in an active state.
+     *
+     * @example
+     * ngw-xxx
+     */
+    vpcNatGatewayId?: string;
+    /**
+     * @remarks
+     * The zone. Default value: the primary zone of the instance.
      *
      * @example
      * cn-beijing-k