@alicloud/agentcore20260804 2.4.0 → 2.5.0

package/src/models/GetImageCacheResponseBody.ts

@@ -0,0 +1,341 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class GetImageCacheResponseBodyDataError extends $dara.Model {
+  /**
+   * @remarks
+   * The secure and non-empty error code for the current creation failure.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * ACSCacheBuildFailed
+   */
+  code?: string;
+  /**
+   * @remarks
+   * The secure and non-empty display message for the creation failure, excluding credentials, internal addresses, or stack traces.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * Image cache creation failed. Please try again
+   */
+  message?: string;
+  static names(): { [key: string]: string } {
+    return {
+      code: 'code',
+      message: 'message',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      code: 'string',
+      message: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class GetImageCacheResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The source ACR Enterprise instance ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * cri-example
+   */
+  acrInstanceId?: string;
+  /**
+   * @remarks
+   * The number of unique agents in the current workspace that have useImageCache set to true and are associated with this logical resource. The value is greater than or equal to 0. This uses the same collection as the imageCacheId filter in ListAllAgents. Disabled agents are not counted, regardless of the number of occupied instances.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 0
+   */
+  agentCount?: number;
+  /**
+   * @remarks
+   * The actual cache size in bytes. The known value is greater than or equal to 0. If unknown, the value is null. The compressed size of the source image cannot be used as a substitute.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 1073741824
+   * 
+   * **if can be null:**
+   * true
+   */
+  cacheSizeBytes?: number;
+  /**
+   * @remarks
+   * Indicates whether deletion is allowed. The value is true if there are no configuration references with the switch enabled, no valid instances occupying the resource, and the resource is not being deleted in the current workspace. If the reference status is unknown, the query fails instead of allowing deletion by default.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * false
+   */
+  canDelete?: boolean;
+  /**
+   * @remarks
+   * The creation time of the logical resource in the current workspace, in RFC3339 format with time zone. Content updates for the latest tag do not refresh this time.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 2026-10-10T00:00:00Z
+   */
+  createdAt?: string;
+  /**
+   * @remarks
+   * The reason why deletion is blocked. The value is null if canDelete is true. Otherwise, the value is returned based on the priority of DELETING, AGENT_ENABLED, and INSTANCES_RELEASING. Even if the agent count is 0, old instances may still occupy the resource.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * INSTANCES_RELEASING
+   * 
+   * **if can be null:**
+   * true
+   */
+  deleteBlockReason?: string;
+  /**
+   * @remarks
+   * The current content digest in the sha256: format followed by a 64-character lowercase hexadecimal string. It only describes the currently registered content and does not prove that old instances have been switched.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+   */
+  digest?: string;
+  /**
+   * @remarks
+   * The cache failure reason. This must be a non-null object when the status is FAILED, and null for other statuses. It only describes the current content and the current creation round.
+   * 
+   * This parameter is required.
+   * 
+   * **if can be null:**
+   * true
+   */
+  error?: GetImageCacheResponseBodyDataError;
+  /**
+   * @remarks
+   * The logical resource ID manageable by the current workspace, not the shared physical cache ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * img-example
+   */
+  imageId?: string;
+  /**
+   * @remarks
+   * The source image domain name, excluding the protocol, path, and credentials.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * example-registry.cn-hangzhou.cr.aliyuncs.com
+   */
+  registry?: string;
+  /**
+   * @remarks
+   * The source image repository path in the namespace/repository format, which includes the namespace.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * team/app
+   */
+  repository?: string;
+  /**
+   * @remarks
+   * The image cache status. Valid values:
+   * - PENDING: Creating.
+   * - READY: Available.
+   * - FAILED: Abnormal.
+   * - DELETING: Deleting in the current workspace.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * READY
+   */
+  status?: string;
+  /**
+   * @remarks
+   * The source image tag with case preserved. Regular tags cannot be registered with different digests, except for the exact lowercase latest tag.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * v1
+   */
+  tag?: string;
+  /**
+   * @remarks
+   * The workspace ID, which must match the requested workspace. Resources with the same content from other workspaces are not returned.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * ws-example
+   */
+  workspaceId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      acrInstanceId: 'acrInstanceId',
+      agentCount: 'agentCount',
+      cacheSizeBytes: 'cacheSizeBytes',
+      canDelete: 'canDelete',
+      createdAt: 'createdAt',
+      deleteBlockReason: 'deleteBlockReason',
+      digest: 'digest',
+      error: 'error',
+      imageId: 'imageId',
+      registry: 'registry',
+      repository: 'repository',
+      status: 'status',
+      tag: 'tag',
+      workspaceId: 'workspaceId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      acrInstanceId: 'string',
+      agentCount: 'number',
+      cacheSizeBytes: 'number',
+      canDelete: 'boolean',
+      createdAt: 'string',
+      deleteBlockReason: 'string',
+      digest: 'string',
+      error: GetImageCacheResponseBodyDataError,
+      imageId: 'string',
+      registry: 'string',
+      repository: 'string',
+      status: 'string',
+      tag: 'string',
+      workspaceId: 'string',
+    };
+  }
+
+  validate() {
+    if(this.error && typeof (this.error as any).validate === 'function') {
+      (this.error as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class GetImageCacheResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The business response code.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * SUCCESS
+   */
+  code?: string;
+  /**
+   * @remarks
+   * The query result of the image cache details.
+   * 
+   * This parameter is required.
+   */
+  data?: GetImageCacheResponseBodyData;
+  /**
+   * @remarks
+   * The HTTP status code.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 200
+   */
+  httpStatusCode?: number;
+  /**
+   * @remarks
+   * The response message.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * success
+   */
+  message?: string;
+  /**
+   * @remarks
+   * The request ID, which is used for troubleshooting.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * req-example
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * Indicates whether the request is successful. This does not indicate that the cache creation is complete.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * true
+   */
+  success?: boolean;
+  static names(): { [key: string]: string } {
+    return {
+      code: 'code',
+      data: 'data',
+      httpStatusCode: 'httpStatusCode',
+      message: 'message',
+      requestId: 'requestId',
+      success: 'success',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      code: 'string',
+      data: GetImageCacheResponseBodyData,
+      httpStatusCode: 'number',
+      message: 'string',
+      requestId: 'string',
+      success: 'boolean',
+    };
+  }
+
+  validate() {
+    if(this.data && typeof (this.data as any).validate === 'function') {
+      (this.data as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/GetWorkspaceAcrRamAuthorizeUrlRequest.ts

@@ -15,7 +15,7 @@ export class GetWorkspaceAcrRamAuthorizeUrlRequest extends $dara.Model {
   acrInstanceId?: string;
   /**
    * @remarks
-   * The target ACR namespace, which corresponds to artifact.container.namespace of the agent. This is not a Kubernetes namespace. It determines the authorization scope together with the instance and repository.
+   * The target ACR namespace, which corresponds to artifact.container.namespace of the agent. This is not a Kubernetes namespace. This parameter, together with the instance and repository, determines the authorization scope.
    * 
    * This parameter is required.
    * 
@@ -25,7 +25,7 @@ export class GetWorkspaceAcrRamAuthorizeUrlRequest extends $dara.Model {
   namespace?: string;
   /**
    * @remarks
-   * The target repository name, which corresponds to artifact.container.repo of the agent. It does not include tags, namespaces, or path separators. Wildcards are not supported.
+   * The name of the target repository, which corresponds to artifact.container.repo of the agent. The name cannot contain tags, namespaces, or path separators. Wildcards are not supported.
    * 
    * This parameter is required.
    * 

package/src/models/GetWorkspaceAcrRamAuthorizeUrlResponseBody.ts

@@ -7,6 +7,8 @@ export class GetWorkspaceAcrRamAuthorizeUrlResponseBodyData extends $dara.Model
    * @remarks
    * The ID of the ACR Enterprise instance.
    * 
+   * This parameter is required.
+   * 
    * @example
    * cri-1234567890abcdef
    */
@@ -15,13 +17,17 @@ export class GetWorkspaceAcrRamAuthorizeUrlResponseBodyData extends $dara.Model
    * @remarks
    * The RAM authorization URL used to create or append target ACR permissions for the shared role.
    * 
+   * This parameter is required.
+   * 
    * @example
    * https://ram.console.aliyun.com/authorize?request=%7B%22referrer%22%3A%22AgentCore%22%2C%22payloads%22%3A%5B%7B%22missionId%22%3A%22AgentCore.CustomRoleForOSSObjectRestore%22%2C%22roleName%22%3A%22AliyunAgentCoreWorkspace-ws-1234567890abcdef12345%22%2C%22rolePolicies%22%3A%5B%7B%22policyName%22%3A%22AgentCoreAcrPull-63373f3802583663d49465d8061e410a899d8f2936b8fc0cb9ec905b71f273c6%22%2C%22policyType%22%3A%22Custom%22%2C%22templateId%22%3A%22CrPullInstanceImage%22%2C%22templateValue%22%3A%7B%22crInstance%22%3A%22acs%3Acr%3Acn-hangzhou%3A1234567890123456%3Ainstance%2Fcri-1234567890abcdef%22%2C%22crRepository%22%3A%22acs%3Acr%3Acn-hangzhou%3A1234567890123456%3Arepository%2Fcri-1234567890abcdef%2Fexample%2Fagent-image%22%7D%7D%5D%7D%5D%7D
    */
   authorizeUrl?: string;
   /**
    * @remarks
-   * The shared role name selected by the backend. This field is not editable on the frontend.
+   * The name of the shared role selected by the backend. This field is not editable on the frontend.
+   * 
+   * This parameter is required.
    * 
    * @example
    * AliyunAgentCoreWorkspace-ws-1234567890abcdef12345
@@ -31,6 +37,8 @@ export class GetWorkspaceAcrRamAuthorizeUrlResponseBodyData extends $dara.Model
    * @remarks
    * The source of the shared role. This does not indicate that authorization is complete.
    * 
+   * This parameter is required.
+   * 
    * @example
    * WORKSPACE_SHARED
    */
@@ -39,6 +47,8 @@ export class GetWorkspaceAcrRamAuthorizeUrlResponseBodyData extends $dara.Model
    * @remarks
    * The workspace ID.
    * 
+   * This parameter is required.
+   * 
    * @example
    * ws-1234567890abcdef12345
    */
@@ -77,6 +87,8 @@ export class GetWorkspaceAcrRamAuthorizeUrlResponseBody extends $dara.Model {
    * @remarks
    * The business status code.
    * 
+   * This parameter is required.
+   * 
    * @example
    * SUCCESS
    */
@@ -84,12 +96,16 @@ export class GetWorkspaceAcrRamAuthorizeUrlResponseBody extends $dara.Model {
   /**
    * @remarks
    * The response data.
+   * 
+   * This parameter is required.
    */
   data?: GetWorkspaceAcrRamAuthorizeUrlResponseBodyData;
   /**
    * @remarks
    * The HTTP status code.
    * 
+   * This parameter is required.
+   * 
    * @example
    * 200
    */
@@ -98,6 +114,8 @@ export class GetWorkspaceAcrRamAuthorizeUrlResponseBody extends $dara.Model {
    * @remarks
    * The response message.
    * 
+   * This parameter is required.
+   * 
    * @example
    * success
    */
@@ -106,6 +124,8 @@ export class GetWorkspaceAcrRamAuthorizeUrlResponseBody extends $dara.Model {
    * @remarks
    * The request ID.
    * 
+   * This parameter is required.
+   * 
    * @example
    * 12345678-1234-1234-1234-123456789012
    */
@@ -114,6 +134,8 @@ export class GetWorkspaceAcrRamAuthorizeUrlResponseBody extends $dara.Model {
    * @remarks
    * Indicates whether the request is successful.
    * 
+   * This parameter is required.
+   * 
    * @example
    * true
    */

package/src/models/ListImageCachesRequest.ts

@@ -0,0 +1,148 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class ListImageCachesRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the source ACR Enterprise instance. The match must be exact. Empty character strings are invalid.
+   * 
+   * @example
+   * cri-example
+   */
+  acrInstanceId?: string;
+  /**
+   * @remarks
+   * The complete image digest in the sha256: format followed by a 64-character lowercase hexadecimal string. The format is verified by the console. The match must be exact, and prefixes are not supported.
+   * 
+   * @example
+   * sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+   */
+  digest?: string;
+  /**
+   * @remarks
+   * Performs a case-insensitive literal substring search on the complete source image reference in the registry/repository:tag format, where the repository already includes the namespace. If the value is empty after trimming leading and trailing whitespace, it is treated as not provided. Percent signs, underscores, and backslashes are treated as literal characters.
+   * 
+   * @example
+   * team/app
+   */
+  imageRefContains?: string;
+  /**
+   * @remarks
+   * The maximum number of results to return. If this parameter is not provided or is set to 0, the default value is 20. If the value exceeds 100, it is treated as 100. Negative values return an InvalidMaxResults error. The value can be adjusted for subsequent pages.
+   * 
+   * @example
+   * 20
+   */
+  maxResults?: number;
+  /**
+   * @remarks
+   * The source namespace. The match is case-sensitive and must be exact. Empty strings are invalid.
+   * 
+   * @example
+   * team
+   */
+  namespace?: string;
+  /**
+   * @remarks
+   * Omit this parameter for the first request. For subsequent requests, pass the nextToken value from the previous response exactly as returned. If the filter conditions change, you must query the first page again.
+   * 
+   * @example
+   * opaque-token
+   */
+  nextToken?: string;
+  /**
+   * @remarks
+   * The product entry region, which is determined by the selected region endpoint.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * cn-hangzhou
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * The domain name of the source repository. The match is case-insensitive and must be exact. Do not include the protocol, path, or tag. Public network and VPC domain names are not considered equal. Empty strings are invalid.
+   * 
+   * @example
+   * example-registry.cn-hangzhou.cr.aliyuncs.com
+   */
+  registry?: string;
+  /**
+   * @remarks
+   * The name of the repository under the namespace. The match is case-sensitive and must be exact. Do not include the namespace. If this parameter is provided, the namespace parameter must also be provided. Empty strings are invalid.
+   * 
+   * @example
+   * app
+   */
+  repository?: string;
+  /**
+   * @remarks
+   * Filters the results by a single cache status. Omit this parameter to query all statuses.
+   * 
+   * @example
+   * READY
+   */
+  status?: string;
+  /**
+   * @remarks
+   * The tag of the source image. The match is case-sensitive and must be exact. The latest tag is not inferred. Empty strings are invalid.
+   * 
+   * @example
+   * v1
+   */
+  tag?: string;
+  /**
+   * @remarks
+   * The current routed workspace. The server verifies the account, region, and resource ownership. This parameter cannot be omitted or used to access other workspaces.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * ws-example
+   */
+  workspaceId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      acrInstanceId: 'acrInstanceId',
+      digest: 'digest',
+      imageRefContains: 'imageRefContains',
+      maxResults: 'maxResults',
+      namespace: 'namespace',
+      nextToken: 'nextToken',
+      regionId: 'regionId',
+      registry: 'registry',
+      repository: 'repository',
+      status: 'status',
+      tag: 'tag',
+      workspaceId: 'workspaceId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      acrInstanceId: 'string',
+      digest: 'string',
+      imageRefContains: 'string',
+      maxResults: 'number',
+      namespace: 'string',
+      nextToken: 'string',
+      regionId: 'string',
+      registry: 'string',
+      repository: 'string',
+      status: 'string',
+      tag: 'string',
+      workspaceId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/ListImageCachesResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { ListImageCachesResponseBody } from "./ListImageCachesResponseBody";
+
+
+export class ListImageCachesResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: ListImageCachesResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: ListImageCachesResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+