tencentcloud-sdk-nodejs-apm 4.0.341 → 4.0.344

package/src/services/apm/v20210622/apm_models.ts

@@ -15,87 +15,6 @@
  * under the License.
  */
 
-/**
- * 指标列表单元
- */
-export interface ApmMetricRecord {
-  /**
-   * field数组
-   */
-  Fields: Array<ApmField>
-
-  /**
-   * tag数组
-   */
-  Tags: Array<ApmTag>
-}
-
-/**
- * CreateApmInstance返回参数结构体
- */
-export interface CreateApmInstanceResponse {
-  /**
-      * 实例ID
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  InstanceId: string
-
-  /**
-   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
-   */
-  RequestId?: string
-}
-
-/**
- * DescribeServiceOverview请求参数结构体
- */
-export interface DescribeServiceOverviewRequest {
-  /**
-   * 过滤条件
-   */
-  Filters: Array<Filter>
-
-  /**
-   * 指标列表
-   */
-  Metrics: Array<QueryMetricItem>
-
-  /**
-   * 聚合维度
-   */
-  GroupBy: Array<string>
-
-  /**
-   * 排序
-   */
-  OrderBy?: OrderBy
-
-  /**
-   * 实例ID
-   */
-  InstanceId?: string
-
-  /**
-   * 每页大小
-   */
-  Limit?: number
-
-  /**
-   * 开始时间
-   */
-  StartTime?: number
-
-  /**
-   * 分页起始点
-   */
-  Offset?: number
-
-  /**
-   * 结束时间
-   */
-  EndTime?: number
-}
-
 /**
  * apm实例信息
  */
@@ -262,9 +181,9 @@ export interface CreateApmInstanceRequest {
 }
 
 /**
- * DescribeMetricRecords返回参数结构体
+ * DescribeServiceOverview返回参数结构体
  */
