查询分组列表
POST
/xmind-cloud-platform/openapi/volcengine?Action=ListAssetGroups&Version=2024-01-01按分组类型、分组 ID 与名称分页查询素材分组。
请求参数
Action 与 Version 通过查询参数传递,其余参数放在 JSON 请求体中。
分组类型,当前只支持 AIGC。
默认值:-分组 ID 列表,元素为平台分组 ID 字符串。
默认值:-按分组名称模糊匹配。
默认值:-页码,大于 0;不传时默认第 1 页。
默认值:-每页数量,取 1-100;不传时默认 20。PageSize * PageNumber 不能超过 10000。
默认值:-游标分页模式,取 1-100;与 PageNumber 不能混用。
默认值:-游标分页的翻页令牌,首次请求不传。
默认值:-分页模式不能混用
PageNumber、PageSize 属于页码分页,MaxResults、NextToken 属于游标分页。同一次请求只能选择一种;超过页码窗口时需要改用 NextToken 做深翻页。
认证
所有接口使用同一套 V4 签名,凭证与签名方式见火山方舟素材库 API 概览。以下请求头为通用要求:
固定为 application/json。
默认值:application/json实际访问的域名和端口;包含端口时必须写入签名。
默认值:-UTC 时间,格式 yyyyMMdd'T'HHmmss'Z',例如 20261022T131900Z;与平台时间偏差不能超过 300 秒。
默认值:-原始请求体的 SHA-256 小写十六进制。
默认值:-V4 HMAC-SHA256 签名。
默认值:-响应
分组列表。
默认值:-分组 ID。
默认值:-分组名称。
默认值:-分组描述。
默认值:-分组类型,固定为 AIGC。
默认值:-创建时间,UTC 时间字符串。
默认值:-更新时间,UTC 时间字符串。
默认值:-符合条件的分组总数。
默认值:-当前页码。
默认值:-每页数量。
默认值:-游标分页时有下一页才会返回。
默认值:-错误
| Code | 说明 |
|---|---|
400 | InvalidParameter:参数格式或取值非法 |
401 | SignatureDoesNotMatch、InvalidTimestamp、XContentSha256Mismatch、MissingParameter.Authorization 等签名或时间相关错误 |
403 | AccessDenied 凭证被禁用或无权限;ExpiredToken 凭证已过期 |
429 | QuotaWriteQPMExceeded 每分钟写入额度用尽;AccountFlowLimitExceeded 每秒请求上限触发;TooManyRequests 请求过于频繁 |