阅读本文,您可以获取 Node SDK 数据监控的接口调用示例,实现快速开发。
说明
本文的调用示例包含接口的部分参数。由于参数间可能存在互斥关系,在调用时,请您参考注释,进行调整。
调用接口前,请先完成 Node SDK 的安装及初始化操作。
本节为您介绍数据监控相关接口的功能和调用示例。
您可以调用 DescribeImageXEdgeRequest 接口查询边缘分发请求次。详细的参数说明可参见 DescribeImageXEdgeRequest 接口文档。
接口调用示例如下所示。
import { imagex } from "@volcengine/openapi"; export async function DescribeImageXEdgeRequestDemo() { 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。支持查询多个服务,传入多个时用英文逗号“,”分割,缺省情况下表示查询所有服务。您可以在 veImageX 控制台的[服务管理](https://console.volcengine.com/imagex/service_manage/)模块或者调用 [GetAllImageServices](https://www.volcengine.com/docs/508/9360) 接口获取服务 ID。 ServiceIds: "s1,s2", // 域名。支持查询多个域名,传入多个时用英文逗号“,”分割,缺省情况下表示查询所有域名。您可以通过调用 [GetServiceDomains](https://www.volcengine.com/docs/508/9379) 获取服务下所有域名信息。 DomainNames: "d1,d2", // 计费区域。支持查询多个区域,传入多个时用英文逗号“,”分割,缺省情况下表示查询所有区域。取值如下所示: // <li> 中国大陆 </li> // <li> 亚太一区 </li> // <li> 亚太二区 </li> // <li> 亚太三区 </li> // <li> 欧洲区 </li> // <li> 北美区 </li> // <li> 南美区 </li> // <li> 中东区 </li> Regions: "中国大陆,北美区", // 客户端国家。支持查询多个国家,传入多个时用英文逗号“,”分割,缺省情况下表示查询所有国家。您可通过调用 [DescribeImageXEdgeRequestRegions](https://www.volcengine.com/docs/508/1209574) 获取 IP 解析后的客户端国家。取值如下所示: // <li> 海外,除中国外全部国家。 </li> // <li> 具体国家取值,如中国、美国。 </li> UserCountry: "中国", // 客户端省份。支持查询多个省份,传入多个时用英文逗号“,”分割,缺省情况下表示查询所有省份。可调用 [DescribeImageXEdgeRequestRegions](https://www.volcengine.com/docs/508/1209574) 获取 IP 解析后的客户端省份。 UserProvince: "北京", // 过滤网络协议。传入多个用英文逗号分割,缺省情况下表示不过滤。取值如下所示: // <li> HTTP </li> // <li> HTTPS </li> Protocols: "HTTP,HTTPS", // 过滤运营商。传入多个用英文逗号分割,缺省情况下表示不过滤。取值如下所示: // <li> 电信 </li> // <li> 联通 </li> // <li> 移动 </li> // <li> 鹏博士 </li> // <li> 教育网 </li> // <li> 广电网 </li> // <li> 其它 </li> Isp: "移动,联通", // 状态码,传入多个时用英文逗号分隔。取值如下所示: // <li> req_cnt:返回所有状态码数据 </li> // <li> 2xx:返回 2xx 状态码汇总数据 </li> // <li> 3xx:返回 3xx 状态码汇总数据 </li> // <li> 4xx:返回 4xx 状态码汇总数据 </li> // <li> 5xx:返回 5xx 状态码汇总数据。 </li> DataTypes: "req_cnt,2xx,3xx", // 需要分组查询的参数,传入多个用英文逗号分割。取值如下所示: // <li> DomainName:域名 </li> // <li> DataType:状态码 </li> GroupBy: "DomainName,DataType", // 获取数据起始时间点。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 // note: // 由于仅支持查询近 93 天的历史数据,则若此刻时间为2011-11-21T16:14:00+08:00,那么您可输入最早的开始时间为2011-08-21T00: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-02T00:00:00+08:00", // 查询数据的时间粒度。单位为秒,缺省时查询StartTime和EndTime时间段全部数据,此时单次查询最大时间跨度为 93 天。支持以下取值: // <li> 60:单次查询最大时间跨度为 6 小时 </li> // <li> 120:单次查询最大时间跨度为 6 小时 </li> // <li> 300:单次查询最大时间跨度为 31 天 </li> // <li> 600:单次查询最大时间跨度为 31 天 </li> // <li> 1200:单次查询最大时间跨度为 31 天 </li> // <li> 1800:单次查询最大时间跨度为 31 天 </li> // <li> 3600:单次查询最大时间跨度为 93 天 </li> // <li> 86400:单次查询最大时间跨度为 93 天 </li> // <li> 604800:单次查询最大时间跨度为 93 天 </li> Interval: "300", // 是否拆分状态码,取值如下所示: // <li> true:拆分 </li> // <li> false:(默认)不拆分 </li> DetailedCode: true, }; const res = await imagexService.DescribeImageXEdgeRequest(requestParam); console.log("res", res); } catch (err) { console.error(err); } }
您可以调用 DescribeImageXEdgeRequestRegions 接口查询边缘分发地区列表。详细的参数说明可参见 DescribeImageXEdgeRequestRegions 接口文档。
接口调用示例如下所示。
import { imagex } from "@volcengine/openapi"; export async function DescribeImageXEdgeRequestRegionsDemo() { 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 = { // 获取数据起始时间点。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。例如2019-06-02T00:00:00+08:00。<br>起始时间与结束时间间隔小于等于 90 天。 StartTime: "2019-06-02T00:00:00+08:00", // 获取数据结束时间点。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。例如2019-06-02T00:00:00+08:00。<br>起始时间与结束时间间隔小于等于 90 天。 EndTime: "2019-06-02T00:00:00+08:00", }; const res = await imagexService.DescribeImageXEdgeRequestRegions( requestParam ); console.log("res", res); } catch (err) { console.error(err); } }
您可以调用 DescribeImageXEdgeRequestBandwidth 接口查询边缘分发带宽用量。详细的参数说明可参见 DescribeImageXEdgeRequestBandwidth 接口文档。
接口调用示例如下所示。
import { imagex } from "@volcengine/openapi"; export async function DescribeImageXEdgeRequestBandwidthDemo() { 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。支持查询多个服务,传入多个时用英文逗号“,”分割,缺省情况下表示查询所有服务。您可以在 veImageX 控制台的[服务管理](https://console.volcengine.com/imagex/service_manage/)模块或者调用 [GetAllImageServices](https://www.volcengine.com/docs/508/9360) 接口获取服务 ID。 ServiceIds: "s1,s2", // 域名。支持查询多个域名,传入多个时用英文逗号“,”分割,缺省情况下表示查询所有域名。您可以通过调用 [GetServiceDomains](https://www.volcengine.com/docs/508/9379) 获取服务下所有域名信息。 DomainNames: "d1,d2", // 计费区域。支持查询多个区域,传入多个时用英文逗号“,”分割,缺省情况下表示查询所有区域。取值如下所示: // <li> 中国大陆 </li> // <li> 亚太一区 </li> // <li> 亚太二区 </li> // <li> 亚太三区 </li> // <li> 欧洲区 </li> // <li> 北美区 </li> // <li> 南美区 </li> // <li> 中东区 </li> Regions: "中国大陆", // 客户端国家。传入多个时用英文逗号作为分割符,缺省情况下表示不过滤。可调用 [DescribeImageXEdgeRequestRegions](https://www.volcengine.com/docs/508/1209574) 获取 IP 解析后的客户端国家。取值如下所示: // <li> 海外,除中国外全部国家。 </li> // <li> 具体国家取值,如中国、美国。 </li> UserCountry: "中国", // 客户端省份。传入多个用英文逗号分割,缺省情况下表示不过滤。可调用 [DescribeImageXEdgeRequestRegions](https://www.volcengine.com/docs/508/1209574) 获取 IP 解析后的客户端省份。 UserProvince: "北京", // 过滤网络协议。传入多个用英文逗号分割,缺省情况下表示不过滤。取值如下所示: // <li> HTTP </li> // <li> HTTPS </li> Protocols: "HTTP,HTTPS", // 过滤运营商。传入多个用英文逗号分割,缺省情况下表示不过滤。取值如下所示: // <li> 电信 </li> // <li> 联通 </li> // <li> 移动 </li> // <li> 鹏博士 </li> // <li> 教育网 </li> // <li> 广电网 </li> // <li> 其它 </li> Isp: "移动,联通", // 分组依据,取值仅支持DomainName。 GroupBy: "DomainName", // 获取数据起始时间点。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 // note: // 由于仅支持查询近 93 天的历史数据,则若此刻时间为2011-11-21T16:14:00+08:00,那么您可输入最早的开始时间为2011-08-21T00: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-02T00:00:00+08:00", // 查询数据的时间粒度。单位为秒,缺省时查询StartTime和EndTime时间段全部数据,此时单次查询最大时间跨度为 93 天。取值如下所示: // <li> 60:单次查询最大时间跨度为 6 小时 </li> // <li> 120:单次查询最大时间跨度为 6 小时 </li> // <li> 300:单次查询最大时间跨度为 31 天 </li> // <li> 600:单次查询最大时间跨度为 31 天 </li> // <li> 1200:单次查询最大时间跨度为 31 天 </li> // <li> 1800:单次查询最大时间跨度为 31 天 </li> // <li> 3600:单次查询最大时间跨度为 93 天 </li> // <li> 86400:单次查询最大时间跨度为 93 天 </li> // <li> 604800:单次查询最大时间跨度为 93 天 </li> Interval: "300", }; const res = await imagexService.DescribeImageXEdgeRequestBandwidth( requestParam ); console.log("res", res); } catch (err) { console.error(err); } }
您可以调用 DescribeImageXEdgeRequestTraffic 接口查询边缘分发流量用量。详细的参数说明可参见 DescribeImageXEdgeRequestTraffic 接口文档。
接口调用示例如下所示。
import { imagex } from "@volcengine/openapi"; export async function DescribeImageXEdgeRequestTrafficDemo() { 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。支持查询多个服务,传入多个时用英文逗号“,”分割,缺省情况下表示查询所有服务。您可以在 veImageX 控制台的[服务管理](https://console.volcengine.com/imagex/service_manage/)模块或者调用 [GetAllImageServices](https://www.volcengine.com/docs/508/9360) 接口获取服务 ID。 ServiceIds: "s1,s2", // 域名。支持查询多个域名,传入多个时用英文逗号“,”分割,缺省情况下表示查询所有域名。您可以通过调用 [GetServiceDomains](https://www.volcengine.com/docs/508/9379) 获取服务下所有域名信息。 DomainNames: "d1,d2", // 区域。支持查询多个区域,传入多个时用英文逗号“,”分割,缺省情况下表示查询所有区域。取值如下所示: // <li> 中国大陆 </li> // <li> 亚太一区 </li> // <li> 亚太二区 </li> // <li> 亚太三区 </li> // <li> 欧洲区 </li> // <li> 北美区 </li> // <li> 南美区 </li> // <li> 中东区 </li> Regions: "中国大陆", // 客户端国家。传入多个时用英文逗号作为分割符,缺省情况下表示不过滤。您可以通过调用 [DescribeImageXEdgeRequestRegions](https://www.volcengine.com/docs/508/1209574) 获取 IP 解析后的客户端国家。取值如下所示: // <li> 海外,除中国外全部国家。 </li> // <li> 具体国家取值,如中国、美国。 </li> UserCountry: "中国", // 客户端省份。传入多个用英文逗号分割,缺省情况下表示不过滤。可调用 [DescribeImageXEdgeRequestRegions](https://www.volcengine.com/docs/508/1209574) 获取 IP 解析后的客户端省份。 UserProvince: "北京", // 过滤网络协议。传入多个用英文逗号分割,缺省情况下表示不过滤。取值如下所示: // <li> HTTP </li> // <li> HTTPS </li> Protocols: "HTTP,HTTPS", // 过滤运营商。传入多个用英文逗号分割,缺省情况下表示不过滤。取值如下所示: // <li> 电信 </li> // <li> 联通 </li> // <li> 移动 </li> // <li> 鹏博士 </li> // <li> 教育网 </li> // <li> 广电网 </li> // <li> 其它 </li> Isp: "移动,联通", // 分组依据,取值仅支持DomainName。 GroupBy: "DomainName", // 获取数据起始时间点。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 // note: // 由于仅支持查询近 93 天的历史数据,则若此刻时间为2011-11-21T16:14:00+08:00,那么您可输入最早的开始时间为2011-08-21T00: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-02T00:00:00+08:00", // 查询数据的时间粒度。单位为秒,缺省时查询StartTime和EndTime时间段全部数据,此时单次查询最大时间跨度为 93 天。取值如下所示: // <li> 60:单次查询最大时间跨度为 6 小时 </li> // <li> 120:单次查询最大时间跨度为 6 小时 </li> // <li> 300:单次查询最大时间跨度为 31 天 </li> // <li> 600:单次查询最大时间跨度为 31 天 </li> // <li> 1200:单次查询最大时间跨度为 31 天 </li> // <li> 1800:单次查询最大时间跨度为 31 天 </li> // <li> 3600:单次查询最大时间跨度为 93 天 </li> // <li> 86400:单次查询最大时间跨度为 93 天 </li> // <li> 604800:单次查询最大时间跨度为 93 天 </li> Interval: "300", }; const res = await imagexService.DescribeImageXEdgeRequestTraffic( requestParam ); console.log("res", res); } catch (err) { console.error(err); } }
您可以调用 DescribeImageXSourceRequest 接口查询回源请求次。详细的参数说明可参见 DescribeImageXSourceRequest 接口文档。
接口调用示例如下所示。
import { imagex } from "@volcengine/openapi"; export async function DescribeImageXSourceRequestDemo() { 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。为空时表示不筛选,支持查询多个服务,使用逗号分隔不同的服务。 // <li> 您可以在 veImageX 控制台[服务管理](https://console.volcengine.com/imagex/service_manage/)页面,在创建好的图片服务中获取服务 ID。 </li> // <li> 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考 [GetAllImageServices](https://www.volcengine.com/docs/508/9360)。 </li> ServiceIds: "s1,s2", // 域名。为空时表示不筛选,支持查询多个域名,不同的域名使用逗号分隔。 // 您可以通过调用 [GetServiceDomains](https://www.volcengine.com/docs/508/9379) 获取服务下所有域名信息。 DomainNames: "d1,d2", // 区域。传入多个时用英文逗号作为分割符,缺省情况下表示查询所有区域。取值如下所示: // <li> 中国大陆 </li> // <li> 亚太一区 </li> // <li> 亚太二区 </li> // <li> 亚太三区 </li> // <li> 欧洲区 </li> // <li> 北美区 </li> // <li> 南美区 </li> // <li> 中东区 </li> Regions: "中国大陆,北美区", // 客户端国家。传入多个时用英文逗号作为分割符,缺省情况下表示不过滤。可调用 [DescribeImageXEdgeRequestRegions](https://www.volcengine.com/docs/508/1209574) 获取 IP 解析后的客户端国家。取值如下所示: // <li> 海外,除中国外全部国家。 </li> // <li> 具体国家取值,如中国、美国。 </li> UserCountry: "中国", // 客户端省份。传入多个用英文逗号分割。缺省情况下表示不过滤。可调用 [DescribeImageXEdgeRequestRegions](https://www.volcengine.com/docs/508/1209574) 获取 IP 解析后的客户端省份。 UserProvince: "北京", // 过滤网络协议。传入多个用英文逗号分割。缺省情况下表示不过滤。取值如下所示: // <li> HTTP </li> // <li> HTTPS </li> Protocols: "HTTP,HTTPS", // 过滤运营商。传入多个用英文逗号分割,缺省情况下表示不过滤。取值如下所示: // <li> 电信 </li> // <li> 联通 </li> // <li> 移动 </li> // <li> 鹏博士 </li> // <li> 教育网 </li> // <li> 广电网 </li> // <li> 其它 </li> Isp: "移动,联通", // 状态码。传入多个时用英文逗号分隔。支持以下取值: // <li> req_cnt:返回所有状态码数据 </li> // <li> 2xx:返回 2xx 状态码汇总数据 </li> // <li> 3xx:返回 3xx 状态码汇总数据 </li> // <li> 4xx:返回 4xx 状态码汇总数据 </li> // <li> 5xx:返回 5xx 状态码汇总数据。 </li> DataTypes: "req_cnt,2xx,3xx", // 需要分组查询的参数。传入多个用英文逗号分割。支持以下取值: // <li> DomainName:域名 </li> // <li> DataType:状态码 </li> GroupBy: "DomainName,DataType", // 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 // note: // 由于仅支持查询近 93 天的历史数据,则若此刻时间为2011-11-21T16:14:00+08:00,那么您可输入最早的开始时间为2011-08-21T00: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-02T00:00:00+08:00", // 查询数据的时间粒度。单位为秒,缺省时查询StartTime和EndTime时间段全部数据,此时单次查询最大时间跨度为 93 天。支持以下取值: // <li> 60:单次查询最大时间跨度为 6 小时 </li> // <li> 120:单次查询最大时间跨度为 6 小时 </li> // <li> 300:单次查询最大时间跨度为 31 天 </li> // <li> 600:单次查询最大时间跨度为 31 天 </li> // <li> 1200:单次查询最大时间跨度为 31 天 </li> // <li> 1800:单次查询最大时间跨度为 31 天 </li> // <li> 3600:单次查询最大时间跨度为 93 天 </li> // <li> 86400:单次查询最大时间跨度为 93 天 </li> // <li> 604800:单次查询最大时间跨度为 93 天 </li> Interval: "300", // 是否拆分状态码。取值如下所示: // <li> true:拆分 </li> // <li> false:(默认)不拆分 </li> DetailedCode: true, }; const res = await imagexService.DescribeImageXSourceRequest(requestParam); console.log("res", res); } catch (err) { console.error(err); } }
您可以调用 DescribeImageXSourceRequestTraffic 接口查询回源流量用量。详细的参数说明可参见 DescribeImageXSourceRequestTraffic 接口文档。
接口调用示例如下所示。
import { imagex } from "@volcengine/openapi"; export async function DescribeImageXSourceRequestTrafficDemo() { 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。为空时表示不筛选,支持查询多个服务,使用逗号分隔不同的服务。 // <li> 您可以在 veImageX 控制台[服务管理](https://console.volcengine.com/imagex/service_manage/)页面,在创建好的图片服务中获取服务 ID。 </li> // <li> 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考 [GetAllImageServices](https://www.volcengine.com/docs/508/9360)。 </li> ServiceIds: "s1,s2", // 域名。为空时表示不筛选,支持查询多个域名,不同的域名使用逗号分隔。 // 您可以通过调用 [GetServiceDomains](https://www.volcengine.com/docs/508/9379) 获取服务下所有域名信息。 DomainNames: "d1,d2", // 区域。传入多个时用英文逗号作为分割符,缺省情况下表示查询所有区域。取值如下所示: // <li> 中国大陆 </li> // <li> 亚太一区 </li> // <li> 亚太二区 </li> // <li> 亚太三区 </li> // <li> 欧洲区 </li> // <li> 北美区 </li> // <li> 南美区 </li> // <li> 中东区 </li> Regions: "中国大陆", // 客户端国家。传入多个时用英文逗号作为分割符,缺省情况下表示不过滤。可调用 [DescribeImageXEdgeRequestRegions](https://www.volcengine.com/docs/508/1209574) 获取 IP 解析后的客户端国家。取值如下所示: // <li> 海外,除中国外全部国家。 </li> // <li> 具体国家取值,如中国、美国。 </li> UserCountry: "中国", // 客户端省份。传入多个用英文逗号分割。缺省情况下表示不过滤。可调用 [DescribeImageXEdgeRequestRegions](https://www.volcengine.com/docs/508/1209574) 获取 IP 解析后的客户端省份。 UserProvince: "北京", // 过滤网络协议。传入多个用英文逗号分割。缺省情况下表示不过滤。取值如下所示: // <li> HTTP </li> // <li> HTTPS </li> Protocols: "HTTP,HTTPS", // 过滤运营商。传入多个用英文逗号分割,缺省情况下表示不过滤。取值如下所示: // <li> 电信 </li> // <li> 联通 </li> // <li> 移动 </li> // <li> 鹏博士 </li> // <li> 教育网 </li> // <li> 广电网 </li> // <li> 其它 </li> Isp: "移动,联通", // 分组依据,仅支持取值DomainName。 GroupBy: "DomainName", // 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 // note: // 由于仅支持查询近 93 天的历史数据,则若此刻时间为2011-11-21T16:14:00+08:00,那么您可输入最早的开始时间为2011-08-21T00: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-02T00:00:00+08:00", // 查询数据的时间粒度。单位为秒,缺省时查询StartTime和EndTime时间段全部数据,此时单次查询最大时间跨度为 93 天。支持以下取值: // <li> 60:单次查询最大时间跨度为 6 小时 </li> // <li> 120:单次查询最大时间跨度为 6 小时 </li> // <li> 300:单次查询最大时间跨度为 31 天 </li> // <li> 600:单次查询最大时间跨度为 31 天 </li> // <li> 1200:单次查询最大时间跨度为 31 天 </li> // <li> 1800:单次查询最大时间跨度为 31 天 </li> // <li> 3600:单次查询最大时间跨度为 93 天 </li> // <li> 86400:单次查询最大时间跨度为 93 天 </li> // <li> 604800:单次查询最大时间跨度为 93 天 </li> Interval: "300", }; const res = await imagexService.DescribeImageXSourceRequestTraffic( requestParam ); console.log("res", res); } catch (err) { console.error(err); } }
您可以调用 DescribeImageXSourceRequestBandwidth 接口查询回源带宽用量。详细的参数说明可参见 DescribeImageXSourceRequestBandwidth 接口文档。
接口调用示例如下所示。
import { imagex } from "@volcengine/openapi"; export async function DescribeImageXSourceRequestBandwidthDemo() { 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。为空时表示不筛选,支持查询多个服务,使用逗号分隔不同的服务。 // <li> 您可以在 veImageX 控制台[服务管理](https://console.volcengine.com/imagex/service_manage/)页面,在创建好的图片服务中获取服务 ID。 </li> // <li> 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考 [GetAllImageServices](https://www.volcengine.com/docs/508/9360)。 </li> ServiceIds: "s1,s2", // 域名。为空时表示不筛选,支持查询多个域名,不同的域名使用逗号分隔。 // 您可以通过调用 [GetServiceDomains](https://www.volcengine.com/docs/508/9379) 获取服务下所有域名信息。 DomainNames: "d1,d2", // 区域。传入多个时用英文逗号作为分割符,缺省情况下表示查询所有区域。取值如下所示: // <li> 中国大陆 </li> // <li> 亚太一区 </li> // <li> 亚太二区 </li> // <li> 亚太三区 </li> // <li> 欧洲区 </li> // <li> 北美区 </li> // <li> 南美区 </li> // <li> 中东区 </li> Regions: "中国大陆", // 客户端国家。传入多个时用英文逗号作为分割符,缺省情况下表示不过滤。可调用 [DescribeImageXEdgeRequestRegions](https://www.volcengine.com/docs/508/1209574) 获取 IP 解析后的客户端国家。取值如下所示: // <li> 海外,除中国外全部国家。 </li> // <li> 具体国家取值,如中国、美国。 </li> UserCountry: "中国", // 客户端省份。传入多个用英文逗号分割。缺省情况下表示不过滤。可调用 [DescribeImageXEdgeRequestRegions](https://www.volcengine.com/docs/508/1209574) 获取 IP 解析后的客户端省份。 UserProvince: "北京", // 过滤网络协议。传入多个用英文逗号分割。缺省情况下表示不过滤。取值如下所示: // <li> HTTP </li> // <li> HTTPS </li> Protocols: "HTTP,HTTPS", // 过滤运营商。传入多个用英文逗号分割,缺省情况下表示不过滤。取值如下所示: // <li> 电信 </li> // <li> 联通 </li> // <li> 移动 </li> // <li> 鹏博士 </li> // <li> 教育网 </li> // <li> 广电网 </li> // <li> 其它 </li> Isp: "移动,联通", // 分组依据,仅支持取值DomainName。 GroupBy: "DomainName", // 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 // note: // 由于仅支持查询近 93 天的历史数据,则若此刻时间为2011-11-21T16:14:00+08:00,那么您可输入最早的开始时间为2011-08-21T00: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-02T00:00:00+08:00", // 查询数据的时间粒度。单位为秒,缺省时查询StartTime和EndTime时间段全部数据,此时单次查询最大时间跨度为 93 天。支持以下取值: // <li> 60:单次查询最大时间跨度为 6 小时 </li> // <li> 120:单次查询最大时间跨度为 6 小时 </li> // <li> 300:单次查询最大时间跨度为 31 天 </li> // <li> 600:单次查询最大时间跨度为 31 天 </li> // <li> 1200:单次查询最大时间跨度为 31 天 </li> // <li> 1800:单次查询最大时间跨度为 31 天 </li> // <li> 3600:单次查询最大时间跨度为 93 天 </li> // <li> 86400:单次查询最大时间跨度为 93 天 </li> // <li> 604800:单次查询最大时间跨度为 93 天 </li> Interval: "300", }; const res = await imagexService.DescribeImageXSourceRequestBandwidth( requestParam ); console.log("res", res); } catch (err) { console.error(err); } }
您可以调用 DescribeImageXMirrorRequestHttpCodeByTime 接口查询镜像回源请求次。详细的参数说明可参见 DescribeImageXMirrorRequestHttpCodeByTime 接口文档。
接口调用示例如下所示。
import { imagex } from "@volcengine/openapi"; export async function DescribeImageXMirrorRequestHttpCodeByTimeDemo() { 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。支持查询多个服务,传入多个时用英文逗号“,”分割,缺省情况下表示查询所有服务。您可以在 veImageX 控制台的[服务管理](https://console.volcengine.com/imagex/service_manage/)模块或者调用 [GetAllImageServices](https://www.volcengine.com/docs/508/9360) 接口获取服务 ID。 ServiceIds: ["s1"], // 域名。支持查询多个域名,传入多个时用英文逗号“,”分割,缺省情况下表示查询所有域名。您可以通过调用 [GetServiceDomains](https://www.volcengine.com/docs/508/9379) 获取服务下所有域名信息。 DomainNames: ["d1"], // 获取数据起始时间点。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。例如2019-06-02T00:00:00+08:00。 // note: // 由于仅支持查询近 93 天的历史数据,则若此刻时间为2011-11-21T16:14:00+08:00,那么您可输入最早的开始时间为2011-08-21T00: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-02T00:00:00+08:00", // 查询数据的时间粒度,单位为秒。缺省时查询StartTime和EndTime时间段全部数据,此时单次查询最大时间跨度为 93 天。取值如下所示: // <li> 60:单次查询最大时间跨度为 6 小时 </li> // <li> 120:单次查询最大时间跨度为 6 小时 </li> // <li> 300:单次查询最大时间跨度为 31 天 </li> // <li> 600:单次查询最大时间跨度为 31 天 </li> // <li> 1200:单次查询最大时间跨度为 31 天 </li> // <li> 1800:单次查询最大时间跨度为 31 天 </li> // <li> 3600:单次查询最大时间跨度为 93 天 </li> // <li> 86400:单次查询最大时间跨度为 93 天 </li> // <li> 604800:单次查询最大时间跨度为 93 天 </li> Interval: "60", // 状态码是否聚合,取值如下所示: // <li> true:聚合 </li> // <li> false:(默认)不聚合 </li> AggregateCode: "true", }; const res = await imagexService.DescribeImageXMirrorRequestHttpCodeByTime( requestParam ); console.log("res", res); } catch (err) { console.error(err); } }
您可以调用 DescribeImageXMirrorRequestHttpCodeOverview 接口查询镜像回源请求次域名明细数据。详细的参数说明可参见 DescribeImageXMirrorRequestHttpCodeOverview 接口文档。
接口调用示例如下所示。
import { imagex } from "@volcengine/openapi"; export async function DescribeImageXMirrorRequestHttpCodeOverviewDemo() { 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。支持查询多个服务,传入多个时用英文逗号“,”分割,缺省情况下表示查询所有服务。您可以在 veImageX 控制台的[服务管理](https://console.volcengine.com/imagex/service_manage/)模块或者调用 [GetAllImageServices](https://www.volcengine.com/docs/508/9360) 接口获取服务 ID。 ServiceIds: ["s1"], // 域名。支持查询多个域名,传入多个时用英文逗号“,”分割,缺省情况下表示查询所有域名。您可以通过调用 [GetServiceDomains](https://www.volcengine.com/docs/508/9379) 获取服务下所有域名信息。 DomainNames: ["d1"], // 获取数据起始时间点。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 // note: // 由于仅支持查询近 93 天的历史数据,则若此刻时间为2011-11-21T16:14:00+08:00,那么您可输入最早的开始时间为2011-08-21T00: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-02T00:00:00+08:00", // 状态码是否聚合,取值如下所示: // <li> true:聚合 </li> // <li> false:(默认)不聚合 </li> AggregateCode: "true", }; const res = await imagexService.DescribeImageXMirrorRequestHttpCodeOverview( requestParam ); console.log("res", res); } catch (err) { console.error(err); } }
您可以调用 DescribeImageXMirrorRequestTraffic 接口查询镜像回源流量。详细的参数说明可参见 DescribeImageXMirrorRequestTraffic 接口文档。
接口调用示例如下所示。
import { imagex } from "@volcengine/openapi"; export async function DescribeImageXMirrorRequestTrafficDemo() { 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。支持查询多个服务,传入多个时用英文逗号“,”分割,缺省情况下表示查询所有服务。您可以在 veImageX 控制台的[服务管理](https://console.volcengine.com/imagex/service_manage/)模块或者调用 [GetAllImageServices](https://www.volcengine.com/docs/508/9360) 接口获取服务 ID。 ServiceIds: ["s1"], // 域名。支持查询多个域名,传入多个时用英文逗号“,”分割,缺省情况下表示查询所有域名。您可以通过调用 [GetServiceDomains](https://www.volcengine.com/docs/508/9379) 获取服务下所有域名信息。 DomainNames: ["d1"], // 获取数据起始时间点。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。例如2019-06-02T00:00:00+08:00。 // note: // 由于仅支持查询近 93 天的历史数据,则若此刻时间为2011-11-21T16:14:00+08:00,那么您可输入最早的开始时间为2011-08-21T00: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-02T00:00:00+08:00", // 查询数据的时间粒度。单位为秒,缺省时查询StartTime和EndTime时间段全部数据,此时单次查询最大时间跨度为 93 天。取值如下所示: // <li> 60:单次查询最大时间跨度为 6 小时 </li> // <li> 120:单次查询最大时间跨度为 6 小时 </li> // <li> 300:单次查询最大时间跨度为 31 天 </li> // <li> 600:单次查询最大时间跨度为 31 天 </li> // <li> 1200:单次查询最大时间跨度为 31 天 </li> // <li> 1800:单次查询最大时间跨度为 31 天 </li> // <li> 3600:单次查询最大时间跨度为 93 天 </li> // <li> 86400:单次查询最大时间跨度为 93 天 </li> // <li> 604800:单次查询最大时间跨度为 93 天 </li> Interval: "60", }; const res = await imagexService.DescribeImageXMirrorRequestTraffic( requestParam ); console.log("res", res); } catch (err) { console.error(err); } }
您可以调用 DescribeImageXMirrorRequestBandwidth 接口查询镜像回源带宽。详细的参数说明可参见 DescribeImageXMirrorRequestBandwidth 接口文档。
接口调用示例如下所示。
import { imagex } from "@volcengine/openapi"; export async function DescribeImageXMirrorRequestBandwidthDemo() { 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。支持查询多个服务,传入多个时用英文逗号“,”分割,缺省情况下表示查询所有服务。您可以在 veImageX 控制台的[服务管理](https://console.volcengine.com/imagex/service_manage/)模块或者调用 [GetAllImageServices](https://www.volcengine.com/docs/508/9360) 接口获取服务 ID。 ServiceIds: ["s1"], // 域名。支持查询多个域名,传入多个时用英文逗号“,”分割,缺省情况下表示查询所有域名。您可以通过调用 [GetServiceDomains](https://www.volcengine.com/docs/508/9379) 获取服务下所有域名信息。 DomainNames: ["d1"], // 获取数据起始时间点。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。例如2019-06-02T00:00:00+08:00。 // note: // 由于仅支持查询近 93 天的历史数据,则若此刻时间为2011-11-21T16:14:00+08:00,那么您可输入最早的开始时间为2011-08-21T00: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-02T00:00:00+08:00", // 查询数据的时间粒度。单位为秒,缺省时查询StartTime和EndTime时间段全部数据,此时单次查询最大时间跨度为 93 天。取值如下所示: // <li> 60:单次查询最大时间跨度为 6 小时 </li> // <li> 120:单次查询最大时间跨度为 6 小时 </li> // <li> 300:单次查询最大时间跨度为 31 天 </li> // <li> 600:单次查询最大时间跨度为 31 天 </li> // <li> 1200:单次查询最大时间跨度为 31 天 </li> // <li> 1800:单次查询最大时间跨度为 31 天 </li> // <li> 3600:单次查询最大时间跨度为 93 天 </li> // <li> 86400:单次查询最大时间跨度为 93 天 </li> // <li> 604800:单次查询最大时间跨度为 93 天 </li> Interval: "60", }; const res = await imagexService.DescribeImageXMirrorRequestBandwidth( requestParam ); console.log("res", res); } catch (err) { console.error(err); } }
您可以调用 DescribeImageXServerQPSUsage 接口查询数据处理服务 QPS 用量。详细的参数说明可参见 DescribeImageXServerQPSUsage 接口文档。
接口调用示例如下所示。
import { imagex } from "@volcengine/openapi"; export async function DescribeImageXServerQPSUsageDemo() { 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。支持查询多个服务,传入多个时用英文逗号“,”分割,缺省情况下表示查询所有服务。您可以在 veImageX 控制台的[服务管理](https://console.volcengine.com/imagex/service_manage/)模块或者调用 [GetAllImageServices](https://www.volcengine.com/docs/508/9360) 接口获取服务 ID。 ServiceIds: "s1,s2", // 获取数据起始时间点。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 // note: // 由于仅支持查询近 93 天的历史数据,则若此刻时间为2011-11-21T16:14:00+08:00,那么您可输入最早的开始时间为2011-08-21T00: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-02T00:00:00+08:00", // 查询数据的时间粒度。单位为秒。缺省时查询StartTime和EndTime时间段全部数据,此时单次查询最大时间跨度为 93 天。取值如下所示: // <li> 1: 单次查询最大时间跨度为 6 小时 </li> // <li> 60:单次查询最大时间跨度为 6 小时 </li> // <li> 120:单次查询最大时间跨度为 6 小时 </li> // <li> 300:单次查询最大时间跨度为 31 天 </li> // <li> 600:单次查询最大时间跨度为 31 天 </li> // <li> 1200:单次查询最大时间跨度为 31 天 </li> // <li> 1800:单次查询最大时间跨度为 31 天 </li> // <li> 3600:单次查询最大时间跨度为 93 天 </li> // <li> 86400:单次查询最大时间跨度为 93 天 </li> // <li> 604800:单次查询最大时间跨度为 93 天 </li> Interval: "300", }; const res = await imagexService.DescribeImageXServerQPSUsage(requestParam); console.log("res", res); } catch (err) { console.error(err); } }