tencentcloud-sdk-nodejs 4.0.1037 → 4.0.1039

package/src/services/monitor/v20180724/monitor_client.ts

@@ -20,6 +20,7 @@ import { ClientConfig } from "../../../common/interface"
 import {
   ModifyAlarmPolicyInfoRequest,
   AlarmPolicyTriggerTask,
+  GetTopNMonitorDataRequest,
   DescribePrometheusRegionsResponse,
   DescribePolicyGroupListResponse,
   DescribePrometheusInstancesOverviewRequest,
@@ -69,6 +70,7 @@ import {
   DescribePrometheusInstanceInitStatusResponse,
   DescribeProductEventListResponse,
   Targets,
+  GetTopNMonitorDataResponse,
   AlarmGroupByItem,
   DescribeAlarmNoticeCallbacksResponse,
   DescribePrometheusInstanceUsageRequest,
@@ -192,6 +194,7 @@ import {
   DescribePrometheusClusterAgentsResponse,
   UpdatePrometheusScrapeJobRequest,
   PrometheusAgentInfo,
+  SingleOrderedDataPoint,
   ServiceDiscoveryItem,
   CreatePrometheusClusterAgentResponse,
   PrometheusAlertAllowTimeRange,
@@ -1392,6 +1395,16 @@ export class Client extends AbstractClient {
     return this.request("UpdateAlertRuleState", req, cb)
   }
 
+  /**
+   * 支持TopN查询，对于给定的监控指标和时间区间，按照指标大小按序返回不同维度组合及数据。
+   */
+  async GetTopNMonitorData(
+    req: GetTopNMonitorDataRequest,
+    cb?: (error: string, rep: GetTopNMonitorDataResponse) => void
+  ): Promise<GetTopNMonitorDataResponse> {
+    return this.request("GetTopNMonitorData", req, cb)
+  }
+
   /**
    * 修改模板内容
    */

package/src/services/monitor/v20180724/monitor_models.ts

@@ -53,6 +53,40 @@ export interface AlarmPolicyTriggerTask {
   TaskConfig: string
 }
 
+/**
+ * GetTopNMonitorData请求参数结构体
+ */
+export interface GetTopNMonitorDataRequest {
+  /**
+   * topN
+   */
+  N: number
+  /**
+   * 起始时间
+   */
+  StartTime: string
+  /**
+   * 截止时间
+   */
+  EndTime: string
+  /**
+   * 实例对象的维度组合，格式为key-value键值对形式的集合。不同类型的实例字段完全不同，如CVM为[{"Name":"InstanceId","Value":"ins-j0hk02zo"}]，Ckafka为[{"Name":"instanceId","Value":"ckafka-l49k54dd"}]，COS为[{"Name":"appid","Value":"1258344699"},{"Name":"bucket","Value":"rig-1258344699"}]。各个云产品的维度请参阅各个产品监控指标文档，对应的维度列即为维度组合的key，value为key对应的值。单请求最多支持批量拉取50个实例的监控数据。
+   */
+  Instances: Array<Instance>
+  /**
+   * 指标名称，如Bwpresourcebandwidthin，仅支持单指标拉取。各个云产品的详细指标说明请参阅各个产品监控指标文档，对应的指标英文名即为MetricName
+   */
+  MetricName: string
+  /**
+   * 命名空间，如QCE/CVM。各个云产品的详细命名空间说明请参阅各个产品监控指标文档
+   */
+  Namespace: string
+  /**
+   * 监控统计周期，如60。默认为取值为60，单位为s。每个指标支持的统计周期不一定相同，各个云产品支持的统计周期请参阅各个产品监控指标文档，对应的统计周期列即为支持的统计周期。
+   */
+  Period?: number
+}
+
 /**
  * DescribePrometheusRegions返回参数结构体
  */
@@ -1476,6 +1510,36 @@ export interface Targets {
   Unknown?: number
 }
 
+/**
+ * GetTopNMonitorData返回参数结构体
+ */
+export interface GetTopNMonitorDataResponse {
+  /**
+   * 指标名
+   */
+  MetricName?: string
+  /**
+   * 统计周期
+   */
+  Period?: number
+  /**
+   * topN
+   */
+  N?: number
+  /**
+   * 排序的监控数据
+   */
+  OrderedDataPoints?: Array<SingleOrderedDataPoint>
+  /**
+   * 返回信息
+   */
+  Msg?: string
+  /**
+   * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * 聚合条件
  */
@@ -4345,6 +4409,32 @@ export interface PrometheusAgentInfo {
   Describe?: string
 }
 
+/**
+ * 单个有序数据点
+ */
+export interface SingleOrderedDataPoint {
+  /**
+   * 实例对象维度组合	
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  Dimensions?: Array<Dimension>
+  /**
+   * 监控数据值
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  Value?: number
+  /**
+   * 监控数据时间戳
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  Timestamp?: number
+  /**
+   * 排序序号
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  Order?: number
+}
+
 /**
  * Prometheus 服务发现信息
  */

package/src/services/rce/v20201103/rce_models.ts

@@ -47,12 +47,10 @@ export interface OutputDescribeNameListFrontFix {
   NameListId?: number
   /**
    * 名单名称
-注意：此字段可能返回 null，表示取不到有效值。
    */
   ListName?: string
   /**
    * 名单类型 [1 黑名单 2 白名单]
-注意：此字段可能返回 null，表示取不到有效值。
    */
   ListType?: number
   /**
@@ -65,7 +63,6 @@ export interface OutputDescribeNameListFrontFix {
   Status?: number
   /**
    * 描述
-注意：此字段可能返回 null，表示取不到有效值。
    */
   Remark?: string
   /**
@@ -82,12 +79,10 @@ export interface OutputDescribeNameListFrontFix {
   EffectCount?: string
   /**
    * 加密类型[0 无需加密 1 MD5加密 2 SHA256加密]
-注意：此字段可能返回 null，表示取不到有效值。
    */
   EncryptionType?: number
   /**
    * 场景Code，all_scene代表全部场景
-注意：此字段可能返回 null，表示取不到有效值。
    */
   SceneCode?: string
 }
@@ -350,22 +345,18 @@ export interface OutputManageMarketingRiskValue {
 当AccountType为2时，对应微信的OpenId/UnionId；
 当AccountType为10004时，对应手机号的MD5值；
 当AccountType为10005时，对应手机号的SHA256值。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   UserId?: string
   /**
    * 操作时间戳，单位秒（对应输入参数）。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   PostTime?: number
   /**
    * 业务参数。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   AssociateAccount?: string
   /**
    * 操作来源的外网IP（对应输入参数）。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   UserIp?: string
   /**
@@ -373,7 +364,6 @@ export interface OutputManageMarketingRiskValue {
 pass：无恶意
 review：低风险，需要人工审核
 reject：高风险，建议拦截
-注意：此字段可能返回 null，表示取不到有效值。
    */
   RiskLevel?: string
   /**
@@ -396,17 +386,14 @@ reject：高风险，建议拦截
 2011: 疑似非常用IP，请求当前请求 IP 非该账号常用 IP。
 2012: 疑似 IP 异常，使用 IDC 机房 IP 或使用代理 IP 或使用恶意 IP 等。
 205: 非公网有效 IP，传进来的 IP 地址为内网 IP 地址或者 IP 保留地址。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   RiskType?: Array<number | bigint>
   /**
    * 设备指纹ID，如果集成了设备指纹，并传入了正确的DeviceToken和Platform，该字段正常输出；如果DeviceToken异常（校验不通过），则会在RiskType中返回"-1"标签，ConstId字段为空；如果没有集成设备指纹ConstId字段默认为空。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   ConstId?: string
   /**
    * 风险扩展数据。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   RiskInformation?: string
 }
@@ -470,37 +457,30 @@ export interface DeleteNameListRequest {
 export interface OutputDescribeUserUsageCnt {
   /**
    * 当前付费模式，0 后付费 1 预付费
-注意：此字段可能返回 null，表示取不到有效值。
    */
   PayMode?: number
   /**
    * 后付费本月使用量
-注意：此字段可能返回 null，表示取不到有效值。
    */
   AfterPayModeThisMonthUsedCnt?: number
   /**
    * 创建时间
-注意：此字段可能返回 null，表示取不到有效值。
    */
   CreateTime?: string
   /**
    * 超出时间
-注意：此字段可能返回 null，表示取不到有效值。
    */
   ExpireTime?: string
   /**
    * 后付费上月使用量
-注意：此字段可能返回 null，表示取不到有效值。
    */
   AfterPayModeLastMonthUsedCnt?: number
   /**
    * 预付费总量
-注意：此字段可能返回 null，表示取不到有效值。
    */
   BeforePayModeTotalUsedCnt?: number
   /**
    * 预付费剩余用量
-注意：此字段可能返回 null，表示取不到有效值。
    */
   BeforePayModeRemainUsedCnt?: number
 }
@@ -525,7 +505,6 @@ export interface DescribeNameListDetailResponse {
 export interface OutputDescribeNameListInfo {
   /**
    * 总数
-注意：此字段可能返回 null，表示取不到有效值。
    */
   Count?: number
   /**
@@ -556,17 +535,14 @@ export interface OutputDescribeNameListFrontFixListData {
   /**
    * 错误码，0 表示成功，非0表示失败错误码。 0：成功 1002：参数错误 4300：未开通服务 6000：系统内部错误
 
-注意：此字段可能返回 null，表示取不到有效值。
    */
   Code?: number
   /**
    * 错误信息
-注意：此字段可能返回 null，表示取不到有效值。
    */
   Message?: string
   /**
    * 黑白名单列表信息
-注意：此字段可能返回 null，表示取不到有效值。
    */
   Value?: OutputDescribeNameListInfo
 }
@@ -727,12 +703,10 @@ export interface OutputManageMarketingRisk {
 1002：参数错误
 4300：未开通服务
 4301：后端未创建对应产品
-注意：此字段可能返回 null，表示取不到有效值。
    */
   Code?: number
   /**
    * UTF-8编码，出错消息。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   Message?: string
   /**
@@ -742,7 +716,6 @@ export interface OutputManageMarketingRisk {
   Value?: OutputManageMarketingRiskValue
   /**
    * 控制台显示的req_id。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   UUid?: string
 }
@@ -945,17 +918,14 @@ SHA256手机号加密方式，使用中国大陆11位手机号进行SHA256加密
 export interface OutputDescribeDataListFrontData {
   /**
    * 错误码，0 表示成功，非0表示失败错误码。 0：成功 1002：参数错误 4300：未开通服务 6000：系统内部错误
-注意：此字段可能返回 null，表示取不到有效值。
    */
   Code?: number
   /**
    * 错误信息
-注意：此字段可能返回 null，表示取不到有效值。
    */
   Message?: string
   /**
    * 黑白名单数据信息
-注意：此字段可能返回 null，表示取不到有效值。
    */
   Value?: OuntputDescribeDataListInfo
 }
@@ -966,12 +936,10 @@ export interface OutputDescribeDataListFrontData {
 export interface OutputDescribeNameListDetailFront {
   /**
    * 错误码，0 表示成功，非0表示失败错误码。 0：成功 1002：参数错误 4300：未开通服务 6000：系统内部错误
-注意：此字段可能返回 null，表示取不到有效值。
    */
   Code?: number
   /**
    * 错误信息
-注意：此字段可能返回 null，表示取不到有效值。
    */
   Message?: string
   /**
@@ -987,52 +955,42 @@ export interface OutputDescribeNameListDetailFront {
 export interface OutputDescribeNameListDetail {
   /**
    * 名单ID
-注意：此字段可能返回 null，表示取不到有效值。
    */
   NameListId?: number
   /**
    * 名单名称
-注意：此字段可能返回 null，表示取不到有效值。
    */
   ListName?: string
   /**
    * 名单类型 [1 黑名单 2 白名单]
-注意：此字段可能返回 null，表示取不到有效值。
    */
   ListType?: number
   /**
    * 数据类型[1 手机号 2 qqOpenId 3 2echatOpenId 4 ip 6 idfa 7 imei]
-注意：此字段可能返回 null，表示取不到有效值。
    */
   DataType?: number
   /**
    * 场景Code
-注意：此字段可能返回 null，表示取不到有效值。
    */
   SceneCode?: string
   /**
    * 名单列表状态 [1 启用 2 停用]
-注意：此字段可能返回 null，表示取不到有效值。
    */
   Status?: number
   /**
    * 描述
-注意：此字段可能返回 null，表示取不到有效值。
    */
   Remark?: string
   /**
    * 创建时间
-注意：此字段可能返回 null，表示取不到有效值。
    */
   CreateTime?: string
   /**
    * 更新时间
-注意：此字段可能返回 null，表示取不到有效值。
    */
   UpdateTime?: string
   /**
    * 加密类型 [0 无需加密，1 MD5加密，2 SHA256加密]
-注意：此字段可能返回 null，表示取不到有效值。
    */
   EncryptionType?: number
 }

package/src/services/redis/v20180412/redis_models.ts

@@ -1051,17 +1051,14 @@ export interface DescribeInstanceZoneInfoResponse {
 export interface Account {
   /**
    * 实例 ID。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   InstanceId?: string
   /**
    * 账号名称。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   AccountName?: string
   /**
    * 账号描述信息。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   Remark?: string
   /**
@@ -1069,14 +1066,12 @@ export interface Account {
 - r：只读。
 - w：只写。
 - rw：读写。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   Privilege?: string
   /**
    * 只读路由策略。
 - master：主节点。
 - replication：从节点。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   ReadonlyPolicy?: Array<string>
   /**
@@ -1084,12 +1079,10 @@ export interface Account {
 - 1：账号变更中。
 - 2：账号有效。
 - 4：账号已删除。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   Status?: number
   /**
    * 创建时间
-注意：此字段可能返回 null，表示取不到有效值。
    */
   CreateTime?: string
 }
@@ -2711,7 +2704,6 @@ export interface InstanceIntegerParam {
   Status?: number
   /**
    * 参数单位
-注意：此字段可能返回 null，表示取不到有效值。
    */
   Unit?: string
 }
@@ -4153,42 +4145,34 @@ export interface StartupInstanceResponse {
 export interface DescribeInstanceDTSInstanceInfo {
   /**
    * 地域 ID。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   RegionId?: number
   /**
    * 实例 ID。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   InstanceId?: string
   /**
    * 仓库ID。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   SetId?: number
   /**
    * 可用区ID。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   ZoneId?: number
   /**
    * 实例类型。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   Type?: number
   /**
    * 实例名称。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   InstanceName?: string
   /**
    * 实例访问地址。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   Vip?: string
   /**
    * 状态。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   Status?: number
 }
@@ -4277,22 +4261,18 @@ export interface AssociateSecurityGroupsResponse {
 export interface LogDeliveryInfo {
   /**
    * 日志投递开启状态，开启：true，关闭：false
-注意：此字段可能返回 null，表示取不到有效值。
    */
   Enabled?: boolean
   /**
    * 日志集ID。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   LogsetId?: string
   /**
    * 日志主题ID。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   TopicId?: string
   /**
    * 日志集所在地域
-注意：此字段可能返回 null，表示取不到有效值。
    */
   LogRegion?: string
 }
@@ -4436,7 +4416,6 @@ export interface Groups {
   GroupId?: string
   /**
    * 复制组名称。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   GroupName?: string
   /**
@@ -4454,12 +4433,10 @@ export interface Groups {
   InstanceCount?: number
   /**
    * 复制组中的实例信息。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   Instances?: Array<Instances>
   /**
    * 备注信息。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   Remark?: string
 }
@@ -4971,12 +4948,10 @@ export interface ModifyParamTemplateRequest {
 export interface AvailableRegion {
   /**
    * 地域
-注意：此字段可能返回 null，表示取不到有效值。
    */
   Region?: string
   /**
    * 可用区信息
-注意：此字段可能返回 null，表示取不到有效值。
    */
   AvailableZones?: Array<string>
 }
@@ -5134,137 +5109,110 @@ export interface InstanceSet {
   SlaveReadWeight?: number
   /**
    * 实例关联的标签信息。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   InstanceTags?: Array<InstanceTagInfo>
   /**
    * 项目名称。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   ProjectName?: string
   /**
    * 是否为免密实例。<ul><li>true：免密实例。</li><li>false：非免密实例。</li></ul>
-注意：此字段可能返回 null，表示取不到有效值。
    */
   NoAuth?: boolean
   /**
    * 客户端连接数。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   ClientLimit?: number
   /**
    * DTS状态（内部参数，用户可忽略）。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   DtsStatus?: number
   /**
    * 分片带宽上限，单位MB。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   NetLimit?: number
   /**
    * 免密实例标识（内部参数，用户可忽略）。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   PasswordFree?: number
   /**
    * 该参数存在命名不规范问题，建议用参数IPv6取代。内部参数，用户可忽略。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   Vip6?: string
   /**
    * 内部参数，用户可忽略。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   IPv6?: string
   /**
    * 实例只读标识（内部参数，用户可忽略）。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   ReadOnly?: number
   /**
    * 内部参数，用户可忽略。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   RemainBandwidthDuration?: string
   /**
    * Redis实例请忽略该参数。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   DiskSize?: number
   /**
    * 监控版本。<ul><li>1m：1分钟粒度监控。目前该监控粒度已下线，具体信息，请参见[云数据库 Redis 1分钟粒度下线公告](https://cloud.tencent.com/document/product/239/80653)。</li><li>5s：5秒粒度监控。</li></ul>
-注意：此字段可能返回 null，表示取不到有效值。
    */
   MonitorVersion?: string
   /**
    * 客户端最大连接数可设置的最小值。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   ClientLimitMin?: number
   /**
    * 客户端最大连接数可设置的最大值。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   ClientLimitMax?: number
   /**
    * 实例的节点详细信息。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   NodeSet?: Array<RedisNodeInfo>
   /**
    * 实例所在的地域信息，比如ap-guangzhou。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   Region?: string
   /**
    * 外网地址。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   WanAddress?: string
   /**
    * 北极星服务地址，内部使用。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   PolarisServer?: string
   /**
    * CDC Redis集群ID。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   RedisClusterId?: string
   /**
    * CDC 集群ID。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   DedicatedClusterId?: string
   /**
    * 产品版本。<ul><li>local：本地盘。</li><li>cloud：云盘版。</li><li>cdc：CDC 集群版本。</li></ul>
-注意：此字段可能返回 null，表示取不到有效值。
    */
   ProductVersion?: string
   /**
    * 实例当前Proxy版本。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   CurrentProxyVersion?: string
   /**
    * 实例当前Cache小版本。如果实例加入全球复制组，显示全球复制的内核版本。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   CurrentRedisVersion?: string
   /**
    * 实例可升级Proxy版本。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   UpgradeProxyVersion?: string
   /**
    * 实例可升级Cache小版本。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   UpgradeRedisVersion?: string
   /**
    * 备份模式：- SecondLevelBackup   秒级备份- NormalLevelBackup    普通备份
-注意：此字段可能返回 null，表示取不到有效值。
    */
   BackupMode?: string
 }
@@ -6619,7 +6567,6 @@ export interface Instances {
   RedisShardSize?: number
   /**
    * 实例的磁盘大小。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   DiskSize?: number
   /**
@@ -6636,12 +6583,10 @@ export interface Instances {
   Vip?: string
   /**
    * 该参数存在命名不规范问题，建议用参数IPv6取代。内部参数，用户可忽略。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   Vip6?: string
   /**
    * 内部参数，用户可忽略。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   IPv6?: string
   /**