文档中心

获取自定义维度列表

最近更新时间：2023.05.26 12:05:07

首次发布时间：2021.02.23 10:42:27

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

请求说明

接口名称：GetImageXQueryDims
请求方式：GET
接口地址示例：https://imagex.volcengineapi.com/?Action=GetImageXQueryDims&Version=2018-08-01
请求频率：
- API 整体的请求频率限制为 100 次/秒。
- 单用户请求频率限制为 50 次/秒。
数据延迟：数据延迟为 15 min。

说明

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

请求参数

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

Query

参数	类型	是否必选	描述
Action	String	是	接口名称。
Version	String	是	接口版本。veImageX 当前 API 的版本为 `2018-08-01`。
Source	String	是	数据来源。 `upload`：上传 1.0 数据。 `cdn`：下行网络数据。 `client`：客户端数据。 `sensible`：感知数据。 `uploadv2`：上传 2.0 数据。 `exceed`：大图监控数据。
Appid	String	否	应用 ID。默认为空，匹配账号下所有的 App ID。说明您可以通过调用获取应用列表的方式获取所需的 AppID。
OS	String	否	需要匹配的系统类型，不传则匹配非 WEB 端的所有系统。取值如下所示： `iOS` `Android` `WEB`

返回参数

参数	类型	描述
Dim	Array of String	上报数据中出现的维度信息。

示例

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageXQueryDims&Version=2018-08-01&Source=client

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2019062716011401022507408218620",
        "Action": "GetImageXQueryDims",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "Dim": [
            "biz_tag",
            "cdn_name",
            "access"
        ]
    }
}

异常返回示例

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

错误码

访问公共错误码以及通用错误码获取详细信息

请求说明

请求参数

Query

返回参数

示例

请求示例

正常返回示例

异常返回示例

错误码