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

文档中心

立即注册

导航

veImageX

获取组件标签列表详情

最近更新时间：2024.08.20 11:33:57首次发布时间：2021.02.23 10:42:29

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

说明

该接口属于历史版本 API，建议您使用新版 GetImageAddOnTag 接口。

请求说明

接口名称：GetImageAddOnTag
请求方式：GET
接口地址示例：https://imagex.volcengineapi.com/?Action=GetImageAddOnTag&Version=2018-08-01
请求频率限制：5 次/秒
超时时间：5 秒

说明

veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

Query

参数	类型	是否必选	描述
Action	String	是	接口名称。
Version	String	是	接口版本。veImageX 当前 API 的版本为 `2018-08-01`。
Key	String	是	组件标签 key。仅支持取值为`功能属性`，返回功能相关标签值。

返回参数

参数	类型	描述
Tag	Array of String	账号内的可见的附加组件标签名称，一个标签下可以包含多个组件功能。

示例

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageAddOnTag&Version=2018-08-01&Key=功能属性

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "202012061458560100110461411B0409BB",
        "Action": "GetImageAddOnTag",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "Tag": [
            "分割抠图",
         		"图像修复",
         		"图像填充",
        		"图像增强",
        		"图像评分",
         		"图片去重",
         		"图片合成",
         		"图片搜索",
         		"性能优化",
         		"文字识别",
         		"智能图像处理",
         		"智能裁剪",
         		"版权保护",
         		"风格迁移"
        ]
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
				"Action": "GetImageAddOnTag",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
            "Code": "",
            "Message": ""
        }
    }
}

错误码

访问错误码和附加组件错误码获取详细信息。