@alicloud/agentcore20260804 2.4.0 → 2.6.0

package/dist/models/GetCustomAgentResponseBody.d.ts

@@ -18,7 +18,7 @@ export declare class GetCustomAgentResponseBodyDataAgenticFsMounts extends $dara
     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.
+     * Specifies whether the mount is read-only. A value of true indicates read-only, and false indicates read and write.
      *
      * @example
      * false
@@ -46,32 +46,32 @@ 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.
+     * The startup command for the code package. This parameter is required in code package mode. The working directory is the extracted code root directory /code, such as python main.py. Quotes and escapes are supported. Environment variables, pipes, and logical operations are not automatically expanded. For complex commands, use a script within the package.
      *
      * This parameter is required.
      *
      * @example
-     * python app.py
+     * python main.py
      */
     entrypoint?: string;
     /**
      * @remarks
-     * The language runtime identifier of the code package. Code package deployment is not supported.
+     * The identifier of the currently saved code runtime environment configuration. The runtime image uses the saved snapshot. Adding a new version to the directory does not automatically change the existing configuration.
      *
      * This parameter is required.
      *
      * @example
-     * python
+     * python3.12
      */
     languageRuntime?: string;
     /**
      * @remarks
-     * The source URI of the code package. Code package deployment is not supported.
+     * The fixed oss:// address of the platform code package referenced by the currently saved configuration. This address does not include the signature parameters of the source HTTPS link. You can use this address to reuse an existing code package. To download the content, call GetAgentCodePackageDownloadUrl.
      *
      * This parameter is required.
      *
      * @example
-     * oss://my-agent-bucket/packages/agent.zip
+     * oss://agentcore-platform-example/code-packages/workspaces/ws-a1b2c3d4e5f6/550e8400-e29b-41d4-a716-446655440000/package.zip
      */
     sourceUri?: string;
     static names(): {
@@ -136,7 +136,7 @@ export declare class GetCustomAgentResponseBodyDataArtifactContainer extends $da
     tag?: string;
     /**
      * @remarks
-     * The image source type. A value of acr indicates Alibaba Cloud Container Registry.
+     * The image source type. acr indicates Alibaba Cloud Container Registry.
      *
      * This parameter is required.
      *
@@ -158,7 +158,7 @@ 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.
+     * The code package deployment configuration. This parameter is mutually exclusive with container. The code package must be in ZIP or TAR.GZ format. Dependencies must be packaged by the user. The platform does not install dependencies or perform online builds.
      */
     code?: GetCustomAgentResponseBodyDataArtifactCode;
     /**
@@ -168,7 +168,7 @@ export declare class GetCustomAgentResponseBodyDataArtifact extends $dara.Model
     container?: GetCustomAgentResponseBodyDataArtifactContainer;
     /**
      * @remarks
-     * The TCP port listened on by the agent service.
+     * The TCP port on which the agent service listens.
      *
      * This parameter is required.
      *
@@ -187,6 +187,58 @@ export declare class GetCustomAgentResponseBodyDataArtifact extends $dara.Model
         [key: string]: any;
     });
 }
+export declare class GetCustomAgentResponseBodyDataCodePackageInfo extends $dara.Model {
+    /**
+     * @remarks
+     * The CRC64 value of the code package object.
+     *
+     * @example
+     * 456
+     */
+    crc64?: string;
+    /**
+     * @remarks
+     * The ETag of the code package object.
+     *
+     * @example
+     * fixed-etag
+     */
+    etag?: string;
+    /**
+     * @remarks
+     * The original file name of the code package.
+     *
+     * @example
+     * main.zip
+     */
+    fileName?: string;
+    /**
+     * @remarks
+     * The compressed size of the code package.
+     *
+     * @example
+     * 123
+     */
+    fileSize?: number;
+    /**
+     * @remarks
+     * The format of the code package.
+     *
+     * @example
+     * zip
+     */
+    format?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class GetCustomAgentResponseBodyDataEnvironmentVariables extends $dara.Model {
     /**
      * @remarks
@@ -247,7 +299,7 @@ export declare class GetCustomAgentResponseBodyDataHealthCheck extends $dara.Mod
     healthyThreshold?: number;
     /**
      * @remarks
-     * The interval between two consecutive health checks, in seconds.
+     * The interval between two health checks, in seconds.
      *
      * @example
      * 10
@@ -279,7 +331,7 @@ export declare class GetCustomAgentResponseBodyDataHealthCheck extends $dara.Mod
     timeoutSeconds?: number;
     /**
      * @remarks
-     * The number of consecutive health check failures required to mark the agent as unhealthy.
+     * The number of consecutive health check failures after which the instance is considered unhealthy.
      *
      * @example
      * 3
@@ -299,7 +351,9 @@ 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.
+     * The reason code for the wait or execution failure of the latest configuration. This code is used to determine the subsequent processing method.
+     *
+     * This parameter is required.
      *
      * @example
      * AgentExecutionFailed
@@ -307,7 +361,9 @@ export declare class GetCustomAgentResponseBodyDataLatestExecutionError extends
     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.
+     * The description of the reason why the latest configuration is waiting or failed to execute. Refer to the code and retryable parameters to determine what to do next.
+     *
+     * This parameter is required.
      *
      * @example
      * Agent execution failed. Check the configuration and resubmit
@@ -315,7 +371,9 @@ export declare class GetCustomAgentResponseBodyDataLatestExecutionError extends
     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.
+     * Indicates whether the system automatically retries the operation. If the value is true, you can query the status later. If the value is false, check and fix the configuration based on the error cause, and then resubmit the request.
+     *
+     * This parameter is required.
      */
     retryable?: boolean;
     static names(): {
@@ -377,7 +435,7 @@ 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.
+     * Specifies whether Internet access is allowed on the agent side. The actual access is still limited by the workspace configuration.
      */
     enabled?: boolean;
     static names(): {
@@ -394,7 +452,7 @@ 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.
+     * Specifies whether access to the user VPC configured for the workspace is allowed on the agent side. The actual access is still limited by the workspace configuration.
      */
     enabled?: boolean;
     static names(): {
@@ -411,12 +469,12 @@ 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.
+     * The Internet access configuration of the agent. If this parameter is not configured, Internet access is allowed on the agent side but is still limited by the workspace configuration.
      */
     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.
+     * The user VPC access configuration of the agent. If this parameter is not configured, user VPC access is allowed on the agent side but is still limited by the workspace configuration.
      */
     accessVpc?: GetCustomAgentResponseBodyDataNetworkAccessVpc;
     static names(): {
@@ -430,6 +488,23 @@ export declare class GetCustomAgentResponseBodyDataNetwork extends $dara.Model {
         [key: string]: any;
     });
 }
+export declare class GetCustomAgentResponseBodyDataObservability extends $dara.Model {
+    /**
+     * @remarks
+     * Specifies whether to enable agent observability.
+     */
+    enabled?: boolean;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class GetCustomAgentResponseBodyDataOssMounts extends $dara.Model {
     /**
      * @remarks
@@ -457,7 +532,7 @@ export declare class GetCustomAgentResponseBodyDataOssMounts extends $dara.Model
     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.
+     * Specifies whether the mount is read-only. A value of true indicates read-only, and false indicates read and write.
      */
     readOnly?: boolean;
     static names(): {
@@ -504,7 +579,7 @@ 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.
+     * The request header configuration for the current protocol. The key is the header name and the value is a string.
      */
     headers?: {
         [key: string]: string;
@@ -516,10 +591,7 @@ export declare class GetCustomAgentResponseBodyDataProtocol extends $dara.Model
     paths?: GetCustomAgentResponseBodyDataProtocolPaths[];
     /**
      * @remarks
-     * The invocation protocol type. Valid values:
-     * - agui: AG-UI protocol.
-     * - openai-chat-completion: OpenAI Chat Completions compatible protocol.
-     * - custom: Custom protocol.
+     * The invocation protocol type. Valid values: agui (AG-UI protocol), openai-chat-completion (OpenAI Chat Completions compatible protocol), and custom (custom protocol).
      *
      * This parameter is required.
      *
@@ -541,10 +613,7 @@ 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.
+     * The compute specification. Valid values: INTERACTIVE (1 vCPU and 2 GiB of memory), STANDARD (2 vCPUs and 4 GiB of memory), and HEAVY (4 vCPUs and 8 GiB of memory).
      *
      * This parameter is required.
      *
@@ -566,9 +635,7 @@ 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.
+     * Specifies whether to enable elastic scaling. A value of true indicates that elastic scaling is enabled. A value of false indicates that elastic scaling is disabled.
      *
      * This parameter is required.
      */
@@ -599,7 +666,7 @@ export declare class GetCustomAgentResponseBodyDataRuntimeHpa extends $dara.Mode
     minSandboxCount?: number;
     /**
      * @remarks
-     * The configured session idle timeout limit, in seconds.
+     * The configured session idle timeout limit in seconds.
      *
      * @example
      * 600
@@ -619,7 +686,7 @@ 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.
+     * The name of the HTTP request header used by the session policy. This parameter is applicable when the type is ISOLATED_HEADER_FIELD.
      *
      * @example
      * X-Session-Id
@@ -627,11 +694,7 @@ export declare class GetCustomAgentResponseBodyDataRuntimeSessionPolicy extends
     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.
+     * The session policy type. Valid values: AFFINITY (session affinity), ISOLATED_HEADER_FIELD (uses the request header specified by headerName to associate sessions), and ISOLATED_COOKIE (not recommended). The compatible value DISABLED in requests is returned as AFFINITY.
      *
      * This parameter is required.
      *
@@ -684,7 +747,9 @@ 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.
+     * The unique identifier of the custom agent, which can be obtained from the response of CreateCustomAgent or ListCustomAgents.
+     *
+     * This parameter is required.
      *
      * @example
      * agent-550e8400e29b41d4a716446655440000
@@ -697,12 +762,17 @@ export declare class GetCustomAgentResponseBodyData extends $dara.Model {
     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.
+     * 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 parameter.
      */
     artifact?: GetCustomAgentResponseBodyDataArtifact;
     /**
      * @remarks
-     * The creation method of the agent. The value is CUSTOM for custom agents.
+     * The currently saved code package information.
+     */
+    codePackageInfo?: GetCustomAgentResponseBodyDataCodePackageInfo;
+    /**
+     * @remarks
+     * The creation method of the agent. CUSTOM is returned for custom agents.
      *
      * @example
      * CUSTOM
@@ -710,7 +780,7 @@ export declare class GetCustomAgentResponseBodyData extends $dara.Model {
     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.
+     * The time when the agent was created. 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
@@ -718,7 +788,7 @@ export declare class GetCustomAgentResponseBodyData extends $dara.Model {
     createdAt?: string;
     /**
      * @remarks
-     * The deployment method of the agent. Custom agents are deployed and managed by the platform, and the value is MANAGED.
+     * The deployment method of the agent. MANAGED is returned for custom agents because they are deployed and managed by the platform.
      *
      * @example
      * MANAGED
@@ -726,12 +796,25 @@ export declare class GetCustomAgentResponseBodyData extends $dara.Model {
     deployType?: string;
     /**
      * @remarks
-     * The description of the agent.
+     * The description of the agent\\"s purpose.
      *
      * @example
      * Custom agent that provides conversation services
      */
     description?: string;
+    /**
+     * @remarks
+     * The effective configuration version.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * 1
+     *
+     * **if can be null:**
+     * true
+     */
+    effectiveSpecVersion?: number;
     /**
      * @remarks
      * The environment variable configuration for the agent process.
@@ -739,17 +822,32 @@ export declare class GetCustomAgentResponseBodyData extends $dara.Model {
     environment?: GetCustomAgentResponseBodyDataEnvironment;
     /**
      * @remarks
-     * The HTTP health check configuration of the agent. This field is empty if not configured.
+     * The HTTP health check configuration for the agent. This parameter is empty if not configured.
      */
     healthCheck?: GetCustomAgentResponseBodyDataHealthCheck;
     /**
      * @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.
+     * The ID of the currently associated image cache.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * img-example
+     *
+     * **if can be null:**
+     * true
+     */
+    imageCacheId?: string;
+    /**
+     * @remarks
+     * The wait or execution error of the latest configuration version. This parameter 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.
+     * 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.
+     *
+     * This parameter is required.
      *
      * @example
      * 1
@@ -757,16 +855,13 @@ export declare class GetCustomAgentResponseBodyData extends $dara.Model {
     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.
+     * The execution status corresponding to the latestSpecVersion. Valid values: pending (waiting for execution), processing (executing), waiting_retry (waiting for retry), succeeded (execution succeeded), failed (execution failed), and superseded (superseded by a later version).
      *
      * @example
      * succeeded
+     *
+     * **if can be null:**
+     * true
      */
     latestVersionStatus?: string;
     /**
@@ -776,7 +871,9 @@ export declare class GetCustomAgentResponseBodyData extends $dara.Model {
     logging?: GetCustomAgentResponseBodyDataLogging;
     /**
      * @remarks
-     * The name of the custom agent.
+     * The custom agent name.
+     *
+     * This parameter is required.
      *
      * @example
      * my-custom-agent
@@ -784,9 +881,14 @@ export declare class GetCustomAgentResponseBodyData extends $dara.Model {
     name?: string;
     /**
      * @remarks
-     * The network access configuration of the agent. The actual access scope is also restricted by the workspace network configuration.
+     * The network access configuration of the agent. The actual access scope is also limited by the workspace network configuration.
      */
     network?: GetCustomAgentResponseBodyDataNetwork;
+    /**
+     * @remarks
+     * The observability configuration for high-code agents.
+     */
+    observability?: GetCustomAgentResponseBodyDataObservability;
     /**
      * @remarks
      * The latest submitted list of OSS directory mounts.
@@ -820,21 +922,16 @@ export declare class GetCustomAgentResponseBodyData extends $dara.Model {
     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.
+     * The instance count statistics 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.
+     * 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 view the execution progress of the latest configuration, query latestVersionStatus.
+     *
+     * This parameter is required.
      *
      * @example
      * Running
@@ -842,16 +939,28 @@ export declare class GetCustomAgentResponseBodyData extends $dara.Model {
     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.
+     * The time when the agent was last updated. The time follows the ISO 8601 standard. A trailing Z indicates the UTC time zone. Fractional seconds are supported.
      *
      * @example
      * 2026-10-10T06:05:00Z
      */
     updatedAt?: string;
+    /**
+     * @remarks
+     * Specifies whether the image cache is enabled.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * true
+     */
+    useImageCache?: boolean;
     /**
      * @remarks
      * The ID of the workspace to which the custom agent belongs.
      *
+     * This parameter is required.
+     *
      * @example
      * ws-a1b2c3d4e5f6
      */
@@ -870,7 +979,9 @@ 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.
+     * The request result code. The value is SUCCESS if the request is successful.
+     *
+     * This parameter is required.
      *
      * @example
      * SUCCESS
@@ -878,20 +989,26 @@ export declare class GetCustomAgentResponseBody extends $dara.Model {
     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.
+     * The latest submitted configuration and status of the custom agent. To determine whether the configuration has taken effect, check the latestVersionStatus parameter.
+     *
+     * This parameter is required.
      */
     data?: GetCustomAgentResponseBodyData;
     /**
      * @remarks
      * The HTTP status code of the request. A value of 200 indicates success.
      *
+     * This parameter is required.
+     *
      * @example
      * 200
      */
     httpStatusCode?: number;
     /**
      * @remarks
-     * The result message of the request. The value is success when the request is successful.
+     * The result message of the request. The value is success if the request is successful.
+     *
+     * This parameter is required.
      *
      * @example
      * success
@@ -901,13 +1018,17 @@ export declare class GetCustomAgentResponseBody extends $dara.Model {
      * @remarks
      * The unique identifier of the request, which is used to locate and troubleshoot issues.
      *
+     * This parameter is required.
+     *
      * @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.
+     * Specifies whether the request was successful. A value of true indicates success. A successful creation, update, or deletion does not mean that the background operation is complete.
+     *
+     * This parameter is required.
      */
     success?: boolean;
     static names(): {