文档中心

获取图像修复列表详情

最近更新时间：2024.04.26 11:06:58

首次发布时间：2024.04.26 11:06:58

本接口支持获取图像修复模型列表信息。

注意事项

请求频率：单用户请求频率限制为 5 次/秒。
超时时间：约为 10 秒。
前提条件：已开通图像修复组件能力。
计费说明：图像修复功能属于增值服务项，故使用后会产生增值服务费用，当前支持后付费的计费方式，具体请参见增值服务。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

请求方式：GET
请求地址：https://imagex.volcengineapi.com/?Action=GetImageEraseModels&Version=2023-05-01

调试

API Explorer

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

去调试

请求参数

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

Query

参数类型是否必选示例值描述

Action String 是 GetImageEraseModels 接口名称。当前 API 的名称为 GetImageEraseModels。

Version String 是 2023-05-01 接口版本。当前 API 的版本为 2023-05-01。

参数	类型	是否必选	示例值	描述
Action	String	是	`GetImageEraseModels`	接口名称。当前 API 的名称为 `GetImageEraseModels`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
Type	Integer	否	`0`	图像修复模型，取值如下所示： `0`：（默认）自动检测并擦除模型列表。 `1`：指定区域擦除模型列表。

Type

Integer

否

0

图像修复模型，取值如下所示：

0：（默认）自动检测并擦除模型列表。
1：指定区域擦除模型列表。

返回参数

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

参数	类型	示例值	描述
Models	Array of String	`["eraser_model_imagex_0.1.0"]`	模型列表。

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageEraseModels&Version=2023-05-01&Type=0

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022052415234901022524314707965A79",
        "Action": "GetImageEraseModels",
        "Version": "2023-05-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "Models": ["eraser_model_imagex_0.1.0"]
    }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码和 veImageX 错误码。

服务端 SDK

为了方便您快速开发，veImageX 提供了配套的服务端 SDK，同时支持多种编程语言。建议您使用服务端 SDK 来调用 API，参考文档如下所示：