You need to enable JavaScript to run this app.
导航
查询应用列表
最近更新时间:2024.03.20 19:50:14首次发布时间:2024.03.19 20:35:15

本接口支持指定应用数据传入来源,查询账号下当前来源的应用信息。

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringGetImageXQueryApps接口名称。当前 API 的名称为 GetImageXQueryApps
VersionString2023-05-01接口版本。当前 API 的版本为 2023-05-01

Source

String

upload

数据来源,账号下近 60 天内有数据上报的应用 ID,缺省情况下返回账号对应的全部应用 ID。取值如下所示:

  • upload:上传 1.0 数据。
  • cdn:下行网络数据。
  • client:客户端数据。
  • sensible:感知数据。
  • uploadv2:上传 2.0 数据。
  • exceed:大图监控数据,包含大图样本量和大图明细。
  • exceed_all:大图分布数据。

返回参数

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

参数类型示例值描述
AppsArray of Apps-火山引擎账号内的所有 App 信息。

Apps

参数类型示例值描述
AppIdString123应用 ID。
AppNameStringn1应用名称。

AppRegion

String

cn

App 所属地区,取值如下所示:

  • cn:国内。
  • sg:新加坡。
PackageNameStringp1App 绑定的安卓包名。
BundleIdStringb1App 绑定的 iOS 包名。

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageXQueryApps&Version=2023-05-01&Source=upload

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "GetImageXQueryApps",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "Apps": [
            {
                "AppId": "123",
                "AppName": "n1",
                "AppRegion": "cn",
                "PackageName": "p1",
                "BundleId": "b1"
            }
        ]
    }
}

错误码

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

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

服务端 SDK

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