@alicloud/agentcore20260804 2.2.0 → 2.3.0

package/dist/models/CreateCustomAgentResponseBody.d.ts

@@ -0,0 +1,923 @@
+import * as $dara from '@darabonba/typescript';
+export declare class CreateCustomAgentResponseBodyDataAgenticFsMounts extends $dara.Model {
+    /**
+     * @remarks
+     * The AgenticFS mount directory in the container, located under /mnt/agenticfs/.
+     *
+     * @example
+     * /mnt/agenticfs/data
+     */
+    mountPath?: string;
+    /**
+     * @remarks
+     * The relative directory within the mounted access point.
+     *
+     * @example
+     * workspace/data
+     */
+    path?: string;
+    /**
+     * @remarks
+     * Specifies whether the mount is read-only. A value of true indicates that the mount is read-only. A value of false indicates that the mount is readable and writable.
+     *
+     * @example
+     * false
+     */
+    readOnly?: boolean;
+    /**
+     * @remarks
+     * The domain name of the AgenticFS access point used for the mount.
+     *
+     * @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 CreateCustomAgentResponseBodyDataArtifactCode extends $dara.Model {
+    /**
+     * @remarks
+     * The startup entry point of the code package. Code package deployment is not supported.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * python app.py
+     */
+    entrypoint?: string;
+    /**
+     * @remarks
+     * The language runtime identifier of the code package. Code package deployment is not supported.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * python
+     */
+    languageRuntime?: string;
+    /**
+     * @remarks
+     * The source URI of the code package. Code package deployment is not supported.
+     *
+     * 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 CreateCustomAgentResponseBodyDataArtifactContainer extends $dara.Model {
+    /**
+     * @remarks
+     * The custom executable program and startup parameters. If not configured, the default startup method of the image is used.
+     *
+     * @example
+     * python app.py
+     */
+    entrypoint?: string;
+    /**
+     * @remarks
+     * The ID of the ACR instance to which the image repository belongs.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * cri-a1b2c3d4e5f6
+     */
+    instanceId?: string;
+    /**
+     * @remarks
+     * The namespace to which the ACR image repository belongs.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * my-agent
+     */
+    namespace?: string;
+    /**
+     * @remarks
+     * The name of the image repository in the ACR namespace.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * chat-agent
+     */
+    repo?: string;
+    /**
+     * @remarks
+     * The latest submitted image tag.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * v1.0.0
+     */
+    tag?: string;
+    /**
+     * @remarks
+     * The image source type. A value of acr indicates Alibaba Cloud Container Registry.
+     *
+     * 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 CreateCustomAgentResponseBodyDataArtifact extends $dara.Model {
+    /**
+     * @remarks
+     * The code package configuration field. Code package deployment is not supported.
+     */
+    code?: CreateCustomAgentResponseBodyDataArtifactCode;
+    /**
+     * @remarks
+     * The latest submitted ACR container image configuration.
+     */
+    container?: CreateCustomAgentResponseBodyDataArtifactContainer;
+    /**
+     * @remarks
+     * The TCP port listened on by the agent service.
+     *
+     * 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 CreateCustomAgentResponseBodyDataEnvironmentVariables extends $dara.Model {
+    /**
+     * @remarks
+     * The name of the environment variable.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * LOG_LEVEL
+     */
+    name?: string;
+    /**
+     * @remarks
+     * The string value of the environment variable. 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 CreateCustomAgentResponseBodyDataEnvironment extends $dara.Model {
+    /**
+     * @remarks
+     * The latest submitted list of environment variables.
+     */
+    variables?: CreateCustomAgentResponseBodyDataEnvironmentVariables[];
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateCustomAgentResponseBodyDataHealthCheck extends $dara.Model {
+    /**
+     * @remarks
+     * This parameter does not take effect.
+     *
+     * @example
+     * 1
+     */
+    healthyThreshold?: number;
+    /**
+     * @remarks
+     * The interval between two consecutive health checks, in seconds.
+     *
+     * @example
+     * 10
+     */
+    intervalSeconds?: number;
+    /**
+     * @remarks
+     * The HTTP Health Check Path.
+     *
+     * @example
+     * /healthz
+     */
+    path?: string;
+    /**
+     * @remarks
+     * The port accessed for the HTTP health check.
+     *
+     * @example
+     * 8080
+     */
+    port?: number;
+    /**
+     * @remarks
+     * The timeout period for a single health check, in seconds.
+     *
+     * @example
+     * 2
+     */
+    timeoutSeconds?: number;
+    /**
+     * @remarks
+     * The number of consecutive health check failures required to mark the agent as unhealthy.
+     *
+     * @example
+     * 3
+     */
+    unhealthyThreshold?: number;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateCustomAgentResponseBodyDataLatestExecutionError extends $dara.Model {
+    /**
+     * @remarks
+     * The reason code for the waiting or execution failure of the latest configuration. This code is used to determine the subsequent handling method.
+     *
+     * @example
+     * AgentExecutionFailed
+     */
+    code?: string;
+    /**
+     * @remarks
+     * The description of the reason why the latest configuration is waiting or has failed to execute. Refer to the code and retryable fields to determine what to do next.
+     *
+     * @example
+     * The agent execution failed. Check the configuration and resubmit
+     */
+    message?: string;
+    /**
+     * @remarks
+     * Specifies whether the operation is automatically retried. A value of true indicates that you can query again later. A value of false indicates that you must check and fix the configuration based on the reason, and then resubmit the request.
+     */
+    retryable?: boolean;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateCustomAgentResponseBodyDataLoggingSls 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 CreateCustomAgentResponseBodyDataLogging extends $dara.Model {
+    /**
+     * @remarks
+     * The Simple Log Service (SLS) log delivery destination.
+     */
+    sls?: CreateCustomAgentResponseBodyDataLoggingSls;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateCustomAgentResponseBodyDataNetworkAccessInternet extends $dara.Model {
+    /**
+     * @remarks
+     * Specifies whether Internet access is allowed on the agent side. The actual access is still restricted by the workspace.
+     */
+    enabled?: boolean;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateCustomAgentResponseBodyDataNetworkAccessVpc extends $dara.Model {
+    /**
+     * @remarks
+     * Specifies whether access to the user VPC configured for the workspace is allowed on the agent side. The actual access is still restricted by the workspace.
+     */
+    enabled?: boolean;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateCustomAgentResponseBodyDataNetwork extends $dara.Model {
+    /**
+     * @remarks
+     * The Internet access configuration of the agent. If this field is not configured, Internet access is allowed on the agent side, but it is still restricted by the workspace.
+     */
+    accessInternet?: CreateCustomAgentResponseBodyDataNetworkAccessInternet;
+    /**
+     * @remarks
+     * The user VPC access configuration of the agent. If this field is not configured, user VPC access is allowed on the agent side, but it is still restricted by the workspace.
+     */
+    accessVpc?: CreateCustomAgentResponseBodyDataNetworkAccessVpc;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateCustomAgentResponseBodyDataOssMounts extends $dara.Model {
+    /**
+     * @remarks
+     * The name of the mounted OSS bucket.
+     *
+     * @example
+     * my-agent-data
+     */
+    bucketName?: string;
+    /**
+     * @remarks
+     * The OSS mount directory in the container, located under /mnt/oss/.
+     *
+     * @example
+     * /mnt/oss/train
+     */
+    mountPath?: string;
+    /**
+     * @remarks
+     * The prefix of the object directory in the mounted bucket.
+     *
+     * @example
+     * datasets/train
+     */
+    path?: string;
+    /**
+     * @remarks
+     * Specifies whether the mount is read-only. A value of true indicates that the mount is read-only. A value of false indicates that the mount is readable and writable.
+     */
+    readOnly?: boolean;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateCustomAgentResponseBodyDataProtocolPaths extends $dara.Model {
+    /**
+     * @remarks
+     * The usage description of the current API path.
+     *
+     * @example
+     * AG-UI conversation API
+     */
+    description?: string;
+    /**
+     * @remarks
+     * The 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 CreateCustomAgentResponseBodyDataProtocol extends $dara.Model {
+    /**
+     * @remarks
+     * The request header configurations for the current protocol. The key is the header name and the value is a string.
+     */
+    headers?: {
+        [key: string]: string;
+    };
+    /**
+     * @remarks
+     * The list of API paths corresponding to the current protocol.
+     */
+    paths?: CreateCustomAgentResponseBodyDataProtocolPaths[];
+    /**
+     * @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 CreateCustomAgentResponseBodyDataRuntimeCompute 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 CreateCustomAgentResponseBodyDataRuntimeHpa extends $dara.Model {
+    /**
+     * @remarks
+     * Specifies whether elastic scaling is enabled. Valid values:
+     * - true: Enabled.
+     * - false: Disabled.
+     *
+     * This parameter is required.
+     */
+    enabled?: boolean;
+    /**
+     * @remarks
+     * The maximum number of concurrent sessions configured for a single runtime instance.
+     *
+     * @example
+     * 100
+     */
+    maxConcurrentSessionsPerSandbox?: number;
+    /**
+     * @remarks
+     * The maximum number of runtime instances configured.
+     *
+     * @example
+     * 10
+     */
+    maxSandboxCount?: number;
+    /**
+     * @remarks
+     * The minimum number of runtime instances configured.
+     *
+     * @example
+     * 1
+     */
+    minSandboxCount?: number;
+    /**
+     * @remarks
+     * The maximum idle time configured for a session, in seconds.
+     *
+     * @example
+     * 600
+     */
+    sessionTtlSeconds?: number;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateCustomAgentResponseBodyDataRuntimeSessionPolicy extends $dara.Model {
+    /**
+     * @remarks
+     * The name of the HTTP request header used by the session policy. This parameter applies to ISOLATED_HEADER_FIELD.
+     *
+     * @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.
+     * Note: The compatibility value DISABLED in a request is returned as 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 CreateCustomAgentResponseBodyDataRuntime extends $dara.Model {
+    /**
+     * @remarks
+     * The compute resource configuration for the agent runtime instance.
+     *
+     * This parameter is required.
+     */
+    compute?: CreateCustomAgentResponseBodyDataRuntimeCompute;
+    /**
+     * @remarks
+     * The elastic policy configurations for the agent.
+     */
+    hpa?: CreateCustomAgentResponseBodyDataRuntimeHpa;
+    /**
+     * @remarks
+     * The session policy configurations for the agent.
+     *
+     * This parameter is required.
+     */
+    sessionPolicy?: CreateCustomAgentResponseBodyDataRuntimeSessionPolicy;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateCustomAgentResponseBodyData extends $dara.Model {
+    /**
+     * @remarks
+     * The unique identifier of the custom agent. You can obtain this ID from the response of the CreateCustomAgent or ListCustomAgents operation.
+     *
+     * @example
+     * agent-550e8400e29b41d4a716446655440000
+     */
+    agentId?: string;
+    /**
+     * @remarks
+     * The latest submitted list of additional AgenticFS mounts.
+     */
+    agenticFsMounts?: CreateCustomAgentResponseBodyDataAgenticFsMounts[];
+    /**
+     * @remarks
+     * The latest submitted deployment artifact configuration, including the service listening port and the ACR container image. To check whether the configuration has taken effect, refer to the latestVersionStatus field.
+     */
+    artifact?: CreateCustomAgentResponseBodyDataArtifact;
+    /**
+     * @remarks
+     * The creation method of the agent. The value is CUSTOM for custom agents.
+     *
+     * @example
+     * CUSTOM
+     */
+    createMode?: string;
+    /**
+     * @remarks
+     * The creation time of the agent. The time is in ISO 8601 format. The trailing Z indicates the UTC time zone. Fractional seconds may be included.
+     *
+     * @example
+     * 2026-10-10T06:00:00Z
+     */
+    createdAt?: string;
+    /**
+     * @remarks
+     * The deployment method of the agent. Custom agents are deployed and managed by the platform. The value is MANAGED for custom agents.
+     *
+     * @example
+     * MANAGED
+     */
+    deployType?: string;
+    /**
+     * @remarks
+     * The description of the agent.
+     *
+     * @example
+     * Custom agent that provides conversation services
+     */
+    description?: string;
+    /**
+     * @remarks
+     * The environment variable configuration for the agent process.
+     */
+    environment?: CreateCustomAgentResponseBodyDataEnvironment;
+    /**
+     * @remarks
+     * The HTTP health check configuration of the agent. This field is empty if no health check is configured.
+     */
+    healthCheck?: CreateCustomAgentResponseBodyDataHealthCheck;
+    /**
+     * @remarks
+     * The waiting or execution error of the latest configuration version. This field is returned only when the version is waiting for a retry or fails to execute.
+     */
+    latestExecutionError?: CreateCustomAgentResponseBodyDataLatestExecutionError;
+    /**
+     * @remarks
+     * The latest configuration version number. Updates with the same configuration may retain the original version number. This field does not indicate that the configuration has taken effect.
+     *
+     * @example
+     * 1
+     */
+    latestSpecVersion?: number;
+    /**
+     * @remarks
+     * The execution status corresponding to latestSpecVersion. Valid values:
+     * - pending: Waiting for execution.
+     * - processing: Executing.
+     * - waiting_retry: Waiting for a retry.
+     * - succeeded: Execution succeeded.
+     * - failed: Execution failed.
+     * - superseded: Superseded by a subsequent version.
+     *
+     * @example
+     * succeeded
+     */
+    latestVersionStatus?: string;
+    /**
+     * @remarks
+     * The latest submitted log delivery configuration.
+     */
+    logging?: CreateCustomAgentResponseBodyDataLogging;
+    /**
+     * @remarks
+     * The name of the custom agent.
+     *
+     * @example
+     * my-custom-agent
+     */
+    name?: string;
+    /**
+     * @remarks
+     * The network access configuration of the agent. The actual access scope is also restricted by the network configuration of the workspace.
+     */
+    network?: CreateCustomAgentResponseBodyDataNetwork;
+    /**
+     * @remarks
+     * The latest submitted list of OSS directory mounts.
+     */
+    ossMounts?: CreateCustomAgentResponseBodyDataOssMounts[];
+    /**
+     * @remarks
+     * The list of invocation protocol configurations for the agent.
+     */
+    protocol?: CreateCustomAgentResponseBodyDataProtocol[];
+    /**
+     * @remarks
+     * The region ID of the workspace to which the agent belongs.
+     *
+     * @example
+     * cn-hangzhou
+     */
+    regionId?: string;
+    /**
+     * @remarks
+     * The ARN of the RAM role used by the agent to access user cloud resources.
+     *
+     * @example
+     * acs:ram::1234567890123456:role/agentcore-runtime-role
+     */
+    roleArn?: string;
+    /**
+     * @remarks
+     * The runtime configurations of the latest commit, including compute specifications, session policy, and elastic policy.
+     */
+    runtime?: CreateCustomAgentResponseBodyDataRuntime;
+    /**
+     * @remarks
+     * The instance counts grouped by runtime instance phase. Keys include PENDING (creating or initializing), RUNNING (running), HIBERNATING (hibernating), HIBERNATED (hibernated), RESUMING (resuming), TERMINATING (terminating), and FAILED (failed). Only phases that actually occur are returned. Missing keys are treated as 0.
+     */
+    sandboxPhaseCounts?: {
+        [key: string]: number;
+    };
+    /**
+     * @remarks
+     * The overall status of the agent. Valid values:
+     * - Creating: The agent is being created.
+     * - Running: The agent is running.
+     * - Failed: The agent failed.
+     * - Updating: The agent is being updated.
+     * - Deleting: The agent is being deleted.
+     * - Deleted: The agent is deleted.
+     * To query the execution progress of the latest configuration, check latestVersionStatus.
+     *
+     * @example
+     * Running
+     */
+    status?: string;
+    /**
+     * @remarks
+     * The time when the agent was last updated. The time is in ISO 8601 format. A trailing Z indicates the UTC time zone. Fractional seconds may be included.
+     *
+     * @example
+     * 2026-10-10T06:05:00Z
+     */
+    updatedAt?: string;
+    /**
+     * @remarks
+     * The ID of the workspace to which the custom agent belongs.
+     *
+     * @example
+     * ws-a1b2c3d4e5f6
+     */
+    workspaceId?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateCustomAgentResponseBody extends $dara.Model {
+    /**
+     * @remarks
+     * The request result code. The value is SUCCESS when the request is successful.
+     *
+     * @example
+     * SUCCESS
+     */
+    code?: string;
+    /**
+     * @remarks
+     * The latest submitted configuration and status of the custom agent. A successful response indicates that the request is accepted, but the configuration may not have taken effect yet.
+     */
+    data?: CreateCustomAgentResponseBodyData;
+    /**
+     * @remarks
+     * The HTTP status code of the request. A value of 200 indicates success.
+     *
+     * @example
+     * 200
+     */
+    httpStatusCode?: number;
+    /**
+     * @remarks
+     * The description of the processing result for the request. A value of success indicates that the request was processed successfully.
+     *
+     * @example
+     * success
+     */
+    message?: string;
+    /**
+     * @remarks
+     * The unique identifier of the request. You can use this ID to locate and troubleshoot issues.
+     *
+     * @example
+     * 550E8400-E29B-41D4-A716-446655440000
+     */
+    requestId?: string;
+    /**
+     * @remarks
+     * Indicates whether the request was processed successfully. A value of true indicates that the request was processed successfully. Note that a successful creation, update, or deletion does not mean that the background operation is complete.
+     */
+    success?: boolean;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}