查询自定义维度列表--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

查询自定义维度列表

最近更新时间：2024.08.13 20:23:50首次发布时间：2024.03.19 20:35:15

本接口支持通过指定数据来源，查询上传数据中的维度信息。

注意事项

请求频率：
- API 整体的请求频率限制为 100 次/秒。
- 单用户请求频率限制为 50 次/秒。
数据延迟：约为 15 分钟。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetImageXQueryDims`	接口名称。当前 API 的名称为 `GetImageXQueryDims`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
Source	String	是	`upload`	数据来源，取值如下所示： `upload`：上传 1.0 数据。 `cdn`：下行网络数据。 `client`：客户端数据。 `sensible`：感知数据。 `uploadv2`：上传 2.0 数据。 `exceed`：大图监控数据，包含大图样本量和大图明细。 `exceed_all`：大图分布数据。
Appid	String	否	`123`	应用 ID。默认为空，匹配账号下所有的 AppID。说明您可以通过调用获取应用列表的方式获取所需的 AppID。
OS	String	否	`iOS`	需要匹配的系统类型。取值如下所示：不传或传空字符串：Android+iOS。 `iOS`：iOS。 `Android`：Android。 `WEB`：web+小程序。 `Web`：web，仅当`Source`为`upload`或`uploadv2`时可传。 `Imp`：小程序，仅当`Source`为`upload`或`uploadv2`时可传。

返回参数

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

参数	类型	示例值	描述
Dim	Array of String	`["biz_tag"]`	上报数据中出现的维度信息。

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageXQueryDims&Version=2023-05-01&Source=upload&Appid=123&OS=iOS

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "GetImageXQueryDims",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "Dim": [
            "biz_tag"
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。更多信息请见公共错误码和 veImageX 错误码。

状态码	错误码	错误信息	说明
400	InvalidParameter	Missing Parameter.	请求参数错误，请检查您的请求参数是否正确。
401	ParamAccountMismatch	Param {} did not belong to your account.	请求参数不属于账号，请检查您的请求参数是否正确。
500	InternalError	Internal Error.	内部错误，请提交工单联系技术支持。

服务端 SDK

veImageX 提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。

历史版本

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