@alicloud/agentcore20260804 2.2.1 → 2.3.1

package/dist/models/UpdateCustomAgentRequest.d.ts

@@ -0,0 +1,757 @@
+import * as $dara from '@darabonba/typescript';
+export declare class UpdateCustomAgentRequestBodyAgenticFsMounts extends $dara.Model {
+    /**
+     * @remarks
+     * The subdirectory under /mnt/agenticfs/ in the container. This field is required for each mount item. Mount targets must not be duplicated or form parent-child overrides.
+     *
+     * @example
+     * /mnt/agenticfs/data
+     */
+    mountPath?: string;
+    /**
+     * @remarks
+     * The existing non-empty relative directory under the access point. This field is required for each mount item. Root directories, absolute paths, and parent directory traversals are not allowed.
+     *
+     * @example
+     * workspace/data
+     */
+    path?: string;
+    /**
+     * @remarks
+     * Specifies whether the mount is read-only. A value of true indicates read-only, and false indicates read and write. If omitted, the default value is false.
+     *
+     * @example
+     * false
+     */
+    readOnly?: boolean;
+    /**
+     * @remarks
+     * The domain name of the access point. This field is required for each mount item. Use the DomainName value from the NAS ListAccessPoints response. Do not include the protocol, port, or path.
+     *
+     * @example
+     * ap-0123456789abcdef0.0123456789-vlm36.cn-hangzhou.nas.aliyuncs.com
+     */
+    server?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class UpdateCustomAgentRequestBodyArtifactCode extends $dara.Model {
+    /**
+     * @remarks
+     * The startup entry point for the code package. Code package deployment is currently not supported. Omit this field.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * python app.py
+     */
+    entrypoint?: string;
+    /**
+     * @remarks
+     * The language runtime identifier for the code package. Code package deployment is currently not supported. Omit this field.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * python
+     */
+    languageRuntime?: string;
+    /**
+     * @remarks
+     * The source URI of the code package. Code package deployment is currently not supported. Omit this field.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * oss://my-agent-bucket/packages/agent.zip
+     */
+    sourceUri?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class UpdateCustomAgentRequestBodyArtifactContainer extends $dara.Model {
+    /**
+     * @remarks
+     * The optional executable program and startup parameters. If specified, this must be a non-empty string. When updating the artifact, omitting this field uses the default startup method of the image. To retain the original custom startup command, provide this field together.
+     *
+     * @example
+     * python app.py
+     */
+    entrypoint?: string;
+    /**
+     * @remarks
+     * The ID of the ACR instance to which the image repository belongs. This field cannot be empty.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * cri-a1b2c3d4e5f6
+     */
+    instanceId?: string;
+    /**
+     * @remarks
+     * The namespace to which the ACR image repository belongs. This field cannot be empty.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * my-agent
+     */
+    namespace?: string;
+    /**
+     * @remarks
+     * The name of the image repository in the ACR namespace. This field cannot be empty.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * chat-agent
+     */
+    repo?: string;
+    /**
+     * @remarks
+     * The image tag used for deployment. This field cannot be empty. When updating the tag, you must also provide artifact.port and other required image fields.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * v1.0.0
+     */
+    tag?: string;
+    /**
+     * @remarks
+     * The image source type. Currently, only acr is supported, which indicates Alibaba Cloud Container Registry (ACR).
+     *
+     * This parameter is required.
+     *
+     * @example
+     * acr
+     */
+    type?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class UpdateCustomAgentRequestBodyArtifact extends $dara.Model {
+    /**
+     * @remarks
+     * The code package deployment configuration. This is currently not supported. Omit this field and use artifact.container instead.
+     */
+    code?: UpdateCustomAgentRequestBodyArtifactCode;
+    /**
+     * @remarks
+     * The ACR container image configuration. You must specify the type, instanceId, namespace, repo, and tag fields. Do not configure the code field at the same time.
+     */
+    container?: UpdateCustomAgentRequestBodyArtifactContainer;
+    /**
+     * @remarks
+     * The TCP port listened to by the agent service. Valid values: 1 to 65535.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * 8080
+     */
+    port?: number;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class UpdateCustomAgentRequestBodyEnvironmentVariables extends $dara.Model {
+    /**
+     * @remarks
+     * The name of the environment variable. This field cannot be empty and must be unique within the current environment variable list.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * LOG_LEVEL
+     */
+    name?: string;
+    /**
+     * @remarks
+     * The value of the environment variable. This must be a string. Empty strings are allowed.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * info
+     */
+    value?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class UpdateCustomAgentRequestBodyEnvironment extends $dara.Model {
+    /**
+     * @remarks
+     * The list of environment variables. Each item includes a name and a value. This list is replaced in its entirety during an update.
+     */
+    variables?: UpdateCustomAgentRequestBodyEnvironmentVariables[];
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class UpdateCustomAgentRequestBodyHealthCheck extends $dara.Model {
+    /**
+     * @remarks
+     * This parameter currently does not take effect. Omit this field.
+     *
+     * @example
+     * 1
+     */
+    healthyThreshold?: number;
+    /**
+     * @remarks
+     * The interval between two health checks, in seconds. This must be a positive integer. If omitted, the default value is 10.
+     *
+     * @example
+     * 10
+     */
+    intervalSeconds?: number;
+    /**
+     * @remarks
+     * The HTTP health check path. This must start with a forward slash (/). If omitted, the default value is /healthz.
+     *
+     * @example
+     * /healthz
+     */
+    path?: string;
+    /**
+     * @remarks
+     * The port accessed for health checks. This field is required when configuring a health check. Valid values: 1 to 65535.
+     *
+     * @example
+     * 8080
+     */
+    port?: number;
+    /**
+     * @remarks
+     * The timeout period for a single health check, in seconds. This must be a positive integer and less than intervalSeconds. If omitted, the default value is 2.
+     *
+     * @example
+     * 2
+     */
+    timeoutSeconds?: number;
+    /**
+     * @remarks
+     * The number of consecutive health check failures required to mark the agent as unhealthy. This must be a positive integer. If omitted, the default value is 3.
+     *
+     * @example
+     * 3
+     */
+    unhealthyThreshold?: number;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class UpdateCustomAgentRequestBodyLoggingSls extends $dara.Model {
+    /**
+     * @remarks
+     * The name of the Simple Log Service logstore that receives agent logs.
+     *
+     * @example
+     * agent-runtime
+     */
+    logstore?: string;
+    /**
+     * @remarks
+     * The name of the Simple Log Service project that receives agent logs.
+     *
+     * @example
+     * my-agent-logs
+     */
+    project?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class UpdateCustomAgentRequestBodyLogging extends $dara.Model {
+    /**
+     * @remarks
+     * The Simple Log Service log delivery destination. When updating this object, you must provide both the project and logstore fields, and they cannot be empty.
+     */
+    sls?: UpdateCustomAgentRequestBodyLoggingSls;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class UpdateCustomAgentRequestBodyNetworkAccessInternet extends $dara.Model {
+    /**
+     * @remarks
+     * Specifies whether to allow the agent to access the Internet. A Boolean value is required when configuring accessInternet. For this to take effect, the workspace must also allow Internet access.
+     */
+    enabled?: boolean;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class UpdateCustomAgentRequestBodyNetworkAccessVpc extends $dara.Model {
+    /**
+     * @remarks
+     * Specifies whether to allow the agent to access the user VPC configured for the workspace. A Boolean value is required when configuring accessVpc. For this to take effect, the workspace must also allow VPC access.
+     */
+    enabled?: boolean;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class UpdateCustomAgentRequestBodyNetwork extends $dara.Model {
+    /**
+     * @remarks
+     * The Internet access configuration. If this access item is omitted, Internet access is not restricted on the agent side. However, the workspace must still allow Internet access.
+     */
+    accessInternet?: UpdateCustomAgentRequestBodyNetworkAccessInternet;
+    /**
+     * @remarks
+     * The user VPC access configuration. If this access item is omitted, VPC access is not restricted on the agent side. However, the workspace must still be configured to allow access to the user VPC.
+     */
+    accessVpc?: UpdateCustomAgentRequestBodyNetworkAccessVpc;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class UpdateCustomAgentRequestBodyOssMounts extends $dara.Model {
+    /**
+     * @remarks
+     * The name of the OSS bucket. This field is required for each mount item. The name must be 3 to 63 characters in length and can contain only lowercase letters, digits, and hyphens. It cannot start or end with a hyphen.
+     *
+     * @example
+     * my-agent-data
+     */
+    bucketName?: string;
+    /**
+     * @remarks
+     * The subdirectory under /mnt/oss/ in the container. This field is required for each mount item. Mount targets must not be duplicated or form parent-child overrides.
+     *
+     * @example
+     * /mnt/oss/train
+     */
+    mountPath?: string;
+    /**
+     * @remarks
+     * The non-empty object directory prefix in the bucket, such as datasets/train. Leading and trailing forward slashes (/) are removed. Root directories are not supported. Do not use parent directory traversals.
+     *
+     * @example
+     * datasets/train
+     */
+    path?: string;
+    /**
+     * @remarks
+     * Specifies whether the mount is read-only. A value of true indicates read-only, and false indicates read and write. If omitted, the default value is false.
+     */
+    readOnly?: boolean;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class UpdateCustomAgentRequestBodyProtocolPaths extends $dara.Model {
+    /**
+     * @remarks
+     * The description of the current API path.
+     *
+     * @example
+     * AG-UI conversation API
+     */
+    description?: string;
+    /**
+     * @remarks
+     * The non-empty API path corresponding to the current protocol.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * /agui
+     */
+    name?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class UpdateCustomAgentRequestBodyProtocol extends $dara.Model {
+    /**
+     * @remarks
+     * The request header configuration for the current protocol. The key is a non-empty request header name, and the value must be a string.
+     */
+    headers?: {
+        [key: string]: string;
+    };
+    /**
+     * @remarks
+     * The list of API paths corresponding to the current protocol.
+     */
+    paths?: UpdateCustomAgentRequestBodyProtocolPaths[];
+    /**
+     * @remarks
+     * The invocation protocol type. Valid values:
+     * - agui: AG-UI protocol.
+     * - openai-chat-completion: OpenAI Chat Completions compatible protocol.
+     * - custom: Custom protocol.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * agui
+     */
+    type?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class UpdateCustomAgentRequestBodyRuntimeCompute extends $dara.Model {
+    /**
+     * @remarks
+     * The compute specification. Valid values:
+     * - INTERACTIVE: 1 vCPU and 2 GiB of memory.
+     * - STANDARD: 2 vCPUs and 4 GiB of memory.
+     * - HEAVY: 4 vCPUs and 8 GiB of memory.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * STANDARD
+     */
+    computeClass?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class UpdateCustomAgentRequestBodyRuntimeHpa extends $dara.Model {
+    /**
+     * @remarks
+     * Specifies whether to enable elastic scaling. Valid values:
+     * - true: Enabled.
+     * - false: Disabled.
+     * When runtime is provided, omitting this field defaults to false.
+     *
+     * This parameter is required.
+     */
+    enabled?: boolean;
+    /**
+     * @remarks
+     * The maximum number of concurrent sessions for a single runtime instance. Valid values: 1 to 100. When runtime is provided, omitting this field uses the default value of 100.
+     *
+     * @example
+     * 100
+     */
+    maxConcurrentSessionsPerSandbox?: number;
+    /**
+     * @remarks
+     * The maximum number of runtime instances. Valid values: 1 to 100. The value cannot be less than minSandboxCount. When runtime is provided, omitting this field uses the default value of 10.
+     *
+     * @example
+     * 10
+     */
+    maxSandboxCount?: number;
+    /**
+     * @remarks
+     * The minimum number of runtime instances. Valid values: 1 to 100. The value cannot be greater than maxSandboxCount. When runtime is provided, omitting this field uses the default value of 1.
+     *
+     * @example
+     * 1
+     */
+    minSandboxCount?: number;
+    /**
+     * @remarks
+     * The session idle timeout in seconds. Valid values: 60 to 86400. When runtime is provided, omitting this field uses the default value of 600.
+     *
+     * @example
+     * 600
+     */
+    sessionTtlSeconds?: number;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class UpdateCustomAgentRequestBodyRuntimeSessionPolicy extends $dara.Model {
+    /**
+     * @remarks
+     * The name of the HTTP request header used by the session policy. This parameter is required when type is ISOLATED_HEADER_FIELD and must be a valid HTTP request header name. Omit this parameter for other policies.
+     *
+     * @example
+     * X-Session-Id
+     */
+    headerName?: string;
+    /**
+     * @remarks
+     * The session policy type. Valid values:
+     * - AFFINITY: Session affinity.
+     * - ISOLATED_HEADER_FIELD: Associates sessions by using the request header specified by headerName.
+     * - ISOLATED_COOKIE: Not recommended.
+     * - DISABLED: A compatibility option. The response returns AFFINITY.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * AFFINITY
+     */
+    type?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class UpdateCustomAgentRequestBodyRuntime extends $dara.Model {
+    /**
+     * @remarks
+     * The compute resource configuration for the agent runtime instance.
+     *
+     * This parameter is required.
+     */
+    compute?: UpdateCustomAgentRequestBodyRuntimeCompute;
+    /**
+     * @remarks
+     * The optional elastic policy. When runtime is provided, omitting hpa or its fields uses the default values: enabled is false, the minimum number of instances is 1, the maximum number of instances is 10, the maximum number of concurrent sessions per instance is 100, and the session idle timeout is 600 seconds. To retain the original policy during an update, provide the complete hpa configuration.
+     */
+    hpa?: UpdateCustomAgentRequestBodyRuntimeHpa;
+    /**
+     * @remarks
+     * The session policy configuration, which is used to set the session association method for requests.
+     *
+     * This parameter is required.
+     */
+    sessionPolicy?: UpdateCustomAgentRequestBodyRuntimeSessionPolicy;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class UpdateCustomAgentRequestBody extends $dara.Model {
+    /**
+     * @remarks
+     * The list of additional AgenticFS mounts. The total number of AgenticFS and OSS mounts cannot exceed 10. During creation, omitting this field or passing an empty array [] indicates no additional mounts. During an update, omitting this field retains the original value, and passing an empty array [] clears the list. You cannot pass null.
+     */
+    agenticFsMounts?: UpdateCustomAgentRequestBodyAgenticFsMounts[];
+    /**
+     * @remarks
+     * The deployment artifact configuration. Currently, only ACR container images are supported. Specify the container field and the service listening port field, and omit the code field. During an update, you must specify the port field and all required fields of the container object.
+     */
+    artifact?: UpdateCustomAgentRequestBodyArtifact;
+    /**
+     * @remarks
+     * The description of the agent\\"s purpose. The maximum length is 1,024 characters after leading and trailing whitespaces are removed. If omitted, the original value is retained. Pass null to clear the description.
+     *
+     * @example
+     * Custom agent that provides conversation services
+     */
+    description?: string;
+    /**
+     * @remarks
+     * The environment variable configuration for the agent process. Omitting this top-level field retains the original value. Providing this object but omitting the variables field clears the custom environment variables. To retain the variables, provide the complete list.
+     */
+    environment?: UpdateCustomAgentRequestBodyEnvironment;
+    /**
+     * @remarks
+     * The optional HTTP health check configuration. When providing this object, you must specify the port field. Other unspecified items use default values. Omitting this field during creation indicates no configuration. During an update, omitting this top-level field retains the original configuration, and passing null removes the health check.
+     */
+    healthCheck?: UpdateCustomAgentRequestBodyHealthCheck;
+    /**
+     * @remarks
+     * The log delivery configuration for the agent. You can specify the Simple Log Service project and logstore. After a successful creation or update, verify that logs are delivered properly.
+     */
+    logging?: UpdateCustomAgentRequestBodyLogging;
+    /**
+     * @remarks
+     * The name of the custom agent. The length must be 1 to 128 characters after leading and trailing whitespaces are removed. The name must be unique within the same workspace. If omitted, the original value is retained. You cannot pass null or a blank name.
+     *
+     * @example
+     * my-custom-agent
+     */
+    name?: string;
+    /**
+     * @remarks
+     * The network access configuration for the agent. When providing this object, omitted access items are treated as allowed. The actual accessible scope is still subject to the workspace network configuration. To retain the original restrictions during an update, specify both accessInternet and accessVpc.
+     */
+    network?: UpdateCustomAgentRequestBodyNetwork;
+    /**
+     * @remarks
+     * The list of OSS mounts. The total number of OSS and AgenticFS mounts cannot exceed 10. For each item, you must specify the bucketName, path, and mountPath fields. Mount targets must not be duplicated or overlap with each other. This list is replaced in its entirety during an update. Pass an empty array [] to clear the list.
+     */
+    ossMounts?: UpdateCustomAgentRequestBodyOssMounts[];
+    /**
+     * @remarks
+     * The list of invocation protocols supported by the agent. Each item includes the protocol type, along with optional paths and request headers. The entire list is replaced during an update.
+     */
+    protocol?: UpdateCustomAgentRequestBodyProtocol[];
+    /**
+     * @remarks
+     * The ARN of the RAM role used by the agent to access user cloud resources. The role must have permissions to access the cloud resources.
+     *
+     * @example
+     * acs:ram::1234567890123456:role/agentcore-runtime-role
+     */
+    roleArn?: string;
+    /**
+     * @remarks
+     * The runtime configuration. When this object is provided, both compute and sessionPolicy must be present. To retain the original elastic policy, provide the complete hpa configuration. Omitting the top-level runtime field retains the original configuration.
+     */
+    runtime?: UpdateCustomAgentRequestBodyRuntime;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class UpdateCustomAgentRequest extends $dara.Model {
+    /**
+     * @remarks
+     * The update configuration for the custom agent. Provide at least one top-level field. Omitted top-level fields retain their original values. When providing a configuration object, specify its required subfields and include any optional configurations that you want to retain. Arrays are replaced in their entirety.
+     */
+    body?: UpdateCustomAgentRequestBody;
+    /**
+     * @remarks
+     * Idempotency is not currently guaranteed. Do not rely on this parameter to prevent duplicate requests.
+     *
+     * @example
+     * custom-agent-request-20261010-001
+     */
+    clientToken?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}