ListCustomModels - 获取定制模型列表--火山方舟大模型服务平台-火山引擎

文档中心

立即注册

导航

ListCustomModels - 获取定制模型列表

最近更新时间：2024.11.01 19:43:36首次发布时间：2024.05.15 01:48:35

获取定制模型列表

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ListCustomModels	要执行的操作，取值：ListCustomModels。
Version	String	是	2024-01-01	API的版本，取值：2024-01-01。
PageNumber	Integer	否	1	分页查询时的起始页码，从 1 开始，默认为 1
PageSize	Integer	否	1	分页查询时每页显示的记录数。取值：最小值：1 最大值：100 默认值：10
Filter	Object	否	-	待查询定制模型的筛选条件
TagFilters	Array of Object	否	-	基于绑定的标签的筛选条件
ProjectName	String	否	default	项目名称
SortBy	String	否	CreateTime	指定排序指标。可指定值: CreateTime：创建时间 UpdateTime：更新时间
SortOrder	String	否	Asc	指定排序顺序。可指定值: Asc：升序排列 Desc：降序排列

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
TotalCount	Integer	1	总定制模型数
PageNumber	Integer	1	分页查询时的起始页码，从 1 开始，默认为 1
PageSize	Integer	10	分页查询时每页显示的记录数，取值：最小值：1 最大值：100 默认值：10
Items	Array of Object	-	定制模型列表

请求示例

POST /?Action=ListCustomModels&Version=2024-01-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240514T130512Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240514/cn-beijing/ark/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "PageNumber": 1,
  "PageSize": 1,
  "Filter": {
    "Ids": [
      "vrYVig"
    ],
    "Name": "aThQ2SZH"
  },
  "TagFilters": [
    {
      "Key": "8mYbP7pN",
      "Values": [
        "8bS"
      ]
    }
  ],
  "ProjectName": "default",
  "SortBy": "CreateTime",
  "SortOrder": "Desc"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240514210517123075045154E335F9",
    "Action": "ListCustomModels",
    "Version": "2024-01-01",
    "Service": "ark",
    "Region": "cn-beijing"
  },
  "Result": {
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 10,
    "Items": [
      {
        "Id": "jJJ",
        "Name": "Xf",
        "Description": "F",
        "SourceType": "lBQb26",
        "ModelCustomizationJobId": "eYClLOD",
        "CustomizationType": "lxb0G1",
        "Status": "Ready",
        "HyperParameters": [
          {
            "Name": "cALJ0SSf",
            "Value": "Iais76"
          }
        ],
        "FoundationModel": {
          "Name": "OI",
          "ModelVersion": "jf0GoztY9"
        },
        "Tags": [
          {
            "Key": "VKk5m6sRdxl",
            "Value": "t3ieup"
          }
        ],
        "ProjectName": "bIA3",
        "CreateTime": "lYuGzty",
        "UpdateTime": "D33NRefE"
      }
    ]
  }
}

错误码

您可访问公共错误码，获取更多错误码信息。