@alicloud/agentcore20260804 2.3.2 → 2.4.0

package/dist/models/GetCustomAgentResponseBody.d.ts

@@ -1,21 +1,33 @@
 import * as $dara from '@darabonba/typescript';
 export declare class GetCustomAgentResponseBodyDataAgenticFsMounts 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 a read-only mount, and a value of false indicates a read-write mount.
+     *
      * @example
      * false
      */
     readOnly?: boolean;
     /**
+     * @remarks
+     * The AgenticFS access point domain name used for the mount.
+     *
      * @example
      * ap-0123456789abcdef0.0123456789-vlm36.cn-hangzhou.nas.aliyuncs.com
      */
@@ -34,6 +46,8 @@ export declare class GetCustomAgentResponseBodyDataAgenticFsMounts extends $dara
 export declare class GetCustomAgentResponseBodyDataArtifactCode extends $dara.Model {
     /**
      * @remarks
+     * The startup entry point of the code package. Code package deployment is not supported.
+     *
      * This parameter is required.
      *
      * @example
@@ -42,6 +56,8 @@ export declare class GetCustomAgentResponseBodyDataArtifactCode extends $dara.Mo
     entrypoint?: string;
     /**
      * @remarks
+     * The language runtime identifier of the code package. Code package deployment is not supported.
+     *
      * This parameter is required.
      *
      * @example
@@ -50,6 +66,8 @@ export declare class GetCustomAgentResponseBodyDataArtifactCode extends $dara.Mo
     languageRuntime?: string;
     /**
      * @remarks
+     * The source URI of the code package. Code package deployment is not supported.
+     *
      * This parameter is required.
      *
      * @example
@@ -69,12 +87,17 @@ export declare class GetCustomAgentResponseBodyDataArtifactCode extends $dara.Mo
 }
 export declare class GetCustomAgentResponseBodyDataArtifactContainer 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
@@ -83,6 +106,8 @@ export declare class GetCustomAgentResponseBodyDataArtifactContainer extends $da
     instanceId?: string;
     /**
      * @remarks
+     * The namespace to which the ACR image repository belongs.
+     *
      * This parameter is required.
      *
      * @example
@@ -91,6 +116,8 @@ export declare class GetCustomAgentResponseBodyDataArtifactContainer extends $da
     namespace?: string;
     /**
      * @remarks
+     * The name of the image repository in the ACR namespace.
+     *
      * This parameter is required.
      *
      * @example
@@ -99,6 +126,8 @@ export declare class GetCustomAgentResponseBodyDataArtifactContainer extends $da
     repo?: string;
     /**
      * @remarks
+     * The latest submitted image tag.
+     *
      * This parameter is required.
      *
      * @example
@@ -107,6 +136,8 @@ export declare class GetCustomAgentResponseBodyDataArtifactContainer extends $da
     tag?: string;
     /**
      * @remarks
+     * The image source type. A value of acr indicates Alibaba Cloud Container Registry.
+     *
      * This parameter is required.
      *
      * @example
@@ -125,10 +156,20 @@ export declare class GetCustomAgentResponseBodyDataArtifactContainer extends $da
     });
 }
 export declare class GetCustomAgentResponseBodyDataArtifact extends $dara.Model {
+    /**
+     * @remarks
+     * The code package configuration field. Code package deployment is not supported.
+     */
     code?: GetCustomAgentResponseBodyDataArtifactCode;
+    /**
+     * @remarks
+     * The latest submitted ACR container image configuration.
+     */
     container?: GetCustomAgentResponseBodyDataArtifactContainer;
     /**
      * @remarks
+     * The TCP port listened on by the agent service.
+     *
      * This parameter is required.
      *
      * @example
@@ -149,6 +190,8 @@ export declare class GetCustomAgentResponseBodyDataArtifact extends $dara.Model
 export declare class GetCustomAgentResponseBodyDataEnvironmentVariables extends $dara.Model {
     /**
      * @remarks
+     * The name of the environment variable.
+     *
      * This parameter is required.
      *
      * @example
@@ -157,6 +200,8 @@ export declare class GetCustomAgentResponseBodyDataEnvironmentVariables extends
     name?: string;
     /**
      * @remarks
+     * The string value of the environment variable. Empty strings are allowed.
+     *
      * This parameter is required.
      *
      * @example
@@ -175,6 +220,10 @@ export declare class GetCustomAgentResponseBodyDataEnvironmentVariables extends
     });
 }
 export declare class GetCustomAgentResponseBodyDataEnvironment extends $dara.Model {
+    /**
+     * @remarks
+     * The latest submitted list of environment variables.
+     */
     variables?: GetCustomAgentResponseBodyDataEnvironmentVariables[];
     static names(): {
         [key: string]: string;
@@ -189,31 +238,49 @@ export declare class GetCustomAgentResponseBodyDataEnvironment extends $dara.Mod
 }
 export declare class GetCustomAgentResponseBodyDataHealthCheck 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
      */
@@ -231,15 +298,25 @@ export declare class GetCustomAgentResponseBodyDataHealthCheck extends $dara.Mod
 }
 export declare class GetCustomAgentResponseBodyDataLatestExecutionError extends $dara.Model {
     /**
+     * @remarks
+     * The cause 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 reason why the latest configuration is pending or failed to execute. Determine what to do next based on the code and retryable fields.
+     *
      * @example
-     * Agent 执行失败，请检查配置后重新提交。
+     * Agent execution failed. Check the configuration and resubmit
      */
     message?: string;
+    /**
+     * @remarks
+     * Specifies whether automatic retries are performed. If the value is true, you can query again later. If the value is false, check and fix the configuration based on the cause, and then resubmit.
+     */
     retryable?: boolean;
     static names(): {
         [key: string]: string;
@@ -254,11 +331,17 @@ export declare class GetCustomAgentResponseBodyDataLatestExecutionError extends
 }
 export declare class GetCustomAgentResponseBodyDataLoggingSls extends $dara.Model {
     /**
+     * @remarks
+     * The name of the SLS Logstore that receives agent logs.
+     *
      * @example
      * agent-runtime
      */
     logstore?: string;
     /**
+     * @remarks
+     * The name of the SLS project that receives agent logs.
+     *
      * @example
      * my-agent-logs
      */
@@ -275,6 +358,10 @@ export declare class GetCustomAgentResponseBodyDataLoggingSls extends $dara.Mode
     });
 }
 export declare class GetCustomAgentResponseBodyDataLogging extends $dara.Model {
+    /**
+     * @remarks
+     * The Simple Log Service (SLS) log delivery destination.
+     */
     sls?: GetCustomAgentResponseBodyDataLoggingSls;
     static names(): {
         [key: string]: string;
@@ -288,6 +375,10 @@ export declare class GetCustomAgentResponseBodyDataLogging extends $dara.Model {
     });
 }
 export declare class GetCustomAgentResponseBodyDataNetworkAccessInternet 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;
