阅读本文,您可以获取 Node SDK 大图监控的接口调用示例,实现快速开发。
说明
本文的调用示例包含接口的部分参数。由于参数间可能存在互斥关系,在调用时,请您参考注释,进行调整。
调用接口前,请先完成 Node SDK 的安装及初始化操作。
本节为您介绍大图监控相关接口的功能和调用示例。
您可以调用 DescribeImageXExceedCountByTime 接口查询大图监控样本量。详细的参数说明可参见 DescribeImageXExceedCountByTime 接口文档。
接口调用示例如下所示。
import { imagex } from "@volcengine/openapi"; export async function DescribeImageXExceedCountByTimeDemo() { try { const imagexService = new imagex.ImagexService({ // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY accessKeyId: process.env.VOLC_ACCESSKEY, secretKey: process.env.VOLC_SECRETKEY, }); const requestParam = { // 应用 ID。默认为空,不传则匹配账号下的所有的 AppID。您可以通过调用[查询应用列表](https://www.volcengine.com/docs/508/1213042)的方式获取所需的 AppID。 Appid: "123", // 需要匹配的 App 版本,不传则匹配 App 的所有版本。 AppVer: ["1.2.0"], // 需要匹配的系统类型,不传则匹配非 WEB 端的所有系统。取值如下所示: // <li> iOS </li> // <li> Android </li> // <li> WEB </li> OS: "WEB", // 需要匹配的 SDK 版本,不传则匹配所有版本. SdkVer: ["1.2.0"], // 需要匹配的图片类型,不传则匹配所有图片类型。取值如下所示: // <li> GIF </li> // <li> PNG </li> // <li> JPEG </li> // <li> HEIF </li> // <li> HEIC </li> // <li> WEBP </li> // <li> AWEBP </li> // <li> VVIC </li> // <li> AVIF </li> // <li> AVIS </li> // <li> 其他 </li> ImageType: ["PNG"], // 需要匹配的自定义维度项 。 ExtraDims: [ { // 自定义维度名称。 // note: // 您可以通过调用[查询自定义维度列表](https://www.volcengine.com/docs/508/1213048)来获取。 Dim: "access", // 需要匹配的对应维度值 // note: // 您可以通过调用[查询自定义维度值](https://www.volcengine.com/docs/508/1213048)来获取。 Vals: ["4g"], }, ], // 拆分维度。默认为空,表示拆分分位数据。支持取值: // <li> Duration:表示拆分分位数据 </li> // <li> 公共维度:Appid、OS、AppVer、SdkVer、ImageType、Country、Province、Isp、Domain </li> // <li> 自定义维度:您可以通过调用[查询自定义维度列表](https://www.volcengine.com/docs/508/1213048)接口获取自定义维度指标 </li> GroupBy: "OS", // 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 StartTime: "2019-06-27T13:00:00+08:00", // 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 EndTime: "2019-06-27T15:00:00+08:00", // 返回数据的时间粒度,取值如下所示: // * 5m:5 分钟; // * 1h:1 小时; // * 1d:1 天。 Granularity: "1h", }; const res = await imagexService.DescribeImageXExceedCountByTime( requestParam ); console.log("res", res); } catch (err) { console.error(err); } }
您可以调用 DescribeImageXSensibleTopUnknownURL 接口查询大图文件未知原因 Top URL。详细的参数说明可参见 DescribeImageXSensibleTopUnknownURL 接口文档。
接口调用示例如下所示。
import { imagex } from "@volcengine/openapi"; export async function DescribeImageXSensibleTopUnknownURLDemo() { try { const imagexService = new imagex.ImagexService({ // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY accessKeyId: process.env.VOLC_ACCESSKEY, secretKey: process.env.VOLC_SECRETKEY, }); const requestParam = { // 应用 ID。默认为空,缺省情况下匹配账号下的所有的 App ID。您可以通过调用[GetImageXQueryApps](https://www.volcengine.com/docs/508/1213042)的方式获取所需的 AppID。 Appid: "123", // 需要匹配的系统类型,缺省情况下匹配非 WEB 端的所有系统。取值如下所示: // <li> iOS </li> // <li> Android </li> // <li> WEB </li> OS: "Android", // 需要匹配 App 版本,缺省情况下匹配 App 的所有版本。 AppVer: ["1.0.0"], // 需要匹配的 SDK 版本,缺省情况下匹配所有版本。 SdkVer: ["1.0.0"], // 需要匹配的图片类型,缺省情况下则匹配所有图片类型。支持以下取值: // <li> GIF </li> // <li> PNG </li> // <li> JPEG </li> // <li> HEIF </li> // <li> HEIC </li> // <li> WEBP </li> // <li> AWEBP </li> // <li> VVIC </li> // <li> AVIF </li> // <li> AVIS </li> // <li> 其他 </li> ImageType: ["PNG"], // 需要匹配的自定义维度项 ExtraDims: [ { // 自定义维度名称。 // note: // 您可以通过调用[获取自定义维度列表](https://www.volcengine.com/docs/508/1213048)来获取。 Dim: "biz_tag", // 需要匹配的对应维度值。 // note: // 您可以通过调用[获取自定义维度值](https://www.volcengine.com/docs/508/1213050)来获取。 Vals: ["4g"], }, ], // 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 StartTime: "2019-06-02T00:00:00+08:00", // 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 EndTime: "2019-06-03T00:00:00+08:00", // 查询 Top URL 条数,取值范围为(0,1000]。默认值为 1000。 Top: 1000, // 支持以下取值: // <li> 1:按上报量排序 </li> // <li> 2:按内存大小排序 </li> // <li> 3:按文件大小排序 </li> // <li> 4:按图片分辨率排序 </li> // <li> 5:按 view 分辨率排序 </li> OrderByIdx: 2, }; const res = await imagexService.DescribeImageXSensibleTopUnknownURL( requestParam ); console.log("res", res); } catch (err) { console.error(err); } }
您可以调用 DescribeImageXSensibleTopRamURL 接口查询大图文件内存 Top URL。详细的参数说明可参见 DescribeImageXSensibleTopRamURL 接口文档。
接口调用示例如下所示。
import { imagex } from "@volcengine/openapi"; export async function DescribeImageXSensibleTopRamURLDemo() { try { const imagexService = new imagex.ImagexService({ // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY accessKeyId: process.env.VOLC_ACCESSKEY, secretKey: process.env.VOLC_SECRETKEY, }); const requestParam = { // 应用 ID。默认为空,缺省情况下匹配账号下的所有的 App ID。您可以通过调用[GetImageXQueryApps](https://www.volcengine.com/docs/508/1213042)的方式获取所需的 AppID。 Appid: "123", // 需要匹配的系统类型,缺省情况下匹配非 WEB 端的所有系统。取值如下所示: // <li> iOS </li> // <li> Android </li> // <li> WEB </li> OS: "Android", // 需要匹配 App 版本,缺省情况下则匹配 App 的所有版本。 AppVer: ["1.0.0"], // 需要匹配的 SDK 版本,缺省情况下匹配所有版本。 SdkVer: ["1.0.0"], // 需要匹配的图片类型,缺省情况下则匹配所有图片类型。支持以下取值: // <li> GIF </li> // <li> PNG </li> // <li> JPEG </li> // <li> HEIF </li> // <li> HEIC </li> // <li> WEBP </li> // <li> AWEBP </li> // <li> VVIC </li> // <li> AVIF </li> // <li> AVIS </li> // <li> 其他 </li> ImageType: ["PNG"], // 需要匹配的自定义维度项 ExtraDims: [ { // 自定义维度名称。 // note: // 您可以通过调用[获取自定义维度列表](https://www.volcengine.com/docs/508/1213048)来获取。 Dim: "biz_tag", // 需要匹配的对应维度值。 // note: // 您可以通过调用[获取自定义维度值](https://www.volcengine.com/docs/508/1213050)来获取。 Vals: ["4g"], }, ], // 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 StartTime: "2019-06-02T00:00:00+08:00", // 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 EndTime: "2019-06-03T00:00:00+08:00", // 查询 Top URL 条数,取值范围为(0,1000]。缺省情况下默认为 1000。 Top: 1000, // 支持以下取值: // <li> 1:按上报次数降序排序; </li> // <li> 2:按内存大小降序排序。 </li> OrderByIdx: 1, }; const res = await imagexService.DescribeImageXSensibleTopRamURL( requestParam ); console.log("res", res); } catch (err) { console.error(err); } }
您可以调用 DescribeImageXSensibleTopResolutionURL 接口查询大图文件分辨率 Top URL。详细的参数说明可参见 DescribeImageXSensibleTopResolutionURL 接口文档。
接口调用示例如下所示。
import { imagex } from "@volcengine/openapi"; export async function DescribeImageXSensibleTopResolutionURLDemo() { try { const imagexService = new imagex.ImagexService({ // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY accessKeyId: process.env.VOLC_ACCESSKEY, secretKey: process.env.VOLC_SECRETKEY, }); const requestParam = { // 应用 ID。默认为空,缺省情况下匹配账号下的所有的 App ID。您可以通过调用[GetImageXQueryApps](https://www.volcengine.com/docs/508/1213042)的方式获取所需的 AppID。 Appid: "123", // 需要匹配的系统类型,缺省情况下匹配非 WEB 端的所有系统。取值如下所示: // <li> iOS </li> // <li> Android </li> // <li> WEB </li> OS: "Android", // 需要匹配 App 版本,缺省情况下则匹配 App 的所有版本。 AppVer: ["1.0.0"], // 需要匹配的 SDK 版本,缺省情况下匹配所有版本。 SdkVer: ["1.0.0"], // 需要匹配的图片类型,缺省情况下则匹配所有图片类型。支持以下取值: // <li> GIF </li> // <li> PNG </li> // <li> JPEG </li> // <li> HEIF </li> // <li> HEIC </li> // <li> WEBP </li> // <li> AWEBP </li> // <li> VVIC </li> // <li> AVIF </li> // <li> AVIS </li> // <li> 其他 </li> ImageType: ["PNG"], // 需要匹配的自定义维度项 ExtraDims: [ { // 自定义维度名称。 // note: // 您可以通过调用[获取自定义维度列表](https://www.volcengine.com/docs/508/1213048)来获取。 Dim: "biz_tag", // 需要匹配的对应维度值。 // note: // 您可以通过调用[获取自定义维度值](https://www.volcengine.com/docs/508/1213050)来获取。 Vals: ["4g"], }, ], // 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 StartTime: "2019-06-02T00:00:00+08:00", // 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 EndTime: "2019-06-03T00:00:00+08:00", // 查询 Top URL 条数,取值范围为(0,1000]。缺省情况下默认为 1000。 Top: 1000, // 支持以下取值: // <li> 1:按上报次数排序; </li> // <li> 2:按图片分辨率排序; </li> // <li> 3:按 view 分辨率排序。 </li> OrderByIdx: 1, }; const res = await imagexService.DescribeImageXSensibleTopResolutionURL( requestParam ); console.log("res", res); } catch (err) { console.error(err); } }
您可以调用 DescribeImageXSensibleTopSizeURL 接口查询大图文件体积 Top URL。详细的参数说明可参见 DescribeImageXSensibleTopSizeURL 接口文档。
接口调用示例如下所示。
import { imagex } from "@volcengine/openapi"; export async function DescribeImageXSensibleTopSizeURLDemo() { try { const imagexService = new imagex.ImagexService({ // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY accessKeyId: process.env.VOLC_ACCESSKEY, secretKey: process.env.VOLC_SECRETKEY, }); const requestParam = { // 应用 ID。默认为空,缺省情况下则匹配账号下的所有的 App ID。您可以通过调用[获取应用列表](https://www.volcengine.com/docs/508/1213042)的方式获取所需的 AppID。 Appid: "123", // 需要匹配的系统类型,缺省情况下则匹配非 WEB 端的所有系统。取值如下所示: // <li> iOS </li> // <li> Android </li> // <li> WEB </li> OS: "Android", // 需要匹配 App 版本,缺省情况下则匹配 App 的所有版本。 AppVer: ["1.0.0"], // 需要匹配的 SDK 版本,缺省情况下则匹配所有版本。 SdkVer: ["1.0.0"], // 需要匹配的图片类型,缺省情况下则匹配所有图片类型。支持以下取值: // <li> GIF </li> // <li> PNG </li> // <li> JPEG </li> // <li> HEIF </li> // <li> HEIC </li> // <li> WEBP </li> // <li> AWEBP </li> // <li> VVIC </li> // <li> AVIF </li> // <li> AVIS </li> // <li> 其他 </li> ImageType: ["PNG"], // 需要匹配的自定义维度项 ExtraDims: [ { // 自定义维度名称。 // note: // 您可以通过调用[获取自定义维度列表](https://www.volcengine.com/docs/508/1213048)来获取。 Dim: "biz_tag", // 需要匹配的对应维度值。 // note: // 您可以通过调用[获取自定义维度值](https://www.volcengine.com/docs/508/1213050)来获取。 Vals: ["4g"], }, ], // 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 StartTime: "2019-06-02T00:00:00+08:00", // 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 EndTime: "2019-06-03T00:00:00+08:00", // 查询 Top URL 条数,取值范围为(0,1000]。缺省情况下默认为 1000。 Top: 1000, // 支持以下取值: // <li> 1:按上报次数降序排序; </li> // <li> 2:按文件体积降序排序。 </li> OrderByIdx: 1, }; const res = await imagexService.DescribeImageXSensibleTopSizeURL( requestParam ); console.log("res", res); } catch (err) { console.error(err); } }
您可以调用 DescribeImageXExceedFileSize 接口查询大图文件体积大小分布。详细的参数说明可参见 DescribeImageXExceedFileSize 接口文档。
接口调用示例如下所示。
import { imagex } from "@volcengine/openapi"; export async function DescribeImageXExceedFileSizeDemo() { try { const imagexService = new imagex.ImagexService({ // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY accessKeyId: process.env.VOLC_ACCESSKEY, secretKey: process.env.VOLC_SECRETKEY, }); const requestParam = { // 应用 ID。默认为空,不传则匹配账号下的所有的 AppID。您可以通过调用[获取应用列表](https://www.volcengine.com/docs/508/1213042)的方式获取所需的 AppID。 Appid: "123", // 需要匹配的 App 版本,不传则匹配 App 的所有版本。 AppVer: ["1.2.0"], // 需要匹配的系统类型,不传则匹配非 WEB 端的所有系统。取值如下所示: // <li> iOS </li> // <li> Android </li> // <li> WEB </li> OS: "WEB", // 需要匹配的 SDK 版本,不传则匹配所有版本. SdkVer: ["1.2.0"], // 需要匹配的图片类型,不传则匹配所有图片类型。 // <li> GIF </li> // <li> PNG </li> // <li> JPEG </li> // <li> HEIF </li> // <li> HEIC </li> // <li> WEBP </li> // <li> AWEBP </li> // <li> VVIC </li> // <li> AVIF </li> // <li> AVIS </li> // <li> 其他 </li> ImageType: ["PNG"], // 需要匹配的自定义维度项 。 ExtraDims: [ { // 自定义维度名称。 // note: // 您可以通过调用[获取自定义维度列表](https://www.volcengine.com/docs/508/1213048)来获取。 Dim: "access", // 需要匹配的对应维度值 // note: // 您可以通过调用[获取自定义维度值](https://www.volcengine.com/docs/508/1213050)来获取。 Vals: ["4g"], }, ], // 拆分维度。默认为空,表示拆分分位数据。支持取值: // <li> Duration:表示拆分分位数据 </li> // <li> 公共维度:Appid、OS、AppVer、SdkVer、ImageType、Country、Province、Isp、Domain </li> // <li> 自定义维度:您可以通过调用[获取自定义维度列表](https://www.volcengine.com/docs/508/1213048)接口获取自定义维度指标 </li> GroupBy: "OS", // 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 StartTime: "2019-06-27T13:00:00+08:00", // 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 EndTime: "2019-06-27T15:00:00+08:00", // 返回数据的时间粒度,取值如下所示: // * 5m:5 分钟; // * 1h:1 小时; // * 1d:1 天。 Granularity: "1h", }; const res = await imagexService.DescribeImageXExceedFileSize(requestParam); console.log("res", res); } catch (err) { console.error(err); } }
您可以调用 DescribeImageXExceedResolutionRatioAll 接口查询大图分辨率占比分布。详细的参数说明可参见 DescribeImageXExceedResolutionRatioAll 接口文档。
接口调用示例如下所示。
import { imagex } from "@volcengine/openapi"; export async function DescribeImageXExceedResolutionRatioAllDemo() { try { const imagexService = new imagex.ImagexService({ // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY accessKeyId: process.env.VOLC_ACCESSKEY, secretKey: process.env.VOLC_SECRETKEY, }); const requestParam = { // 应用 ID。默认为空,不传则匹配账号下的所有的 AppID。您可以通过调用[获取应用列表](https://www.volcengine.com/docs/508/1213042)的方式获取所需的 AppID。 Appid: "123", // 需要匹配的 App 版本,不传则匹配 App 的所有版本。 AppVer: ["1.2.0"], // 需要匹配的系统类型,不传则匹配非 WEB 端的所有系统。取值如下所示: // <li> iOS </li> // <li> Android </li> // <li> WEB </li> OS: "WEB", // 需要匹配的 SDK 版本,不传则匹配所有版本. SdkVer: ["1.2.0"], // 需要匹配的图片类型,不传则匹配所有图片类型。 // <li> GIF </li> // <li> PNG </li> // <li> JPEG </li> // <li> HEIF </li> // <li> HEIC </li> // <li> WEBP </li> // <li> AWEBP </li> // <li> VVIC </li> // <li> AVIF </li> // <li> AVIS </li> // <li> 其他 </li> ImageType: ["PNG"], // 需要匹配的自定义维度项 。 ExtraDims: [ { // 自定义维度名称。 // note: // 您可以通过调用[获取自定义维度列表](https://www.volcengine.com/docs/508/1213048)来获取。 Dim: "access", // 需要匹配的对应维度值 // note: // 您可以通过调用[获取自定义维度值](https://www.volcengine.com/docs/508/1213050)来获取。 Vals: ["4g"], }, ], // 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 StartTime: "2019-06-27T13:00:00+08:00", // 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 EndTime: "2019-06-27T15:00:00+08:00", // 排序依据,不传或者传空默认按上报量排序。取值如下所示: // <li> Count:按上报量排序 </li> // <li> WidthRatio:按宽比排序 </li> // <li> HeightRatio:按高比排序 </li> OrderBy: "Count", // 是否升序排序,取值如下所示: // <li> true:是,表示升序排序。 </li> // <li> false:(默认)否,表示降序排序。 </li> OrderAsc: "false", }; const res = await imagexService.DescribeImageXExceedResolutionRatioAll( requestParam ); console.log("res", res); } catch (err) { console.error(err); } }