获取应用列表--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

获取应用列表

最近更新时间：2024.08.09 10:27:33首次发布时间：2021.02.23 10:42:26

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

说明

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

请求说明

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

说明

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

请求参数

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

Query

参数类型是否必选描述

Action String 是接口名称。

Version String 是接口版本。veImageX 当前 API 的版本为 2018-08-01。

参数	类型	是否必选	描述
Action	String	是	接口名称。
Version	String	是	接口版本。veImageX 当前 API 的版本为 `2018-08-01`。
Source	String	否	数据来源，账号下近 60 天内有数据上报的应用 ID，缺省情况下返回账号对应的全部应用 ID。 `upload`：上传 1.0 数据。 `cdn`：下行网络数据。 `client`：客户端数据。 `sensible`：感知数据。 `uploadv2`：上传 2.0 数据。 `exceed`：大图监控数据。

Source

String

否

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

upload：上传 1.0 数据。
cdn：下行网络数据。
client：客户端数据。
sensible：感知数据。
uploadv2：上传 2.0 数据。
exceed：大图监控数据。

返回参数

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

Apps

参数类型描述

AppId String 应用 ID。

AppName String 应用名称。

参数	类型	描述
AppId	String	应用 ID。
AppName	String	应用名称。
AppRegion	String	App 所属地区。 `cn`：国内。 `sg`：新加坡。

AppRegion

String

App 所属地区。

cn：国内。
sg：新加坡。

示例

请求示例

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

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2019062716011401022507408218620",
        "Action": "GetImageXQueryApps",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "Apps": [
            {
                "AppId": "13",
                "AppName": "xxx",
                "AppRegion": "cn"
            },
            {
                "AppId": "36",
                "AppName": "xxx",
                "AppRegion": "cn"
            }
        ]
    }
}

异常返回示例

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

错误码

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