@@ -301,6 +392,10 @@ export declare class GetCustomAgentResponseBodyDataNetworkAccessInternet extends
     });
 }
 export declare class GetCustomAgentResponseBodyDataNetworkAccessVpc 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;
@@ -314,7 +409,15 @@ export declare class GetCustomAgentResponseBodyDataNetworkAccessVpc extends $dar
     });
 }
 export declare class GetCustomAgentResponseBodyDataNetwork 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 is still restricted by the workspace.
+     */
     accessInternet?: GetCustomAgentResponseBodyDataNetworkAccessInternet;
+    /**
+     * @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 is still restricted by the workspace.
+     */
     accessVpc?: GetCustomAgentResponseBodyDataNetworkAccessVpc;
     static names(): {
         [key: string]: string;
@@ -329,20 +432,33 @@ export declare class GetCustomAgentResponseBodyDataNetwork extends $dara.Model {
 }
 export declare class GetCustomAgentResponseBodyDataOssMounts 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 object directory prefix in the mounted bucket.
+     *
      * @example
      * datasets/train
      */
     path?: string;
+    /**
+     * @remarks
+     * Specifies whether the mount is read-only. A value of true indicates a read-only mount, and a value of false indicates a read-write mount.
+     */
     readOnly?: boolean;
     static names(): {
         [key: string]: string;
@@ -357,12 +473,17 @@ export declare class GetCustomAgentResponseBodyDataOssMounts extends $dara.Model
 }
 export declare class GetCustomAgentResponseBodyDataProtocolPaths extends $dara.Model {
     /**
+     * @remarks
+     * The usage description of the current API path.
+     *
      * @example
-     * AG-UI 对话接口
+     * AG-UI conversation API
      */
     description?: string;
     /**
      * @remarks
+     * The API path corresponding to the current protocol.
+     *
      * This parameter is required.
      *
      * @example
@@ -381,12 +502,25 @@ export declare class GetCustomAgentResponseBodyDataProtocolPaths extends $dara.M
     });
 }
 export declare class GetCustomAgentResponseBodyDataProtocol extends $dara.Model {
+    /**
+     * @remarks
+     * The request header configurations for the current protocol, where the key is the name and the value is a string.
+     */
     headers?: {
         [key: string]: string;
     };
+    /**
+     * @remarks
+     * The list of API paths corresponding to the current protocol.
+     */
     paths?: GetCustomAgentResponseBodyDataProtocolPaths[];
     /**
      * @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
@@ -407,6 +541,11 @@ export declare class GetCustomAgentResponseBodyDataProtocol extends $dara.Model
 export declare class GetCustomAgentResponseBodyDataRuntimeCompute 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
@@ -427,12 +566,16 @@ export declare class GetCustomAgentResponseBodyDataRuntimeCompute extends $dara.
 export declare class GetCustomAgentResponseBodyDataRuntimeHpa extends $dara.Model {
     /**
      * @remarks
+     * Specifies whether to enable elastic scaling. Valid values:
+     * - true: Enabled.
+     * - false: Disabled.
+     *
      * This parameter is required.
      */
     enabled?: boolean;
     /**
      * @remarks
-     * 正整数，必须与 sessionTtlSeconds 同时配置。
+     * The configured maximum number of concurrent sessions per runtime instance.
      *
      * @example
      * 100
@@ -440,7 +583,7 @@ export declare class GetCustomAgentResponseBodyDataRuntimeHpa extends $dara.Mode
     maxConcurrentSessionsPerSandbox?: number;
     /**
      * @remarks
-     * 开启时为正整数，关闭时为非负整数；不得小于 minSandboxCount。
+     * The configured maximum number of runtime instances.
      *
      * @example
      * 10
@@ -448,7 +591,7 @@ export declare class GetCustomAgentResponseBodyDataRuntimeHpa extends $dara.Mode
     maxSandboxCount?: number;
     /**
      * @remarks
-     * 非负整数。开启弹性时必填；关闭时如提供上下限，必须成对提供。
+     * The configured minimum number of runtime instances.
      *
      * @example
      * 1
@@ -456,7 +599,7 @@ export declare class GetCustomAgentResponseBodyDataRuntimeHpa extends $dara.Mode
     minSandboxCount?: number;
     /**
      * @remarks
-     * 正整数，必须与 maxConcurrentSessionsPerSandbox 同时配置。
+     * The configured session idle timeout limit, in seconds.
      *
      * @example
      * 600
@@ -475,12 +618,21 @@ export declare class GetCustomAgentResponseBodyDataRuntimeHpa extends $dara.Mode
 }
 export declare class GetCustomAgentResponseBodyDataRuntimeSessionPolicy extends $dara.Model {
     /**
+     * @remarks
+     * The name of the HTTP request header used by the session policy, applicable to ISOLATED_HEADER_FIELD.
+     *
      * @example
      * X-Session-Id
      */
     headerName?: string;
     /**
      * @remarks
+     * The session policy type. Valid values:
+     * - AFFINITY: Session affinity.
+     * - ISOLATED_HEADER_FIELD: Uses the request header specified by headerName to associate sessions.
+     * - ISOLATED_COOKIE: Cookie-based session isolation. Not recommended.
+     * Note: The compatible value DISABLED in a request is returned as AFFINITY.
+     *
      * This parameter is required.
      *
      * @example
@@ -501,16 +653,20 @@ export declare class GetCustomAgentResponseBodyDataRuntimeSessionPolicy extends
 export declare class GetCustomAgentResponseBodyDataRuntime extends $dara.Model {
     /**
      * @remarks
+     * The compute resource configuration for the agent runtime instance.
+     *
      * This parameter is required.
      */
     compute?: GetCustomAgentResponseBodyDataRuntimeCompute;
     /**
      * @remarks
-     * Agent 当前 spec 版本的 HPA 配置，与 Managed Agent 一致。开启时必须提供最小和最大 Sandbox 数；并发会话上限与会话空闲超时必须一起配置。
+     * The elastic policy configuration for the agent.
      */
     hpa?: GetCustomAgentResponseBodyDataRuntimeHpa;
     /**
      * @remarks
+     * The session policy configuration for the agent.
+     *
      * This parameter is required.
      */
     sessionPolicy?: GetCustomAgentResponseBodyDataRuntimeSessionPolicy;
@@ -527,83 +683,175 @@ export declare class GetCustomAgentResponseBodyDataRuntime extends $dara.Model {
 }
 export declare class GetCustomAgentResponseBodyData extends $dara.Model {
     /**
+     * @remarks
+     * The unique identifier of the custom agent. You can obtain this value from the response of CreateCustomAgent or ListCustomAgents.
+     *
      * @example
      * agent-550e8400e29b41d4a716446655440000
      */
     agentId?: string;
+    /**
+     * @remarks
+     * The latest submitted list of additional AgenticFS mounts.
+     */
     agenticFsMounts?: GetCustomAgentResponseBodyDataAgenticFsMounts[];
+    /**
+     * @remarks
+     * The latest submitted deployment artifact configuration, including the service listening port and ACR container image. To determine whether the configuration has taken effect, check the latestVersionStatus field.
+     */
     artifact?: GetCustomAgentResponseBodyDataArtifact;
     /**
+     * @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, and the value is MANAGED.
+     *
      * @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?: GetCustomAgentResponseBodyDataEnvironment;
+    /**
+     * @remarks
+     * The HTTP health check configuration of the agent. This field is empty if not configured.
+     */
     healthCheck?: GetCustomAgentResponseBodyDataHealthCheck;
     /**
      * @remarks
-     * 可选。仅解释同一响应 latestSpecVersion/latestVersionStatus 的等待或失败；正常待处理、执行中或成功时省略。消息由 Console 白名单映射，不返回原始运行时诊断、Checkpoint 或凭证。
+     * 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?: GetCustomAgentResponseBodyDataLatestExecutionError;
     /**
+     * @remarks
+     * The current 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: Executed successfully.
+     * - failed: Execution failed.
+     * - superseded: Superseded by a subsequent version.
+     *
      * @example
      * succeeded
      */
     latestVersionStatus?: string;
+    /**
+     * @remarks
+     * The latest submitted log delivery configuration.
+     */
     logging?: GetCustomAgentResponseBodyDataLogging;
     /**
+     * @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 workspace network configuration.
+     */
     network?: GetCustomAgentResponseBodyDataNetwork;
+    /**
+     * @remarks
+     * The latest submitted list of OSS directory mounts.
+     */
     ossMounts?: GetCustomAgentResponseBodyDataOssMounts[];
+    /**
+     * @remarks
+     * The list of invocation protocol configurations for the agent.
+     */
     protocol?: GetCustomAgentResponseBodyDataProtocol[];
     /**
+     * @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 latest committed runtime configuration, including compute specifications, session policy, and elastic policy.
+     */
     runtime?: GetCustomAgentResponseBodyDataRuntime;
+    /**
+     * @remarks
+     * The counts 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 check the execution progress of the latest configuration, query 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
      */
@@ -621,26 +869,46 @@ export declare class GetCustomAgentResponseBodyData extends $dara.Model {
 }
 export declare class GetCustomAgentResponseBody 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. To determine whether the configuration has taken effect, check the latestVersionStatus field.
+     */
     data?: GetCustomAgentResponseBodyData;
     /**
+     * @remarks
+     * The HTTP status code of the request. A value of 200 indicates success.
+     *
      * @example
      * 200
      */
     httpStatusCode?: number;
     /**
+     * @remarks
+     * The result message of the request. The value is success when the request is successful.
+     *
      * @example
      * success
      */
     message?: string;
     /**
+     * @remarks
+     * The unique identifier of the request, which is used 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 success. Note that a successful creation, update, or deletion response does not mean that the background operation is complete.
+     */
     success?: boolean;
     static names(): {
         [key: string]: string;