tencentcloud-sdk-nodejs-apm 4.0.618 → 4.0.620

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

@@ -23,77 +23,62 @@ export interface ModifyApmInstanceRequest {
    * 实例ID
    */
   InstanceId: string
-
   /**
    * 实例名
    */
   Name: string
-
   /**
    * 标签列表
    */
   Tags?: Array<ApmTag>
-
   /**
    * 实例详情
    */
   Description?: string
-
   /**
    * Trace数据保存时长
    */
   TraceDuration?: number
-
   /**
    * 是否开启计费
    */
   OpenBilling?: boolean
-
   /**
    * 实例上报额度
    */
   SpanDailyCounters?: number
-
   /**
    * 错误率阈值
    */
   ErrRateThreshold?: number
-
   /**
    * 采样率
    */
   SampleRate?: number
-
   /**
    * 是否开启错误采样 0 关 1 开
    */
   ErrorSample?: number
-
   /**
    * 慢请求阈值
    */
   SlowRequestSavedThreshold?: number
-
   /**
    * 是否开启日志功能 0 关 1 开
    */
   IsRelatedLog?: number
-
   /**
    * 日志地域
    */
   LogRegion?: string
-
   /**
    * CLS日志主题ID | ES 索引名
    */
   LogTopicID?: string
-
   /**
    * CLS日志集 | ES集群ID
    */
   LogSet?: string
-
   /**
    * CLS | ES
    */
@@ -105,157 +90,132 @@ export interface ModifyApmInstanceRequest {
  */
 export interface ApmInstanceDetail {
   /**
-      * 存储使用量(MB)
+   * 存储使用量(MB)
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   AmountOfUsedStorage: number
-
   /**
-      * 实例名
+   * 实例名
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   Name: string
-
   /**
-      * 实例所属tag列表
+   * 实例所属tag列表
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   Tags: Array<ApmTag>
-
   /**
    * 实例ID
    */
   InstanceId: string
-
   /**
-      * 创建人Uin
+   * 创建人Uin
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   CreateUin: string
-
   /**
-      * 该实例已上报的服务端应用数量
+   * 该实例已上报的服务端应用数量
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   ServiceCount: number
-
   /**
-      * 日均上报Span数
+   * 日均上报Span数
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   CountOfReportSpanPerDay: number
-
   /**
    * AppId信息
    */
   AppId: number
-
   /**
-      * Trace数据保存时长
+   * Trace数据保存时长
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   TraceDuration: number
-
   /**
-      * 实例描述信息
+   * 实例描述信息
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   Description: string
-
   /**
-      * 实例状态
+   * 实例状态
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   Status: number
-
   /**
-      * 实例所属地域
+   * 实例所属地域
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   Region: string
-
   /**
-      * 实例上报额度
+   * 实例上报额度
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   SpanDailyCounters: number
-
   /**
-      * 实例是否开通计费
+   * 实例是否开通计费
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   BillingInstance: number
-
   /**
-      * 错误率阈值
+   * 错误率阈值
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   ErrRateThreshold: number
-
   /**
-      * 采样率阈值
+   * 采样率阈值
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   SampleRate: number
-
   /**
-      * 是否开启错误采样 0  关 1 开
+   * 是否开启错误采样 0  关 1 开
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   ErrorSample: number
-
   /**
-      * 慢调用保存阈值
+   * 慢调用保存阈值
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   SlowRequestSavedThreshold: number
-
   /**
-      * cls日志所在地域
+   * cls日志所在地域
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   LogRegion: string
-
   /**
-      * 日志来源
+   * 日志来源
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   LogSource: string
-
   /**
-      * 日志功能开关 0 关 | 1 开
+   * 日志功能开关 0 关 | 1 开
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   IsRelatedLog: number
-
   /**
-      * 日志主题ID
+   * 日志主题ID
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   LogTopicID: string
-
   /**
-      * 该实例已上报的客户端应用数量
+   * 该实例已上报的客户端应用数量
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   ClientCount: number
-
   /**
-      * 该实例已上报的总应用数量
+   * 该实例已上报的总应用数量
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   TotalCount: number
-
   /**
-      * CLS日志集 | ES集群ID
+   * CLS日志集 | ES集群ID
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   LogSet: string
-
   /**
-      * Metric数据保存时长
+   * Metric数据保存时长
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   MetricDuration: number
 }
 
@@ -267,22 +227,18 @@ export interface CreateApmInstanceRequest {
    * 实例名
    */
   Name: string
-
   /**
    * 实例描述信息
    */
   Description?: string
-
   /**
    * Trace数据保存时长
    */
   TraceDuration?: number
-
   /**
    * 标签列表
    */
   Tags?: Array<ApmTag>
-
   /**
    * 实例上报额度值
    */
@@ -294,11 +250,10 @@ export interface CreateApmInstanceRequest {
  */
 export interface DescribeServiceOverviewResponse {
   /**
-      * 指标结果集
+   * 指标结果集
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   Records: Array<ApmMetricRecord>
-
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -313,12 +268,10 @@ export interface QueryMetricItem {
    * 指标名
    */
   MetricName: string
-
   /**
    * 同比，已弃用，不建议使用
    */
   Compare?: string
-
   /**
    * 同比，支持多种同比方式
    */
@@ -340,11 +293,10 @@ export interface TerminateApmInstanceRequest {
  */
 export interface DescribeApmInstancesResponse {
   /**
-      * apm实例列表
+   * apm实例列表
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   Instances: Array<ApmInstanceDetail>
-
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -356,39 +308,34 @@ export interface DescribeApmInstancesResponse {
  */
 export interface ApmAgentInfo {
   /**
-      * Agent下载地址
+   * Agent下载地址
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   AgentDownloadURL: string
-
   /**
-      * Collector上报地址
+   * Collector上报地址
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   CollectorURL: string
-
   /**
-      * Token信息
+   * Token信息
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   Token: string
-
   /**
-      * 外网上报地址
+   * 外网上报地址
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   PublicCollectorURL: string
-
   /**
-      * 自研VPC上报地址
+   * 自研VPC上报地址
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   InnerCollectorURL: string
-
   /**
-      * 内网上报地址(Private Link上报地址)
+   * 内网上报地址(Private Link上报地址)
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   PrivateLinkCollectorURL: string
 }
 
@@ -400,7 +347,6 @@ export interface ApmMetricRecord {
    * field数组
    */
   Fields: Array<ApmField>
-
   /**
    * tag数组
    */
@@ -415,42 +361,34 @@ export interface DescribeServiceOverviewRequest {
    * 过滤条件
    */
   Filters: Array<Filter>
-
   /**
    * 指标列表
    */
   Metrics: Array<QueryMetricItem>
-
   /**
    * 聚合维度
    */
   GroupBy: Array<string>
-
   /**
    * 排序
    */
   OrderBy?: OrderBy
-
   /**
    * 实例ID
    */
   InstanceId?: string
-
   /**
    * 每页大小
    */
   Limit?: number
-
   /**
    * 开始时间
    */
   StartTime?: number
-
   /**
    * 分页起始点
    */
   Offset?: number
-
   /**
    * 结束时间
    */
@@ -462,11 +400,10 @@ export interface DescribeServiceOverviewRequest {
  */
 export interface DescribeApmAgentResponse {
   /**
-      * Agent信息
+   * Agent信息
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   ApmAgent: ApmAgentInfo
-
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -478,38 +415,33 @@ export interface DescribeApmAgentResponse {
  */
 export interface ApmField {
   /**
-      * 昨日同比指标值，已弃用，不建议使用
+   * 昨日同比指标值，已弃用，不建议使用
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   CompareVal: string
-
   /**
-      * Compare值结果数组，推荐使用
+   * Compare值结果数组，推荐使用
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   CompareVals: Array<APMKVItem>
-
   /**
-      * 指标值
+   * 指标值
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   Value: number
-
   /**
-      * 指标所对应的单位
+   * 指标所对应的单位
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   Unit: string
-
   /**
    * 请求数
    */
   Key: string
-
   /**
-      * 同环比上周期具体数值
+   * 同环比上周期具体数值
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   LastPeriodValue: Array<APMKV>
 }
 
@@ -521,27 +453,23 @@ export interface Line {
    * 指标名
    */
   MetricName: string
-
   /**
    * 指标中文名
    */
   MetricNameCN: string
-
   /**
    * 时间序列
    */
   TimeSerial: Array<number>
-
   /**
-      * 数据序列
+   * 数据序列
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   DataSerial: Array<number>
-
   /**
-      * 维度列表
+   * 维度列表
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   Tags: Array<ApmTag>
 }
 
@@ -550,15 +478,14 @@ export interface Line {
  */
 export interface APMKVItem {
   /**
-      * Key值定义
+   * Key值定义
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   Key: string
-
   /**
-      * Value值定义
+   * Value值定义
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   Value: string
 }
 
@@ -570,7 +497,6 @@ export interface OrderBy {
    * 需要排序的字段
    */
   Key: string
-
   /**
    * 顺序排序/倒序排序
    */
@@ -582,17 +508,15 @@ export interface OrderBy {
  */
 export interface DescribeMetricRecordsResponse {
   /**
-      * 指标结果集
+   * 指标结果集
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   Records: Array<ApmMetricRecord>
-
   /**
-      * 查询指标结果集条数
+   * 查询指标结果集条数
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   TotalCount: number
-
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -607,7 +531,6 @@ export interface ApmTag {
    * 维度Key(列名，标签Key)
    */
   Key: string
-
   /**
    * 维度值（标签值）
    */
@@ -622,12 +545,10 @@ export interface Filter {
    * 过滤方式（=, !=, in）
    */
   Type: string
-
   /**
    * 过滤维度名
    */
   Key: string
-
   /**
    * 过滤值，in过滤方式用逗号分割多个值
    */
@@ -639,15 +560,14 @@ export interface Filter {
  */
 export interface APMKV {
   /**
-      * Key值定义
+   * Key值定义
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   Key: string
-
   /**
-      * Value值定义
+   * Value值定义
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   Value: number
 }
 
@@ -659,22 +579,18 @@ export interface DescribeApmAgentRequest {
    * 实例ID
    */
   InstanceId: string
-
   /**
    * 接入方式
    */
   AgentType?: string
-
   /**
    * 环境
    */
   NetworkMode?: string
-
   /**
    * 语言
    */
   LanguageEnvironment?: string
-
   /**
    * 上报方式
    */
@@ -689,57 +605,46 @@ export interface DescribeMetricRecordsRequest {
    * 过滤条件
    */
   Filters: Array<Filter>
-
   /**
    * 指标列表
    */
   Metrics: Array<QueryMetricItem>
-
   /**
    * 聚合维度
    */
   GroupBy: Array<string>
-
   /**
    * 排序
    */
   OrderBy?: OrderBy
-
   /**
    * 实例ID
    */
   InstanceId?: string
-
   /**
    * 每页大小
    */
   Limit?: number
-
   /**
    * 开始时间
    */
   StartTime?: number
-
   /**
    * 分页起始点
    */
   Offset?: number
-
   /**
    * 结束时间
    */
   EndTime?: number
-
   /**
    * 业务名称（默认值：taw）
    */
   BusinessName?: string
-
   /**
    * 页码
    */
   PageIndex?: number
-
   /**
    * 页长
    */
@@ -751,7 +656,7 @@ export interface DescribeMetricRecordsRequest {
  */
 export interface DescribeGeneralMetricDataRequest {
   /**
-      * 要过滤的维度信息：
+   * 要过滤的维度信息：
 service_metric视图支持：service.name（服务名）、span.kind（客户端/服务端视角）为维度进行过滤，service.name（服务名）必填。
 span.kind:
 	server:服务端视角
@@ -759,60 +664,51 @@ span.kind:
 默认为服务端视角进行查询。
 runtime_metric视图支持：service.name（服务名）维度进行过滤，service.name（服务名）必填。
 sql_metric视图支持：service.name（服务名）、db.instance（数据库名称）、db.ip（数据库实例ip）维度进行过滤，查询service_slow_sql_count（慢sql）指标时service.name必填，查询sql_duration_avg（耗时）指标时db.instance（数据库名称）必填。
-      */
+   */
   Filters: Array<GeneralFilter>
-
   /**
-      * 需要查询的指标，不可自定义输入。
+   * 需要查询的指标，不可自定义输入。
 service_metric视图支持：service_request_count（总请求）、service_duration（平均响应时间）、service_error_req_rate（平均错误率）、service_slow_call_count（慢调用）、service_error_request_count（异常数量）。
 runtime_metric视图支持：service_gc_full_count（Full GC）。
 sql_metric视图支持：service_slow_sql_count（慢sql）、sql_duration_avg（耗时）。
-      */
+   */
   Metrics: Array<string>
-
   /**
    * 业务系统ID
    */
   InstanceId: string
-
   /**
    * 视图名称，不可自定义输入。支持：service_metric、runtime_metric、sql_metric。
    */
   ViewName: string
-
   /**
-      * 聚合维度：
+   * 聚合维度：
 service_metric视图支持：service.name（服务名）、span.kind （客户端/服务端视角）维度进行聚合，service.name（服务名）必填。
 runtime_metric视图支持：service.name（服务名）维度进行聚合，service.name（服务名）必填。
 sql_metric视图支持：service.name（服务名）、db.statement（sql语句）维度进行聚合，查询service_slow_sql_count（慢sql）时service.name（服务名）必填，查询sql_duration_avg（耗时）指标时service.name（服务名）、db.statement（sql语句）必填。
-      */
+   */
   GroupBy?: Array<string>
-
   /**
    * 起始时间的时间戳，单位为秒，只支持查询2天内最多1小时的指标数据。
    */
   StartTime?: number
-
   /**
    * 结束时间的时间戳，单位为秒，只支持查询2天内最多1小时的指标数据。
    */
   EndTime?: number
-
   /**
    * 聚合粒度，单位为秒，最小为60s，即一分钟的聚合粒度；如果为空或0则计算开始时间到截止时间的指标数据，上报其他值会报错。
    */
   Period?: number
-
   /**
-      * 对查询指标进行排序：
+   * 对查询指标进行排序：
 service_metric视图支持：service_request_count（总请求）、service_duration（平均响应时间）、service_error_req_rate（平均错误率）、service_slow_call_count（慢调用）、service_error_request_count（异常数量）。
 runtime_metric视图支持：service_gc_full_count（Full GC）。
 sql_metric视图支持：service_slow_sql_count（慢sql）、sql_duration_avg（耗时）。
 asc:对查询指标进行升序排序
 desc：对查询指标进行降序排序
-      */
+   */
   OrderBy?: OrderBy
-
   /**
    * 查询指标的限制条数，目前最多展示50条数据，PageSize取值为1-50，上送PageSize则根据PageSize的值展示限制条数。
    */
@@ -824,11 +720,10 @@ desc：对查询指标进行降序排序
  */
 export interface CreateApmInstanceResponse {
   /**
-      * 实例ID
+   * 实例ID
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   InstanceId: string
-
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -853,7 +748,6 @@ export interface GeneralFilter {
    * 过滤维度名
    */
   Key: string
-
   /**
    * 过滤值
    */
@@ -868,17 +762,14 @@ export interface DescribeApmInstancesRequest {
    * Tag列表
    */
   Tags?: Array<ApmTag>
-
   /**
    * 搜索实例名
    */
   InstanceName?: string
-
   /**
    * 过滤实例ID
    */
   InstanceIds?: Array<string>
-
   /**
    * 是否查询官方demo实例
    */
@@ -890,11 +781,10 @@ export interface DescribeApmInstancesRequest {
  */
 export interface DescribeGeneralMetricDataResponse {
   /**
-      * 指标结果集
+   * 指标结果集
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   Records: Array<Line>
-
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */