查询应用列表--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=GetImageXQueryApps&Version=2023-05-01

调试

API Explorer

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

去调试

请求参数

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

Query

参数类型是否必选示例值描述

Action String 是 GetImageXQueryApps 接口名称。当前 API 的名称为 GetImageXQueryApps。

Version String 是 2023-05-01 接口版本。当前 API 的版本为 2023-05-01。

参数	类型	是否必选	示例值	描述
Action	String	是	`GetImageXQueryApps`	接口名称。当前 API 的名称为 `GetImageXQueryApps`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
Source	String	否	`upload`	数据来源，账号下近 60 天内有数据上报的应用 ID，缺省情况下返回账号对应的全部应用 ID。取值如下所示： `upload`：上传 1.0 数据。 `cdn`：下行网络数据。 `client`：客户端数据。 `sensible`：感知数据。 `uploadv2`：上传 2.0 数据。 `exceed`：大图监控数据，包含大图样本量和大图明细。 `exceed_all`：大图分布数据。

Source

String

否

upload

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

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

返回参数

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

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

Apps

参数类型示例值描述

AppId String 123 应用 ID。

AppName String n1 应用名称。

参数	类型	示例值	描述
AppId	String	`123`	应用 ID。
AppName	String	`n1`	应用名称。
AppRegion	String	`cn`	App 所属地区，取值如下所示： `cn`：国内。 `sg`：新加坡。

AppRegion

String

cn

App 所属地区，取值如下所示：

cn：国内。
sg：新加坡。

请求示例

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"
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。更多信息请见公共错误码和 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 版本 GetImageXQueryApps 接口文档现已停止维护，建议您参考本文档使用最新版本。