diff --git a/backend/apps/generation/views.py b/backend/apps/generation/views.py index 5f184e7..034d742 100644 --- a/backend/apps/generation/views.py +++ b/backend/apps/generation/views.py @@ -3204,15 +3204,20 @@ def asset_group_detail_view(request, group_id): return Response({'error': '素材组不存在'}, status=status.HTTP_404_NOT_FOUND) if request.method == 'DELETE': - # Delete all remote assets in this group from utils import assets_client - for asset in Asset.objects.filter(group=group): - if asset.remote_asset_id: - try: - assets_client.delete_asset(asset.remote_asset_id) - except Exception as e: - logger.warning('Failed to delete remote asset %s: %s', asset.remote_asset_id, e) - # Delete local records + from utils.assets_client import AssetsAPIError + if group.remote_group_id: + try: + assets_client.delete_asset_group(group.remote_group_id) + except AssetsAPIError as e: + # 火山那边已经没了(比如被后台手动删了)就继续清本地,保证幂等 + if e.code != 'NotFound.group_id': + logger.warning('Failed to delete remote group %s: %s', group.remote_group_id, e) + return Response( + {'error': 'assets_api_error', 'message': e.user_message}, + status=status.HTTP_502_BAD_GATEWAY, + ) + logger.info('Remote group %s already gone, cleaning local only', group.remote_group_id) Asset.objects.filter(group=group).delete() group.delete() return Response({'message': '素材组已删除'}) diff --git a/backend/utils/assets_client.py b/backend/utils/assets_client.py index d34d589..e7475b7 100644 --- a/backend/utils/assets_client.py +++ b/backend/utils/assets_client.py @@ -83,6 +83,7 @@ def _get_service(): 'UpdateAssetGroup': ApiInfo('POST', '/', {'Action': 'UpdateAssetGroup', 'Version': API_VERSION}, {}, {}), 'UpdateAsset': ApiInfo('POST', '/', {'Action': 'UpdateAsset', 'Version': API_VERSION}, {}, {}), 'DeleteAsset': ApiInfo('POST', '/', {'Action': 'DeleteAsset', 'Version': API_VERSION}, {}, {}), + 'DeleteAssetGroup': ApiInfo('POST', '/', {'Action': 'DeleteAssetGroup', 'Version': API_VERSION}, {}, {}), } return Service(service_info, api_info) @@ -225,3 +226,9 @@ def delete_asset(asset_id: str): """Delete a single asset from the remote API.""" body = {'Id': asset_id, 'ProjectName': PROJECT_NAME} _do_request('DeleteAsset', body) + + +def delete_asset_group(group_id: str): + """Delete an asset group and cascade-delete all its assets on the remote API.""" + body = {'Id': group_id, 'ProjectName': PROJECT_NAME} + _do_request('DeleteAssetGroup', body) diff --git a/docs/API文档/about-Asset-素材组相关/删除素材资产组 (DeleteAssetGroup) b/docs/API文档/about-Asset-素材组相关/删除素材资产组 (DeleteAssetGroup) new file mode 100644 index 0000000..36a7a14 --- /dev/null +++ b/docs/API文档/about-Asset-素材组相关/删除素材资产组 (DeleteAssetGroup) @@ -0,0 +1,81 @@ +`POST https://ark.cn-beijing.volcengineapi.com/?Action=DeleteAssetGroup&Version=2024-01-01` +删除素材资产组(Asset Group)。 +:::warning + +* 删除素材组将批量删除组内所有素材资产,该操作不可逆,一经删除,不可恢复,请谨慎操作。 +* 如待删除的素材组包含较多素材资产,删除操作可能耗费一定时间。 +* 对于在方舟控制台创建的真人素材组,**仅可删除授权已过期或已拒绝接收的素材组;** 授权有效期内、有效期未开始或已接收的素材无法删除。 + + +::: +```mixin-react +return ( +![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_57d0bca8e0d122ab1191b40101b5df75.png =20x) [调用教程](https://www.volcengine.com/docs/82379/2333565) ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_f45b5cd5863d1eed3bc3c81b9af54407.png =20x) [接口列表](https://www.volcengine.com/docs/82379/2333601) ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_bef4bc3de3535ee19d0c5d6c37b0ffdd.png =20x) [开通模型](https://console.volcengine.com/ark/region:ark+cn-beijing/openManagement?LLM=%7B%7D&OpenTokenDrawer=false) +`}> +); +``` + + +--- + + + +## 请求参数 + +### 请求体 + +--- + + +**Id** `string` %%require%% +需删除的素材资产组 ID。 + +--- + + +**ProjectName** `string` +需删除素材资产组所属的项目名称,默认值为 default。 +若资源不在默认项目中,需填写正确的项目名称,获取项目名称,请查看 [文档](https://www.volcengine.com/docs/82379/1359411?lang=zh#03ec4a65)。 + +## 响应参数 +:::tip +本接口无业务返回参数。 + +::: +--- + + + +## 请求示例 +```text +POST /?Action=DeleteAssetGroup&Version=2024-01-01 HTTP/1.1 +Host: ark.cn-beijing.volcengineapi.com +Content-Type: application/json +X-Date: 20260328T000000Z +X-Content-Sha256: 287e874e******d653b44d21e +Authorization: HMAC-SHA256 Credential=AKLTYz******/20260328/cn-beijing/ark/request, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature=47a7d934******e41085f + +{ + "Id": "group-2026**********-*****", + "ProjectName": "default" +} +``` + + +## 响应示例 +```json +{ + "ResponseMetadata": { + "RequestId": "20260328000000000000000000000000", + "Action": "DeleteAssetGroup", + "Version": "2024-01-01", + "Service": "ark", + "Region": "cn-beijing" + }, + "Result": {} +} +``` + + + diff --git a/docs/API文档/about-Asset-素材组相关/删除素材资产(DeleteAsset) b/docs/API文档/about-Asset-素材组相关/删除素材资产(DeleteAsset) new file mode 100644 index 0000000..225cc97 --- /dev/null +++ b/docs/API文档/about-Asset-素材组相关/删除素材资产(DeleteAsset) @@ -0,0 +1,74 @@ +`POST https://ark.cn-beijing.volcengineapi.com/?Action=DeleteAsset&Version=2024-01-01` +本文介绍删除素材资产(Asset)API 的输入输出参数,供您使用接口时查阅字段含义。 + +```mixin-react +return ( +![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_57d0bca8e0d122ab1191b40101b5df75.png =20x) [调用教程](https://www.volcengine.com/docs/82379/2333565) ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_f45b5cd5863d1eed3bc3c81b9af54407.png =20x) [接口列表](https://www.volcengine.com/docs/82379/2333601) ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_bef4bc3de3535ee19d0c5d6c37b0ffdd.png =20x) [开通模型](https://console.volcengine.com/ark/region:ark+cn-beijing/openManagement?LLM=%7B%7D&OpenTokenDrawer=false) +`}> +); +``` + + +--- + + + +## 请求参数 + +### 请求体 + +--- + + +**Id** `string` %%require%% +需要删除的 Asset(素材资产)的 Id。 + +--- + + +**ProjectName** `string` +需要删除的 Asset(素材资产)所属的项目名称,默认值为default。 +若资源不在默认项目中,需填写正确的项目名称,获取项目名称,请查看 [文档](https://www.volcengine.com/docs/82379/1359411?lang=zh#03ec4a65)。 + +## 响应参数 +:::tip +本接口无业务返回参数。 + +::: +--- + + + +## 请求示例 +```text +POST /?Action=DeleteAsset&Version=2024-01-01 HTTP/1.1 +Host: ark.cn-beijing.volcengineapi.com +Content-Type: application/json +X-Date: 20260328T000000Z +X-Content-Sha256: 287e874e******d653b44d21e +Authorization: HMAC-SHA256 Credential=AKLTYz******/20260328/cn-beijing/ark/request, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature=47a7d934******e41085f + +{ + "Id": "Asset-2026**********-*****", + "ProjectName": "default" +} +``` + + +## 响应示例 +```json +{ + "ResponseMetadata": { + "RequestId": "20260328000000000000000000000000", + "Action": "DeleteAsset", + "Version": "2024-01-01", + "Service": "ark", + "Region": "cn-beijing" + }, + "Result": {} +} +``` + + + diff --git a/docs/API文档/about-Asset-素材组相关/更新素材资产信息(UpdateAsset) b/docs/API文档/about-Asset-素材组相关/更新素材资产信息(UpdateAsset) new file mode 100644 index 0000000..c6b91d9 --- /dev/null +++ b/docs/API文档/about-Asset-素材组相关/更新素材资产信息(UpdateAsset) @@ -0,0 +1,86 @@ +`POST https://ark.cn-beijing.volcengineapi.com/?Action=UpdateAsset&Version=2024-01-01` +本文介绍更新素材资产信息(Asset)API 的输入输出参数,供您使用接口时查阅字段含义。当前仅支持更新 `Name`。 + +```mixin-react +return ( +![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_57d0bca8e0d122ab1191b40101b5df75.png =20x) [调用教程](https://www.volcengine.com/docs/82379/2333565) ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_f45b5cd5863d1eed3bc3c81b9af54407.png =20x) [接口列表](https://www.volcengine.com/docs/82379/2318269) ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_bef4bc3de3535ee19d0c5d6c37b0ffdd.png =20x) [开通模型](https://console.volcengine.com/ark/region:ark+cn-beijing/openManagement?LLM=%7B%7D&OpenTokenDrawer=false) +`}> +); +``` + + +--- + + + +## 请求参数 + +### 请求体 + +--- + + +**Id** `string` %%require%% +需要更新的 Asset(素材资产)的 Id。 + +--- + + +**Name** `string` +需要更新的 Asset(素材资产)的新名称,上限为 64 个字符。 + +--- + + +**ProjectName** `string` +需要更新的 Asset(素材资产)所属的项目名称,默认值为default。 +若资源不在默认项目中,需填写正确的项目名称,获取项目名称,请查看 [文档](https://www.volcengine.com/docs/82379/1359411?lang=zh#03ec4a65)。 + +## 响应参数 + +--- + + +**Id** `string` +Asset(素材资产)的 Id。 + +--- + + + +## 请求示例 +```text +POST /?Action=UpdateAsset&Version=2024-01-01 HTTP/1.1 +Host: ark.cn-beijing.volcengineapi.com +Content-Type: application/json +X-Date: 20260328T000000Z +X-Content-Sha256: 287e874e******d653b44d21e +Authorization: HMAC-SHA256 Credential=AKLTYz******/20260328/cn-beijing/ark/request, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature=47a7d934******e41085f + +{ + "Id": "Asset-2026**********-*****", + "Name": "new-name", + "ProjectName": "default" +} +``` + + +## 响应示例 +```json +{ + "ResponseMetadata": { + "RequestId": "20260328000000000000000000000000", + "Action": "UpdateAsset", + "Version": "2024-01-01", + "Service": "ark", + "Region": "cn-beijing" + }, + "Result": { + "Id": "Asset-2026**********-*****" + } +} +``` + + + diff --git a/docs/API文档/about-Asset-素材组相关/更新素材资产组合信息(UpdateAssetGroup) b/docs/API文档/about-Asset-素材组相关/更新素材资产组合信息(UpdateAssetGroup) new file mode 100644 index 0000000..5672738 --- /dev/null +++ b/docs/API文档/about-Asset-素材组相关/更新素材资产组合信息(UpdateAssetGroup) @@ -0,0 +1,93 @@ +`POST https://ark.cn-beijing.volcengineapi.com/?Action=UpdateAssetGroup&Version=2024-01-01` +更新单个 Asset Group(素材资产组合)信息。当前仅支持更新 Asset Group(素材资产组合)的 Name 和 Description。 + +```mixin-react +return ( +![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_57d0bca8e0d122ab1191b40101b5df75.png =20x) [调用教程](https://www.volcengine.com/docs/82379/2333565) ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_f45b5cd5863d1eed3bc3c81b9af54407.png =20x) [接口列表](https://www.volcengine.com/docs/82379/2318269) ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_bef4bc3de3535ee19d0c5d6c37b0ffdd.png =20x) [开通模型](https://console.volcengine.com/ark/region:ark+cn-beijing/openManagement?LLM=%7B%7D&OpenTokenDrawer=false) +`}> +); +``` + + +--- + + + +## 请求参数 + +### 请求体 + +--- + + +**Id** `string` %%require%% +需要更新的 Asset Group(素材资产组合)的 Id。 + +--- + + +**Name** `string` +需要更新的 Asset Group(素材资产组合)的新名称,上限为 64 个字符。 + +--- + + +**Description** `string` +需要更新的 Asset Group(素材资产组合)的新描述,上限为 300 字符。 + +--- + + +**ProjectName** `string` +需要更新的 Asset Group(素材资产组合)所属的项目名称,默认值为default。 +若资源不在默认项目中,需填写正确的项目名称,获取项目名称,请查看 [文档](https://www.volcengine.com/docs/82379/1359411?lang=zh#03ec4a65)。 + +## 响应参数 + +--- + + +**Id** `string` +Asset Group(素材资产组合)的 Id。 + +--- + + + +## 请求示例 +```text +POST /?Action=UpdateAssetGroup&Version=2024-01-01 HTTP/1.1 +Host: ark.cn-beijing.volcengineapi.com +Content-Type: application/json +X-Date: 20260328T000000Z +X-Content-Sha256: 287e874e******d653b44d21e +Authorization: HMAC-SHA256 Credential=AKLTYz******/20260328/cn-beijing/ark/request, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature=47a7d934******e41085f + +{ + "Id": "group-2026**********-*****", + "Name": "new-name", + "Description": "new-description", + "ProjectName": "default" +} +``` + + +## 响应示例 +```json +{ + "ResponseMetadata": { + "RequestId": "20260328000000000000000000000000", + "Action": "UpdateAssetGroup", + "Version": "2024-01-01", + "Service": "ark", + "Region": "cn-beijing" + }, + "Result": { + "Id": "group-2026**********-*****" + } +} +``` + + + diff --git a/docs/API文档/about-Asset-素材组相关/查询素材资产信息(GetAsset) b/docs/API文档/about-Asset-素材组相关/查询素材资产信息(GetAsset) new file mode 100644 index 0000000..5c290c0 --- /dev/null +++ b/docs/API文档/about-Asset-素材组相关/查询素材资产信息(GetAsset) @@ -0,0 +1,168 @@ +`POST https://ark.cn-beijing.volcengineapi.com/?Action=GetAsset&Version=2024-01-01` +查询素材资产状态,确认素材是否已完成预处理并可用于推理。 + +```mixin-react +return ( +![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_57d0bca8e0d122ab1191b40101b5df75.png =20x) [调用教程](https://www.volcengine.com/docs/82379/2333565) ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_f45b5cd5863d1eed3bc3c81b9af54407.png =20x) [接口列表](https://www.volcengine.com/docs/82379/2318269) ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_bef4bc3de3535ee19d0c5d6c37b0ffdd.png =20x) [开通模型](https://console.volcengine.com/ark/region:ark+cn-beijing/openManagement?LLM=%7B%7D&OpenTokenDrawer=false) +`}> +); +``` + + +--- + + + +## 请求参数 + +### 请求体 + +--- + + +**Id** `string` %%require%% +Asset(素材资产)的 Id。 + +--- + + +**ProjectName** `string` +需要查询的 Asset(素材资产)所属的项目名称,默认值为 `default`。 +若资源不在默认项目中,需填写正确的项目名称,获取项目名称,请查看 [文档](https://www.volcengine.com/docs/82379/1359411?lang=zh#03ec4a65)。 + +## 响应参数 + +--- + + +**Id** `string` +Asset(素材资产)的 Id。 + +--- + + +**Name** `string` +Asset(素材资产)的名称,上限为 64 个字符。 + +--- + + +**URL** `string` +Asset(素材资产)的访问地址。有效期为 12 小时,请及时保存。 + +--- + + +**AssetType** `string` +Asset(素材资产)的类型。可选值: + +* `Image` +* `Video` +* `Audio` + + +--- + + +**GroupId** `string` +Asset(素材资产)所属的 Asset Group(素材资产组合)的 Id。 + +--- + + +**Status** `string` +素材资产状态。可选值: + +* `Active`:已处理完毕,可以使用 +* `Processing`:正在预处理,无法使用 +* `Failed`:处理失败 + + +--- + + +**Error** `object` +错误信息。 +属性 + +--- + + + Error.**Code** `string` + 错误码。 + +--- + + + Error.**Message** `string` + 错误信息。 + +--- + + +**CreateTime** `string` +创建时间。 + +--- + + +**UpdateTime** `string` +更新时间。 + +--- + + +**ProjectName** `string` +资源所属的项目名称。 + +--- + + + +## 请求示例 +```text +POST /?Action=GetAsset&Version=2024-01-01 HTTP/1.1 +Host: ark.cn-beijing.volcengineapi.com +Content-Type: application/json +X-Date: 20260328T000000Z +X-Content-Sha256: 287e874e******d653b44d21e +Authorization: HMAC-SHA256 Credential=AKLTYz******/20260328/cn-beijing/ark/request, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature=47a7d934******e41085f + +{ + "Id": "Asset-2026**********-*****", + "ProjectName": "default" +} +``` + + +## 响应示例 +```json +{ + "ResponseMetadata": { + "RequestId": "20260328000000000000000000000000", + "Action": "GetAsset", + "Version": "2024-01-01", + "Service": "ark", + "Region": "cn-beijing" + }, + "Result": { + "Id": "Asset-2026**********-*****", + "Name": "test", + "URL": "https://example.com/asset-url", + "AssetType": "Image", + "GroupId": "group-2026**********-*****", + "Status": "Active", + "Error": { + "Code": "", + "Message": "" + }, + "CreateTime": "2026-03-28T00:00:00Z", + "UpdateTime": "2026-03-28T00:00:00Z", + "ProjectName": "default" + } +} +``` + + + diff --git a/docs/API文档/about-Asset-素材组相关/查询素材资产列表(ListAssets) b/docs/API文档/about-Asset-素材组相关/查询素材资产列表(ListAssets) new file mode 100644 index 0000000..05d3697 --- /dev/null +++ b/docs/API文档/about-Asset-素材组相关/查询素材资产列表(ListAssets) @@ -0,0 +1,280 @@ +`POST https://ark.cn-beijing.volcengineapi.com/?Action=ListAssets&Version=2024-01-01` +查询符合筛选条件的 Assets(素材资产)列表。 + +```mixin-react +return ( +![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_57d0bca8e0d122ab1191b40101b5df75.png =20x) [调用教程](https://www.volcengine.com/docs/82379/2333565) ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_f45b5cd5863d1eed3bc3c81b9af54407.png =20x) [接口列表](https://www.volcengine.com/docs/82379/2318269) ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_bef4bc3de3535ee19d0c5d6c37b0ffdd.png =20x) [开通模型](https://console.volcengine.com/ark/region:ark+cn-beijing/openManagement?LLM=%7B%7D&OpenTokenDrawer=false) +`}> +); +``` + + +--- + + + +## 请求参数 + +### 请求体 + +--- + + +**Filter** `object` %%require%% +搜索的过滤条件。 +属性 + +--- + + + Filter.**GroupIds** `string[]` + Asset(素材资产)所属的 Asset Group(素材资产组合)的 Id 列表。 + +--- + + + Filter.**GroupType** `string` %%require%% + Asset Group(素材资产组合)的类型。可选值: + + * `AIGC`:虚拟人像 + * `LivenessFace`:真人素材 + + +--- + + + Filter.**Statuses** `string[]` + 素材资产状态。可选值: + + * `Active`:素材资产已处理完毕,可以使用 + * `Processing`:素材资产正在预处理,无法使用 + * `Failed`:素材资产处理失败 + + +--- + + + Filter.**Name** `string` + Asset(素材资产)的名称,上限为 64 个字符。 + +--- + + +**PageNumber** `integer (i64)` %%require%% +搜索页码,从 1 开始。例如:`1` 表示返回第一页的搜索结果。 + +--- + + +**PageSize** `integer (i64)` %%require%% +每页搜索结果的数量,上限为 100。 + +--- + + +**SortBy** `string` +用于排序的字段名称,默认值为 `CreateTime`。可选值: + +* `CreateTime`:根据创建时间排序 +* `UpdateTime`:根据更新时间排序 +* `GroupId`:根据资产素材组的 Id 排序 + + +--- + + +**SortOrder** `string` +排序顺序,默认值为 `Desc`。可选值: + +* `Desc`:降序 +* `Asc`:升序 + + +--- + + +**ProjectName** `string` +资源所属的项目名称,默认值为default。 +若资源不在默认项目中,需填写正确的项目名称,获取项目名称,请查看 [文档](https://www.volcengine.com/docs/82379/1359411?lang=zh#03ec4a65)。 + +## 响应参数 + +--- + + +**Items** `object[]` +符合筛选条件的 Asset(素材资产)数组。 +属性 + +--- + + + Items.**Id** `string` + Asset(素材资产)的 Id。 + +--- + + + Items.**Name** `string` + Asset(素材资产)的名称,上限为 64 个字符。 + +--- + + + Items.**URL** `string` + Asset(素材资产)的公共可访问地址。有效期为 12 小时,请及时保存。 + +--- + + + Items.**GroupId** `string` + Asset(素材资产)所属的 Asset Group(素材资产组合)的 Id。 + +--- + + + Items.**AssetType** `string` + Asset(素材资产)的类型。可选值: + + * `Image`:图像 + * `Video`:视频 + * `Audio`:音频 + + +--- + + + Items.**Status** `string` + 任务状态。可选值: + + * `Active` + * `Processing` + * `Failed` + + +--- + + + Items.**Error** `object` + 错误信息。 + 属性 + +--- + + + Items.Error.**Code** `string` + 错误码。 + +--- + + + Items.Error.**Message** `string` + 错误信息。 + +--- + + + Items.**ProjectName** `string` + 资源所属的项目名称。 + +--- + + + Items.**CreateTime** `string` + 创建时间。 + +--- + + + Items.**UpdateTime** `string` + 更新时间。 + +--- + + +**TotalCount** `integer (i64)` +返回总数。 + +--- + + +**PageNumber** `integer (i64)` +返回的页数。 + +--- + + +**PageSize** `integer (i64)` +每页搜索结果的数量,上限为 100。 + +--- + + + +## 请求示例 +```text +POST /?Action=ListAssets&Version=2024-01-01 HTTP/1.1 +Host: ark.cn-beijing.volcengineapi.com +Content-Type: application/json +X-Date: 20260328T000000Z +X-Content-Sha256: 287e874e******d653b44d21e +Authorization: HMAC-SHA256 Credential=AKLTYz******/20260328/cn-beijing/ark/request, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature=47a7d934******e41085f + +{ + "Filter": { + "GroupIds": [ + "group-2026**********-*****" + ], + "GroupType": "AIGC", + "Statuses": [ + "Active" + ], + "Name": "test" + }, + "PageNumber": 1, + "PageSize": 10, + "SortBy": "CreateTime", + "SortOrder": "Desc", + "ProjectName": "default" +} +``` + + +## 响应示例 +```json +{ + "ResponseMetadata": { + "RequestId": "20260328000000000000000000000000", + "Action": "ListAssets", + "Version": "2024-01-01", + "Service": "ark", + "Region": "cn-beijing" + }, + "Result": { + "Items": [ + { + "Id": "Asset-2026**********-*****", + "Name": "test", + "URL": "https://example.com/asset-url", + "GroupId": "group-2026**********-*****", + "AssetType": "Image", + "Status": "Active", + "Error": { + "Code": "", + "Message": "" + }, + "ProjectName": "default", + "CreateTime": "2026-03-28T00:00:00Z", + "UpdateTime": "2026-03-28T00:00:00Z" + } + ], + "TotalCount": 1, + "PageNumber": 1, + "PageSize": 10 + } +} +``` + + + diff --git a/docs/API文档/about-Asset-素材组相关/查询素材资产组合信息(GetAssetGroup) b/docs/API文档/about-Asset-素材组相关/查询素材资产组合信息(GetAssetGroup) new file mode 100644 index 0000000..7d9adbb --- /dev/null +++ b/docs/API文档/about-Asset-素材组相关/查询素材资产组合信息(GetAssetGroup) @@ -0,0 +1,125 @@ +`POST https://ark.cn-beijing.volcengineapi.com/?Action=GetAssetGroup&Version=2024-01-01` +获取单个Asset Group(素材资产组合)信息。 + +```mixin-react +return ( +![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_57d0bca8e0d122ab1191b40101b5df75.png =20x) [调用教程](https://www.volcengine.com/docs/82379/2333565) ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_f45b5cd5863d1eed3bc3c81b9af54407.png =20x) [接口列表](https://www.volcengine.com/docs/82379/2333601) ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_bef4bc3de3535ee19d0c5d6c37b0ffdd.png =20x) [开通模型](https://console.volcengine.com/ark/region:ark+cn-beijing/openManagement?LLM=%7B%7D&OpenTokenDrawer=false) +`}> +); +``` + + +--- + + + +## 请求参数 + +### 请求体 + +--- + + +**Id** `string` %%require%% +Asset Group(素材资产组合)的 Id。 + +--- + + +**ProjectName** `string` +需要查询的 Asset Group(素材资产组合)所属的项目名称,默认值为default。 +若资源不在默认项目中,需填写正确的项目名称,获取项目名称,请查看 [文档](https://www.volcengine.com/docs/82379/1359411?lang=zh#03ec4a65)。 + +## 响应参数 + +--- + + +**Id** `string` +Asset Group(素材资产组合)的 Id。 + +--- + + +**Name** `string` +Asset Group(素材资产组合)的名称,上限为 64 个字符。 + +--- + + +**Description** `string` +Asset Group(素材资产组合)的描述,上限为 300 字符。 + +--- + + +**GroupType** `string` +Asset Group(素材资产组合)的类型。可选值: + +* `AIGC`:虚拟人像 +* `LivenessFace`:真人素材 + + +--- + + +**ProjectName** `string` +资源所属的项目名称。 + +--- + + +**CreateTime** `string` +创建时间。 + +--- + + +**UpdateTime** `string` +更新时间。 + +--- + + + +## 请求示例 +```text +POST /?Action=GetAssetGroup&Version=2024-01-01 HTTP/1.1 +Host: ark.cn-beijing.volcengineapi.com +Content-Type: application/json +X-Date: 20260328T000000Z +X-Content-Sha256: 287e874e******d653b44d21e +Authorization: HMAC-SHA256 Credential=AKLTYz******/20260328/cn-beijing/ark/request, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature=47a7d934******e41085f + +{ + "Id": "group-2026**********-*****", + "ProjectName": "default" +} +``` + + +## 响应示例 +```json +{ + "ResponseMetadata": { + "RequestId": "20260328000000000000000000000000", + "Action": "GetAssetGroup", + "Version": "2024-01-01", + "Service": "ark", + "Region": "cn-beijing" + }, + "Result": { + "Id": "group-2026**********-*****", + "Name": "test", + "Description": "test", + "GroupType": "AIGC", + "ProjectName": "default", + "CreateTime": "2026-03-28T00:00:00Z", + "UpdateTime": "2026-03-28T00:00:00Z" + } +} +``` + + + diff --git a/docs/API文档/about-Asset-素材组相关/查询素材资产组合列表(ListAssetGroups) b/docs/API文档/about-Asset-素材组相关/查询素材资产组合列表(ListAssetGroups) new file mode 100644 index 0000000..b03ff1f --- /dev/null +++ b/docs/API文档/about-Asset-素材组相关/查询素材资产组合列表(ListAssetGroups) @@ -0,0 +1,220 @@ +`POST https://ark.cn-beijing.volcengineapi.com/?Action=ListAssetGroups&Version=2024-01-01` +查询符合筛选条件的Asset Groups(素材资产组合)列表。 + +```mixin-react +return ( +![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_57d0bca8e0d122ab1191b40101b5df75.png =20x) [调用教程](https://www.volcengine.com/docs/82379/2333565) ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_f45b5cd5863d1eed3bc3c81b9af54407.png =20x) [接口列表](https://www.volcengine.com/docs/82379/2318269) ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_bef4bc3de3535ee19d0c5d6c37b0ffdd.png =20x) [开通模型](https://console.volcengine.com/ark/region:ark+cn-beijing/openManagement?LLM=%7B%7D&OpenTokenDrawer=false) +`}> +); +``` + + +--- + + + +## 请求参数 + +### 请求体 + +--- + + +**Filter** `object` %%require%% +搜索的过滤条件。 + +属性 +Filter.**GroupIds** `array` +Asset Group(素材资产组合)的 Id 列表。 + +--- + + +Filter.**GroupType** `string` %%require%% +Asset Group(素材资产组合)的类型。可选值: + +* `AIGC`:虚拟人像 +* `LivenessFace`: 真人素材 + + +--- + + +Filter.**Name** `string` +Asset Group(素材资产组合)的名称,上限为 64 个字符。 + + + +--- + + +**PageNumber** `integer (i64)` %%require%% +搜索页码,可用于列表分页功能,从 1 开始。例如:"page_number": 1,即返回第一页的搜索结果。 + +--- + + +**PageSize** `integer (i64)` %%require%% +每页搜索结果的数量,上限为 100。 + +--- + + +**SortBy** `string` +用于排序的字段名称,默认值为 `CreateTime`。可选值: + +* `CreateTime`:根据创建时间排序 +* `UpdateTime`:根据更新时间排序 + + +--- + + +**SortOrder** `string` +排序顺序,默认值为 `Desc`。可选值: + +* `Desc`:降序 +* `Asc`:升序 + + +--- + + +**ProjectName** `string` +资源所属的项目名称,默认值为 default。 +若资源不在默认项目中,需填写正确的项目名称,获取项目名称,请查看 [文档](https://www.volcengine.com/docs/82379/1359411?lang=zh#03ec4a65)。 + +## 响应参数 + +--- + + +**TotalCount ** `int (i64)` +返回的 Asset Group(素材资产组合)的总数。 + +--- + + +**Items** `array[] ` +符合筛选条件的 Asset Group(素材资产组合)数组。 + +--- + + + Items.**Id** `string` + Asset Group(素材资产组合)的 Id。 + +--- + + + Items.**Name** `string` + Asset Group(素材资产组合)的名称,上限为64个字符。 + +--- + + + Items.**Description** `string` + Asset Group(素材资产组合)的描述,上限为 300 字符。 + +--- + + + Items.**GroupType** `string` + Asset Group(素材资产组合)的类型。 + + * `AIGC`:虚拟人像。 + * `LivenessFace`: 真人素材 + + +--- + + + Items.**ProjectName** `string` + 资源所属的项目名称。 + +--- + + + Items.**CreateTime** `string` + 创建时间。 + +--- + + + Items.**UpdateTime** `string` + 更新时间。 + +--- + + + +### **PageNumber ** int (i64) +返回的页数。 + +--- + + + +### **PageSize ** int (i64) +每页搜索结果的数量,上限为100。 + +--- + + + +## 请求示例 +```text +POST /?Action=ListAssetGroups&Version=2024-01-01 HTTP/1.1 +Host: ark.cn-beijing.volcengineapi.com +Content-Type: application/json +X-Date: 20260328T000000Z +X-Content-Sha256: 287e874e******d653b44d21e +Authorization: HMAC-SHA256 Credential=AKLTYz******/20260328/cn-beijing/ark/request, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature=47a7d934******e41085f + +{ + "Filter": { + "Name": "test", + "GroupType": "AIGC" + }, + "PageNumber": 1, + "PageSize": 10, + "SortBy": "CreateTime", + "SortOrder": "Desc", + "ProjectName": "default" +} +``` + + +## 响应示例 +```json +{ + "ResponseMetadata": { + "RequestId": "20260328000000000000000000000000", + "Action": "ListAssetGroups", + "Version": "2024-01-01", + "Service": "ark", + "Region": "cn-beijing" + }, + "Result": { + "TotalCount": 1, + "Items": [ + { + "Id": "group-2026**********-*****", + "Name": "test", + "Title": "test", + "Description": "test", + "GroupType": "AIGC", + "ProjectName": "default", + "CreateTime": "2026-03-28T00:00:00Z", + "UpdateTime": "2026-03-28T00:00:00Z" + } + ], + "PageNumber": 1, + "PageSize": 10 + } +} +``` + + + diff --git a/docs/API文档/私域虚拟人像素材资产库使用指南(邀测用户版).md b/docs/API文档/about-Asset-素材组相关/私域虚拟人像素材资产库使用指南(邀测用户版).md similarity index 100% rename from docs/API文档/私域虚拟人像素材资产库使用指南(邀测用户版).md rename to docs/API文档/about-Asset-素材组相关/私域虚拟人像素材资产库使用指南(邀测用户版).md