获取组件标签列表详情--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

获取组件标签列表详情

最近更新时间：2024.08.20 10:41:59首次发布时间：2024.08.20 10:41:59

本接口支持通过指定组件标签 key 获取已发布且对应账号可见的组件相关标签值。

注意事项

请求频率：单用户请求频率限制为 5 次/秒。
超时时间：约为 5 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetImageAddOnTag`	接口名称。当前 API 的名称为 `GetImageAddOnTag`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
Key	String	是	`功能属性`	组件标签 key。取值固定为`功能属性`，返回相关标签值。
Type	String	否	`AI`	组件类型，默认获取所有类型的标签信息。取值如下所示： `AI`：智能处理类型 `Other`：其他增值类型

返回参数

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

参数	类型	示例值	描述
Tag	Array of String	`[ "分割抠图", "去水印", "图像增强", "图像处理", "图像检测", "图像评分", "图片去重", "图片合成", "图片搜索", "文字识别", "版权保护" ]`	账号内的可见的附加组件标签名称，一个标签下可以包含多个组件功能。

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageAddOnTag&Version=2023-05-01&Key=功能属性&Type=AI

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetImageAddOnTag",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "Tag": [
            "分割抠图",
            "去水印",
            "图像增强",
            "图像处理",
            "图像检测",
            "图像评分",
            "图片去重",
            "图片合成",
            "图片搜索",
            "文字识别",
            "版权保护"
        ]
    }
}

错误码

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

历史版本

2018-08-01 版本 GetImageAddOnTag 接口文档现已停止维护，建议您参考本文档使用最新版本。