-export interface DescribeMetricRecordsResponse {
+export interface DescribeServiceOverviewResponse {
   /**
       * 指标结果集
 注意：此字段可能返回 null，表示取不到有效值。
@@ -278,45 +197,34 @@ export interface DescribeMetricRecordsResponse {
 }
 
 /**
- * DescribeApmAgent返回参数结构体
+ * 查询
  */
-export interface DescribeApmAgentResponse {
-  /**
-      * Agent信息
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  ApmAgent: ApmAgentInfo
-
+export interface QueryMetricItem {
   /**
-   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   * 指标名
    */
-  RequestId?: string
-}
+  MetricName: string
 
-/**
- * 维度（标签）对象
- */
-export interface ApmTag {
   /**
-   * 维度Key(列名，标签Key)
+   * 同比，已弃用，不建议使用
    */
-  Key: string
+  Compare?: string
 
   /**
-   * 维度值（标签值）
+   * 同比，支持多种同比方式
    */
-  Value: string
+  Compares?: Array<string>
 }
 
 /**
- * DescribeServiceOverview返回参数结构体
+ * DescribeApmInstances返回参数结构体
  */
-export interface DescribeServiceOverviewResponse {
+export interface DescribeApmInstancesResponse {
   /**
-      * 指标结果集
+      * apm实例列表
 注意：此字段可能返回 null，表示取不到有效值。
       */
-  Records: Array<ApmMetricRecord>
+  Instances: Array<ApmInstanceDetail>
 
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -325,104 +233,125 @@ export interface DescribeServiceOverviewResponse {
 }
 
 /**
- * DescribeApmInstances返回参数结构体
+ * apm Agent信息
  */
-export interface DescribeApmInstancesResponse {
+export interface ApmAgentInfo {
   /**
-      * apm实例列表
+      * Agent下载地址
 注意：此字段可能返回 null，表示取不到有效值。
       */
-  Instances: Array<ApmInstanceDetail>
+  AgentDownloadURL: string
 
   /**
-   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
-   */
-  RequestId?: string
+      * Collector上报地址
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  CollectorURL: string
+
+  /**
+      * Token信息
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Token: string
+
+  /**
+      * 外网上报地址
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  PublicCollectorURL: string
+
+  /**
+      * 自研VPC上报地址
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  InnerCollectorURL: string
+
+  /**
+      * 内网上报地址(Private Link上报地址)
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  PrivateLinkCollectorURL: string
 }
 
 /**
- * 查询过滤参数
+ * 指标列表单元
  */
-export interface Filter {
-  /**
-   * 过滤方式（=, !=, in）
-   */
-  Type: string
-
+export interface ApmMetricRecord {
   /**
-   * 过滤维度名
+   * field数组
    */
-  Key: string
+  Fields: Array<ApmField>
 
   /**
-   * 过滤值，in过滤方式用逗号分割多个值
+   * tag数组
    */
-  Value: string
+  Tags: Array<ApmTag>
 }
 
 /**
- * DescribeApmAgent请求参数结构体
+ * DescribeServiceOverview请求参数结构体
  */
-export interface DescribeApmAgentRequest {
+export interface DescribeServiceOverviewRequest {
   /**
-   * 实例ID
+   * 过滤条件
    */
-  InstanceId: string
+  Filters: Array<Filter>
 
   /**
-   * 接入方式
+   * 指标列表
    */
-  AgentType?: string
+  Metrics: Array<QueryMetricItem>
 
   /**
-   * 环境
+   * 聚合维度
    */
-  NetworkMode?: string
+  GroupBy: Array<string>
 
   /**
-   * 语言
+   * 排序
    */
-  LanguageEnvironment?: string
-}
+  OrderBy?: OrderBy
 
-/**
- * sql排序字段
- */
-export interface OrderBy {
   /**
-   * 需要排序的字段
+   * 实例ID
    */
-  Key: string
+  InstanceId?: string
 
   /**
-   * 顺序排序/倒序排序
+   * 每页大小
    */
-  Value: string
-}
+  Limit?: number
 
-/**
- * DescribeApmInstances请求参数结构体
- */
-export interface DescribeApmInstancesRequest {
   /**
-   * Tag列表
+   * 开始时间
    */
-  Tags?: Array<ApmTag>
+  StartTime?: number
 
   /**
-   * 搜索实例名
+   * 分页起始点
    */
-  InstanceName?: string
+  Offset?: number
 
   /**
-   * 过滤实例ID
+   * 结束时间
    */
-  InstanceIds?: Array<string>
+  EndTime?: number
+}
 
+/**
+ * DescribeApmAgent返回参数结构体
+ */
+export interface DescribeApmAgentResponse {
   /**
-   * 是否查询官方demo实例
+      * Agent信息
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  ApmAgent: ApmAgentInfo
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
-  DemoInstanceFlag?: number
+  RequestId?: string
 }
 
 /**
@@ -459,6 +388,146 @@ export interface ApmField {
   Key: string
 }
 
+/**
+ * 指标曲线数据
+ */
+export interface Line {
+  /**
+   * 指标名
+   */
+  MetricName: string
+
+  /**
+   * 指标中文名
+   */
+  MetricNameCN: string
+
+  /**
+   * 时间序列
+   */
+  TimeSerial: Array<number>
+
+  /**
+      * 数据序列
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  DataSerial: Array<number>
+
+  /**
+      * 维度列表
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Tags: Array<ApmTag>
+}
+
+/**
+ * Apm通用KV结构
+ */
+export interface APMKVItem {
+  /**
+      * Key值定义
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Key: string
+
+  /**
+      * Value值定义
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Value: string
+}
+
+/**
+ * sql排序字段
+ */
+export interface OrderBy {
+  /**
+   * 需要排序的字段
+   */
+  Key: string
+
+  /**
+   * 顺序排序/倒序排序
+   */
+  Value: string
+}
+
+/**
+ * DescribeMetricRecords返回参数结构体
+ */
+export interface DescribeMetricRecordsResponse {
+  /**
+      * 指标结果集
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Records: Array<ApmMetricRecord>
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * 维度（标签）对象
+ */
+export interface ApmTag {
+  /**
+   * 维度Key(列名，标签Key)
+   */
+  Key: string
+
+  /**
+   * 维度值（标签值）
+   */
+  Value: string
+}
+
+/**
+ * 查询过滤参数
+ */
+export interface Filter {
+  /**
+   * 过滤方式（=, !=, in）
+   */
+  Type: string
+
+  /**
+   * 过滤维度名
+   */
+  Key: string
+
+  /**
+   * 过滤值，in过滤方式用逗号分割多个值
+   */
+  Value: string
+}
+
+/**
+ * DescribeApmAgent请求参数结构体
+ */
+export interface DescribeApmAgentRequest {
+  /**
+   * 实例ID
+   */
+  InstanceId: string
+
+  /**
+   * 接入方式
+   */
+  AgentType?: string
+
+  /**
+   * 环境
+   */
+  NetworkMode?: string
+
+  /**
+   * 语言
+   */
+  LanguageEnvironment?: string
+}
+
 /**
  * DescribeMetricRecords请求参数结构体
  */
@@ -515,79 +584,125 @@ export interface DescribeMetricRecordsRequest {
 }
 
 /**
- * apm Agent信息
+ * DescribeGeneralMetricData请求参数结构体
  */
-export interface ApmAgentInfo {
+export interface DescribeGeneralMetricDataRequest {
   /**
-      * Agent下载地址
-注意：此字段可能返回 null，表示取不到有效值。
+      * 要过滤的维度信息，支持：service.name（服务名）、span.kind（客户端/服务端视角）为维度进行过滤。
+
+span.kind:
+
+       server:服务端视角
+       client:客户端视角
+
+默认为服务端视角进行查询。
       */
-  AgentDownloadURL: string
+  Filters: Array<GeneralFilter>
 
   /**
-      * Collector上报地址
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  CollectorURL: string
+   * 需要查询的指标，不可自定义输入。支持：service_request_count（总请求）、service_duration（平均响应时间）的指标数据。
+   */
+  Metrics: Array<string>
 
   /**
-      * Token信息
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  Token: string
+   * 实例ID
+   */
+  InstanceId: string
 
   /**
-      * 外网上报地址
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  PublicCollectorURL: string
+   * 视图名称
+   */
+  ViewName: string
 
   /**
-      * 自研VPC上报地址
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  InnerCollectorURL: string
+   * 聚合维度，支持：service.name（服务名）、span.kind （客户端/服务端视角）维度进行聚合。
+   */
+  GroupBy?: Array<string>
 
   /**
-      * 内网上报地址(Private Link上报地址)
+   * 起始时间的时间戳，单位为秒，只支持查询2天内最多1小时的指标数据。
+   */
+  StartTime?: number
+
+  /**
+   * 结束时间的时间戳，单位为秒，只支持查询2天内最多1小时的指标数据。
+   */
+  EndTime?: number
+
+  /**
+   * 聚合粒度，单位为秒，最小为60s，即一分钟的聚合粒度；如果为空或0则计算开始时间到截止时间的指标数据，上报其他值会报错。
+   */
+  Period?: number
+}
+
+/**
+ * CreateApmInstance返回参数结构体
+ */
+export interface CreateApmInstanceResponse {
+  /**
+      * 实例ID
 注意：此字段可能返回 null，表示取不到有效值。
       */
-  PrivateLinkCollectorURL: string
+  InstanceId: string
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
 }
 
 /**
- * 查询
+ * 查询过滤参数
  */
-export interface QueryMetricItem {
+export interface GeneralFilter {
   /**
-   * 指标名
+   * 过滤维度名
    */
-  MetricName: string
+  Key: string
 
   /**
-   * 同比，已弃用，不建议使用
+   * 过滤值
    */
-  Compare?: string
+  Value: string
+}
 
+/**
+ * DescribeApmInstances请求参数结构体
+ */
+export interface DescribeApmInstancesRequest {
   /**
-   * 同比，支持多种同比方式
+   * Tag列表
    */
-  Compares?: Array<string>
+  Tags?: Array<ApmTag>
+
+  /**
+   * 搜索实例名
+   */
+  InstanceName?: string
+
+  /**
+   * 过滤实例ID
+   */
+  InstanceIds?: Array<string>
+
+  /**
+   * 是否查询官方demo实例
+   */
+  DemoInstanceFlag?: number
 }
 
 /**
- * Apm通用KV结构
+ * DescribeGeneralMetricData返回参数结构体
  */
-export interface APMKVItem {
+export interface DescribeGeneralMetricDataResponse {
   /**
-      * Key值定义
+      * 指标结果集
 注意：此字段可能返回 null，表示取不到有效值。
       */
-  Key: string
+  Records: Array<Line>
 
   /**
-      * Value值定义
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  Value: string
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
 }

package/tencentcloud/services/apm/v20210622/apm_client.d.ts

@@ -1,19 +1,11 @@
 import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
-import { CreateApmInstanceResponse, DescribeServiceOverviewRequest, CreateApmInstanceRequest, DescribeMetricRecordsResponse, DescribeApmAgentResponse, DescribeServiceOverviewResponse, DescribeApmInstancesResponse, DescribeApmAgentRequest, DescribeApmInstancesRequest, DescribeMetricRecordsRequest } from "./apm_models";
+import { CreateApmInstanceRequest, DescribeServiceOverviewResponse, DescribeApmInstancesResponse, DescribeServiceOverviewRequest, DescribeApmAgentResponse, DescribeMetricRecordsResponse, DescribeApmAgentRequest, DescribeMetricRecordsRequest, DescribeGeneralMetricDataRequest, CreateApmInstanceResponse, DescribeApmInstancesRequest, DescribeGeneralMetricDataResponse } from "./apm_models";
 /**
  * apm client
  * @class
  */
 export declare class Client extends TencentCloudCommon.AbstractClient {
     constructor(clientConfig: TencentCloudCommon.ClientConfig);
-    /**
-     * 业务购买APM实例，调用该接口创建
-     */
-    CreateApmInstance(req: CreateApmInstanceRequest, cb?: (error: string, rep: CreateApmInstanceResponse) => void): Promise<CreateApmInstanceResponse>;
-    /**
-     * 拉取通用指标列表
-     */
-    DescribeMetricRecords(req: DescribeMetricRecordsRequest, cb?: (error: string, rep: DescribeMetricRecordsResponse) => void): Promise<DescribeMetricRecordsResponse>;
     /**
      * APM实例列表拉取
      */
@@ -22,6 +14,19 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      * 获取Apm Agent信息
      */
     DescribeApmAgent(req: DescribeApmAgentRequest, cb?: (error: string, rep: DescribeApmAgentResponse) => void): Promise<DescribeApmAgentResponse>;
+    /**
+       * 获取指标数据通用接口。用户根据需要上送请求参数，返回对应的指标数据。
+  接口调用频率限制为：20次/秒，1200次/分钟。单请求的数据点数限制为1440个。
+       */
+    DescribeGeneralMetricData(req: DescribeGeneralMetricDataRequest, cb?: (error: string, rep: DescribeGeneralMetricDataResponse) => void): Promise<DescribeGeneralMetricDataResponse>;
+    /**
+     * 拉取通用指标列表
+     */
+    DescribeMetricRecords(req: DescribeMetricRecordsRequest, cb?: (error: string, rep: DescribeMetricRecordsResponse) => void): Promise<DescribeMetricRecordsResponse>;
+    /**
+     * 业务购买APM实例，调用该接口创建
+     */
+    CreateApmInstance(req: CreateApmInstanceRequest, cb?: (error: string, rep: CreateApmInstanceResponse) => void): Promise<CreateApmInstanceResponse>;
     /**
      * 服务概览数据拉取
      */