tencentcloud-sdk-nodejs
Version:
2,680 lines (2,678 loc) • 88.9 kB
TypeScript
/**
* DescribeApmAssociation返回参数结构体
*/
export interface DescribeApmAssociationResponse {
/**
* 关联的产品实例ID
*/
ApmAssociation?: ApmAssociation;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateApmInstance请求参数结构体
*/
export interface CreateApmInstanceRequest {
/**
* 业务系统名
*/
Name: string;
/**
* 业务系统描述信息
*/
Description?: string;
/**
* Trace 数据保存时长(单位:天,默认存储时长为3天)
*/
TraceDuration?: number;
/**
* 业务系统 Tag 列表
*/
Tags?: Array<ApmTag>;
/**
* 业务系统上报额度值,默认赋值为0表示不限制上报额度,已废弃
* @deprecated
*/
SpanDailyCounters?: number;
/**
* 业务系统的计费模式(0=按量付费,1=预付费)
*/
PayMode?: number;
/**
* 是否为免费版业务系统(0=付费版;1=TSF 受限免费版;2=免费版)
*/
Free?: number;
}
/**
* DescribeApmVulnerabilityCount返回参数结构体
*/
export interface DescribeApmVulnerabilityCountResponse {
/**
* 包含漏洞指标以及业务系统个数
*/
VulnerabilityList?: Array<ApmMetricRecord>;
/**
* 总漏洞个数
*/
VulnerabilityCount?: number;
/**
* 严重漏洞个数
*/
ImportantVulnerabilityCount?: number;
/**
* 高危漏洞个数
*/
CriticalVulnerabilityCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeServiceOverview返回参数结构体
*/
export interface DescribeServiceOverviewResponse {
/**
* 指标结果集
*/
Records?: Array<ApmMetricRecord>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 采样配置信息
*/
export interface ApmSampleConfig {
/**
* 实例ID
*/
InstanceKey?: string;
/**
* 服务名
*/
ServiceName?: string;
/**
* 采样名字
*/
SampleName?: string;
/**
* 接口名
*/
OperationName?: string;
/**
* 采样的span数
*/
SpanNum?: number;
/**
* 采样配置开关 0 关 1 开
*/
Status?: number;
/**
* tags数组
注意:此字段可能返回 null,表示取不到有效值。
*/
Tags?: Array<APMKVItem>;
/**
* 采样率
*/
SampleRate?: number;
/**
* 0=精确匹配(默认);1=前缀匹配;2=后缀匹配
注意:此字段可能返回 null,表示取不到有效值。
*/
OperationType?: number;
/**
* 配置Id
注意:此字段可能返回 null,表示取不到有效值。
*/
Id?: number;
}
/**
* DescribeApmSQLInjectionDetail返回参数结构体
*/
export interface DescribeApmSQLInjectionDetailResponse {
/**
* SQL相关维度信息
*/
Tags?: Array<ApmTag>;
/**
* 链路相关信息
*/
Records?: Array<ApmMetricRecord>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 探针有关接口的相关配置
*/
export interface AgentOperationConfigView {
/**
* 当前接口配置是否开启了接口白名单配置
注意:此字段可能返回 null,表示取不到有效值。
*/
RetentionValid?: boolean;
/**
* RetentionValid为false时生效,接口配置中的黑名单配置,配置中的接口不采集
注意:此字段可能返回 null,表示取不到有效值。
*/
IgnoreOperation?: string;
/**
* RetentionValid为true时生效,接口配置中的白名单配置,仅采集配置中的接口
注意:此字段可能返回 null,表示取不到有效值。
*/
RetentionOperation?: string;
}
/**
* 包含了节点的组件数量和健康度数量
*/
export interface SelectorView {
/**
* 组件数量
注意:此字段可能返回 null,表示取不到有效值。
*/
Component?: ComponentTopologyView;
}
/**
* DescribeApmSampleConfig请求参数结构体
*/
export interface DescribeApmSampleConfigRequest {
/**
* 业务系统ID
*/
InstanceId: string;
/**
* 采样规则名
*/
SampleName?: string;
}
/**
* DescribeApmAllVulCount返回参数结构体
*/
export interface DescribeApmAllVulCountResponse {
/**
* 包含漏洞指标以及业务系统个数
*/
VulnerabilityList?: Array<ApmMetricRecord>;
/**
* 总漏洞个数
*/
VulnerabilityCount?: number;
/**
* 严重漏洞个数
*/
ImportantVulnerabilityCount?: number;
/**
* 高危漏洞个数
*/
CriticalVulnerabilityCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeApmSampleConfig返回参数结构体
*/
export interface DescribeApmSampleConfigResponse {
/**
* 采样配置列表
注意:此字段可能返回 null,表示取不到有效值。
*/
ApmSampleConfigs?: Array<ApmSampleConfig>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeServiceOverview请求参数结构体
*/
export interface DescribeServiceOverviewRequest {
/**
* 业务系统 ID
*/
InstanceId: string;
/**
* 指标列表
*/
Metrics: Array<QueryMetricItem>;
/**
* 开始时间(单位:秒)
*/
StartTime: number;
/**
* 结束时间(单位:秒)
*/
EndTime: number;
/**
* 聚合维度
*/
GroupBy: Array<string>;
/**
* 过滤条件
*/
Filters?: Array<Filter>;
/**
* 排序方式
Value 填写:
- asc:对查询指标进行升序排序
- desc:对查询指标进行降序排序
*/
OrderBy?: OrderBy;
/**
* 每页大小
*/
Limit?: number;
/**
* 分页起始点
*/
Offset?: number;
}
/**
* DescribeTopologyNew返回参数结构体
*/
export interface DescribeTopologyNewResponse {
/**
* <p>节点集合</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Nodes?: Array<TopologyNode>;
/**
* <p>边集合</p>
*/
Edges?: Array<TopologyEdgeNew>;
/**
* <p>拓扑图是否有修改</p><p>枚举值:</p><ul><li>0: 拓扑图未修改</li><li>1: 拓扑图已修改</li></ul>
注意:此字段可能返回 null,表示取不到有效值。
*/
TopologyModifyFlag?: number;
/**
* <p>节点数量</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Selectors?: SelectorView;
/**
* <p>节点状态</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
OverviewStats?: OverviewStats;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeOPRAllVulCount返回参数结构体
*/
export interface DescribeOPRAllVulCountResponse {
/**
* 包含漏洞指标以及业务系统个数
*/
VulnerabilityList?: Array<ApmMetricRecord>;
/**
* 总漏洞个数
*/
VulnerabilityCount?: number;
/**
* 严重漏洞个数
*/
ImportantVulnerabilityCount?: number;
/**
* 高危漏洞个数
*/
CriticalVulnerabilityCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyApmApplicationConfig返回参数结构体
*/
export interface ModifyApmApplicationConfigResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeApmServiceMetric返回参数结构体
*/
export interface DescribeApmServiceMetricResponse {
/**
* 应用指标列表
*/
ServiceMetricList?: Array<ApmServiceMetric>;
/**
* 符合筛选条件的应用数
*/
TotalCount?: number;
/**
* 警示异常应用数
*/
WarningErrorCount?: number;
/**
* 应用总数
*/
ApplicationCount?: number;
/**
* 页码
*/
Page?: number;
/**
* 页大小
*/
PageSize?: number;
/**
* 异常应用数
*/
ErrorCount?: number;
/**
* 警示应用数
*/
WarningCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyApmAssociation请求参数结构体
*/
export interface ModifyApmAssociationRequest {
/**
* <p>关联的产品名,当前只支持Prometheus、CKafka</p>
*/
ProductName: string;
/**
* <p>关联关系的状态:// 关联关系状态:1(启用)、2(不启用)</p>
*/
Status: number;
/**
* <p>业务系统ID</p>
*/
InstanceId: string;
/**
* <p>关联的产品实例ID</p>
*/
PeerId?: string;
/**
* <p>CKafka消息主题</p>
*/
Topic?: string;
/**
* <p>Ckafka消息主题</p>
*/
MetricTopic?: string;
}
/**
* DescribeGeneralOTSpanList返回参数结构体
*/
export interface DescribeGeneralOTSpanListResponse {
/**
* <p>总数量</p>
*/
TotalCount?: number;
/**
* <p>Spans字段中包含了链路数据的全部内容,由于数据经过了压缩,需要对结果进行如下三步转换,以还原始的文本。</p><ol><li>将Spans字段中的文本进行 Base64 解码,得到经过压缩后字节数组。</li><li>使用 gzip 对压缩后的字节数组进行解压,得到压缩前的字节数组。</li><li>使用 UTF-8 字符集,将压缩前的字节数组转换为文本。</li></ol>
*/
Spans?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeApmApplicationConfig返回参数结构体
*/
export interface DescribeApmApplicationConfigResponse {
/**
* Apm应用配置
注意:此字段可能返回 null,表示取不到有效值。
*/
ApmAppConfig?: ApmAppConfig;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeApmAssociation请求参数结构体
*/
export interface DescribeApmAssociationRequest {
/**
* 关联的产品名,当前只支持Prometheus
*/
ProductName: string;
/**
* 业务系统名
*/
InstanceId: string;
}
/**
* APM 浮点数类型键值对
*/
export interface APMKV {
/**
* Key 值定义
*/
Key?: string;
/**
* Value 值定义
*/
Value?: number;
}
/**
* 节点位置信息
*/
export interface Position {
/**
* 节点位置横坐标
注意:此字段可能返回 null,表示取不到有效值。
*/
X?: number;
/**
* 节点位置纵坐标
注意:此字段可能返回 null,表示取不到有效值。
*/
Y?: number;
}
/**
* 包含了视图中节点组件类型的数量
*/
export interface ComponentTopologyView {
/**
* 服务纬度的节点数量
注意:此字段可能返回 null,表示取不到有效值。
*/
Service?: number;
/**
* 数据库节点数量
注意:此字段可能返回 null,表示取不到有效值。
*/
Database?: number;
/**
* 消息队列节点数量
注意:此字段可能返回 null,表示取不到有效值。
*/
MQ?: number;
}
/**
* CreateProfileTask请求参数结构体
*/
export interface CreateProfileTaskRequest {
/**
* 应用名称
*/
ServiceName: string;
/**
* APM业务系统ID
*/
InstanceId: string;
/**
* 应用实例(在线)
*/
ServiceInstance: string;
/**
* 事件类型(cpu、alloc)
*/
Event: string;
/**
* 任务持续时长(单位:毫秒),范围限制在5~180秒
*/
Duration: number;
/**
* 执行次数,范围限制在1~100次
*/
AllTimes: number;
/**
* 开始时间戳,0代表从当前开始(单位:秒)
*/
StartTime?: number;
/**
* 任务执行间隔(单位:毫秒),范围限制在10~600秒,不可小于1.5倍的Duration
*/
TaskInterval?: number;
}
/**
* DescribeApmVulnerabilityDetail请求参数结构体
*/
export interface DescribeApmVulnerabilityDetailRequest {
/**
* 秒级时间戳
*/
StartTime: number;
/**
* 秒级时间戳
*/
EndTime: number;
/**
* APM业务系统ID
*/
InstanceId: string;
/**
* 条件过滤,必填service.name, instrumentation.name, version, vul.id
*/
Filters?: Array<Filter>;
}
/**
* DeleteApmSampleConfig返回参数结构体
*/
export interface DeleteApmSampleConfigResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 拓扑图边定义
*/
export interface TopologyEdgeNew {
/**
* 源节点
*/
Source?: string;
/**
* 边ID
*/
Id?: string;
/**
* 边权重
注意:此字段可能返回 null,表示取不到有效值。
*/
Weight?: number;
/**
* 目标节点
*/
Target?: string;
/**
* 响应时间
注意:此字段可能返回 null,表示取不到有效值。
*/
Duration?: number;
/**
* 错误率
注意:此字段可能返回 null,表示取不到有效值。
*/
ErrRate?: number;
/**
* 吞吐量
注意:此字段可能返回 null,表示取不到有效值。
*/
Qps?: number;
/**
* 边类型
注意:此字段可能返回 null,表示取不到有效值。
*/
Type?: string;
/**
* 边颜色
注意:此字段可能返回 null,表示取不到有效值。
*/
Color?: string;
/**
* Sql调用数
注意:此字段可能返回 null,表示取不到有效值。
*/
SqlRequestCount?: number;
/**
* Sql调用错误数
注意:此字段可能返回 null,表示取不到有效值。
*/
SqlErrorRequestCount?: number;
/**
* 边上源节点类型 应用/MQ/DB
*/
SourceComp?: string;
/**
* 边上目标节点类型 应用/MQ/DB
*/
TargetComp?: string;
/**
* 组件间调用次数
*/
ReqCnt?: number;
}
/**
* DescribeApmPrometheusRule请求参数结构体
*/
export interface DescribeApmPrometheusRuleRequest {
/**
* 业务系统ID
*/
InstanceId: string;
}
/**
* CreateApmPrometheusRule返回参数结构体
*/
export interface CreateApmPrometheusRuleResponse {
/**
* <p>指标匹配规则的ID</p>
*/
RuleId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* TerminateApmInstance返回参数结构体
*/
export interface TerminateApmInstanceResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 展示apm业务系统关联prometheus关系返回体
*/
export interface ApmPrometheusRules {
/**
* <p>指标匹配规则ID</p>
*/
Id?: number;
/**
* <p>指标匹配规则名</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Name?: string;
/**
* <p>规则生效的应用。生效于全部应用就传空字符串</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
ServiceName?: string;
/**
* <p>指标匹配规则状态:1(启用)、2(不启用)</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Status?: number;
/**
* <p>指标匹配规则</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
MetricNameRule?: string;
/**
* <p>匹配类型:0精准匹配,1前缀匹配,2后缀匹配</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
MetricMatchType?: number;
/**
* <p>是否追加资源属性</p>
*/
AppendResourceAttributes?: boolean;
}
/**
* 指标列表单元
*/
export interface ApmMetricRecord {
/**
* field数组,用于指标的查询结果
*/
Fields?: Array<ApmField>;
/**
* tag数组,用于区分 Groupby 的对象
*/
Tags?: Array<ApmTag>;
}
/**
* 拓扑图边节点
*/
export interface TopologyNode {
/**
* 错误率
注意:此字段可能返回 null,表示取不到有效值。
*/
ErrRate?: number;
/**
* 节点类型
注意:此字段可能返回 null,表示取不到有效值。
*/
Kind?: string;
/**
* 节点名
*/
Name?: string;
/**
* 节点权重
注意:此字段可能返回 null,表示取不到有效值。
*/
Weight?: number;
/**
* 节点颜色
注意:此字段可能返回 null,表示取不到有效值。
*/
Color?: string;
/**
* 响应时间
注意:此字段可能返回 null,表示取不到有效值。
*/
Duration?: number;
/**
* 吞吐量
注意:此字段可能返回 null,表示取不到有效值。
*/
Qps?: number;
/**
* 节点类型
注意:此字段可能返回 null,表示取不到有效值。
*/
Type?: string;
/**
* 节点ID
*/
Id?: string;
/**
* 节点大小
注意:此字段可能返回 null,表示取不到有效值。
*/
Size?: string;
/**
* 节点是否为组件类型
注意:此字段可能返回 null,表示取不到有效值。
*/
IsModule?: boolean;
/**
* 节点位置信息
注意:此字段可能返回 null,表示取不到有效值。
*/
Position?: Position;
/**
* 节点标签
注意:此字段可能返回 null,表示取不到有效值。
*/
Tags?: Array<ApmTag>;
/**
* 节点是否可以下钻
注意:此字段可能返回 null,表示取不到有效值。
*/
CanDrillDown?: boolean;
/**
* 资源层信息
注意:此字段可能返回 null,表示取不到有效值。
*/
Resource?: Resource;
/**
* 拓扑节点视图名字
*/
NodeView?: string;
/**
* MQ 消费者视角的响应时间 ms
*/
ConsumerDuration?: number;
/**
* MQ 消费者视角的错误率 %
*/
ConsumerErrRate?: number;
/**
* MQ 消费者视角的吞吐量
*/
ConsumerQps?: number;
/**
* 应用 ID
*/
ServiceId?: string;
/**
* 调用次数
*/
ReqCnt?: number;
/**
* 消息队列消费者视角的调用次数
*/
ConsumerReqCnt?: number;
}
/**
* DescribeApmAgent返回参数结构体
*/
export interface DescribeApmAgentResponse {
/**
* Agent 信息
*/
ApmAgent?: ApmAgentInfo;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateApmSampleConfig请求参数结构体
*/
export interface CreateApmSampleConfigRequest {
/**
* 业务系统ID
*/
InstanceId: string;
/**
* 采样率
*/
SampleRate: number;
/**
* 应用名
*/
ServiceName: string;
/**
* 采样规则名
*/
SampleName: string;
/**
* 采样Tags
*/
Tags?: Array<APMKVItem>;
/**
* 接口名
*/
OperationName?: string;
/**
* 0=精确匹配(默认);1=前缀匹配;2=后缀匹配
*/
OperationType?: number;
}
/**
* DescribeTagValues请求参数结构体
*/
export interface DescribeTagValuesRequest {
/**
* 业务系统 ID
*/
InstanceId: string;
/**
* 维度名
*/
TagKey: string;
/**
* 开始时间(单位为秒)
*/
StartTime: number;
/**
* 结束时间(单位为秒)
*/
EndTime: number;
/**
* 过滤条件
*/
Filters?: Array<Filter>;
/**
* Or 过滤条件
*/
OrFilters?: Array<Filter>;
/**
* 使用类型
*/
Type?: string;
}
/**
* apm应用指标信息
*/
export interface ApmServiceMetric {
/**
* filed数组
注意:此字段可能返回 null,表示取不到有效值。
*/
Fields?: Array<ApmField>;
/**
* tag数组
注意:此字段可能返回 null,表示取不到有效值。
*/
Tags?: Array<ApmTag>;
/**
* 应用信息
注意:此字段可能返回 null,表示取不到有效值。
*/
ServiceDetail?: ServiceDetail;
}
/**
* 查询应用配置返回参数
*/
export interface ApmAppConfig {
/**
* <p>实例ID</p>
*/
InstanceKey?: string;
/**
* <p>服务名</p>
*/
ServiceName?: string;
/**
* <p>URL收敛开关</p>
*/
UrlConvergenceSwitch?: number;
/**
* <p>URL收敛阈值</p>
*/
UrlConvergenceThreshold?: number;
/**
* <p>URL收敛正则</p>
*/
UrlConvergence?: string;
/**
* <p>异常过滤正则</p>
*/
ExceptionFilter?: string;
/**
* <p>错误码过滤</p>
*/
ErrorCodeFilter?: string;
/**
* <p>服务组件类型</p>
*/
Components?: string;
/**
* <p>URL排除正则</p>
*/
UrlExclude?: string;
/**
* <p>日志来源</p>
*/
LogSource?: string;
/**
* <p>日志所在地域</p>
*/
LogRegion?: string;
/**
* <p>是否开启日志 0 关 1 开</p>
*/
IsRelatedLog?: number;
/**
* <p>日志主题ID</p>
*/
LogTopicID?: string;
/**
* <p>需过滤的接口名</p>
*/
IgnoreOperationName?: string;
/**
* <p>CLS日志集 | ES集群ID</p>
*/
LogSet?: string;
/**
* <p>探针每秒上报trace数</p>
*/
TraceRateLimit?: number;
/**
* <p>是否开启线程剖析</p>
*/
EnableSnapshot?: boolean;
/**
* <p>线程剖析超时阈值</p>
*/
SnapshotTimeout?: number;
/**
* <p>是否开启agent</p>
*/
AgentEnable?: boolean;
/**
* <p>组件列表</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
InstrumentList?: Array<Instrument>;
/**
* <p>是否开启链路压缩</p>
*/
TraceSquash?: boolean;
/**
* <p>是否开启应用诊断开关</p>
*/
EventEnable?: boolean;
/**
* <p>探针接口相关配置</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
AgentOperationConfigView?: AgentOperationConfigView;
/**
* <p>是否开启应用日志配置</p>
*/
EnableLogConfig?: boolean;
/**
* <p>应用ID</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
ServiceID?: string;
/**
* <p>应用是否开启dashboard配置: false 关(与业务系统保持一致)/true 开(应用级配置)</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
EnableDashboardConfig?: boolean;
/**
* <p>是否关联dashboard: 0 关 1 开</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IsRelatedDashboard?: number;
/**
* <p>dashboard ID</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
DashboardTopicID?: string;
/**
* <p>是否开启应用级别配置</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
EnableSecurityConfig?: boolean;
/**
* <p>是否开启组件漏洞检测</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IsInstrumentationVulnerabilityScan?: number;
/**
* <p>是否开启SQL注入分析</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IsSqlInjectionAnalysis?: number;
/**
* <p>是否开启远程命令执行分析</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IsRemoteCommandExecutionAnalysis?: number;
/**
* <p>是否开启内存马检测分析</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IsMemoryHijackingAnalysis?: number;
/**
* <p>CLS索引类型(0=全文索引,1=键值索引)</p>
*/
LogIndexType?: number;
/**
* <p>traceId的索引key: 当CLS索引类型为键值索引时生效</p>
*/
LogTraceIdKey?: string;
/**
* <p>是否开启删除任意文件检测(0-关闭,1-开启)</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IsDeleteAnyFileAnalysis?: number;
/**
* <p>是否开启读取任意文件检测(0-关闭,1-开启)</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IsReadAnyFileAnalysis?: number;
/**
* <p>是否开启上传任意文件检测(0-关闭,1-开启)</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IsUploadAnyFileAnalysis?: number;
/**
* <p>是否开启包含任意文件检测(0-关闭,1-开启)</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IsIncludeAnyFileAnalysis?: number;
/**
* <p>是否开启目录遍历检测(0-关闭,1-开启)</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IsDirectoryTraversalAnalysis?: number;
/**
* <p>是否开启模板引擎注入检测(0-关闭,1-开启)</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IsTemplateEngineInjectionAnalysis?: number;
/**
* <p>是否开启脚本引擎注入检测(0-关闭,1-开启)</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IsScriptEngineInjectionAnalysis?: number;
/**
* <p>是否开启表达式注入检测(0-关闭,1-开启)</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IsExpressionInjectionAnalysis?: number;
/**
* <p>是否开启JNDI注入检测(0-关闭,1-开启)</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IsJNDIInjectionAnalysis?: number;
/**
* <p>是否开启JNI注入检测(0-关闭,1-开启)</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IsJNIInjectionAnalysis?: number;
/**
* <p>是否开启Webshell后门检测(0-关闭,1-开启)</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IsWebshellBackdoorAnalysis?: number;
/**
* <p>是否开启反序列化检测(0-关闭,1-开启)</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IsDeserializationAnalysis?: number;
/**
* <p>接口名称自动收敛开关(0-关闭,1-开启)</p>
*/
UrlAutoConvergenceEnable?: boolean;
/**
* <p>URL长分段收敛阈值</p>
*/
UrlLongSegmentThreshold?: number;
/**
* <p>URL数字分段收敛阈值</p>
*/
UrlNumberSegmentThreshold?: number;
/**
* <p>探针熔断内存阈值</p>
*/
DisableMemoryUsed?: number;
/**
* <p>探针熔断CPU阈值</p>
*/
DisableCpuUsed?: number;
/**
* <p>是否开启SQL参数获取</p>
*/
DbStatementParametersEnabled?: boolean;
/**
* <p>慢SQL阈值</p>
*/
SlowSQLThresholds?: Array<ApmTag>;
/**
* <p>是否开启脱敏规则</p>
*/
EnableDesensitizationRule?: number;
/**
* <p>脱敏规则</p>
*/
DesensitizationRule?: string;
/**
* <p>spanId的索引key: 当CLS索引类型为键值索引时生效</p>
*/
LogSpanIdKey?: string;
/**
* <p>自动性能剖析配置</p>
*/
AutoProfilingConfig?: AutoProfilingConfig;
/**
* <p>阈值配置开关。true 表示使用应用级阈值;false 表示使用业务系统级阈值</p>
*/
EnableThresholdConfig?: boolean;
/**
* <p>错误率阈值(%),用于判断应用健康状态为"红色"</p>
*/
ErrRateThreshold?: number;
/**
* <p>响应时间预警阈值(ms),用于判断应用健康状态为"黄色"</p>
*/
ResponseDurationWarningThreshold?: number;
/**
* <p>是否默认使用探针自带熔断阈值</p>
*/
UseDefaultFuseConfig?: boolean;
/**
* <p>是否开启自动分析</p>
*/
AnalysisAutoEnable?: boolean;
/**
* <p>头采样开关</p>
*/
EnableHeadSampler?: boolean;
/**
* <p>头采样类型</p><p>枚举值:</p><ul><li>parentbased_traceidratio: 跟随父类型</li></ul>
*/
HeadSamplerType?: string;
/**
* <p>采样阈值,100等于关闭采样,0表示全采样</p>
*/
HeadSamplerArg?: number;
}
/**
* CreateApmSampleConfig返回参数结构体
*/
export interface CreateApmSampleConfigResponse {
/**
* 采样配置参数
*/
ApmSampleConfig?: ApmSampleConfig;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 指标曲线数据
*/
export interface Line {
/**
* 指标名
*/
MetricName?: string;
/**
* 指标中文名
*/
MetricNameCN?: string;
/**
* 时间序列
*/
TimeSerial?: Array<number | bigint>;
/**
* 数据序列
*/
DataSerial?: Array<number>;
/**
* 维度列表
*/
Tags?: Array<ApmTag>;
/**
* 指标数据单位
*/
MetricUnit?: string;
}
/**
* ModifyApmAssociation返回参数结构体
*/
export interface ModifyApmAssociationResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* APM 通用 KV 结构
*/
export interface APMKVItem {
/**
* Key 值定义
*/
Key: string;
/**
* Value 值定义
*/
Value: string;
}
/**
* DescribeGeneralSpanList请求参数结构体
*/
export interface DescribeGeneralSpanListRequest {
/**
* <p>业务系统 ID</p>
*/
InstanceId: string;
/**
* <p>Span 查询开始时间戳(单位:秒)</p>
*/
StartTime: number;
/**
* <p>Span 查询结束时间戳(单位:秒)</p>
*/
EndTime: number;
/**
* <p>通用过滤参数 支持的过滤key如service.name</p>
*/
Filters?: Array<Filter>;
/**
* <p>排序<br>现支持的 Key 有:</p><ul><li>startTime(开始时间)</li><li>endTime(结束时间)</li><li>duration(响应时间)</li></ul><p>现支持的 Value 有:</p><ul><li>desc(降序排序)</li><li>asc(升序排序)</li></ul>
*/
OrderBy?: OrderBy;
/**
* <p>业务自身服务名,控制台用户请填写taw</p>
*/
BusinessName?: string;
/**
* <p>单页项目个数,默认为1000,合法取值范围为1~1000</p>
*/
Limit?: number;
/**
* <p>分页</p>
*/
Offset?: number;
}
/**
* DescribeApmAgent请求参数结构体
*/
export interface DescribeApmAgentRequest {
/**
* 业务系统 ID
*/
InstanceId: string;
/**
* 接入方式,现支持 skywalking, ot, ebpf 方式接入上报,不填默认为 ot
*/
AgentType?: string;
/**
* 上报环境,现支持 pl (内网上报), public (外网), inner (自研 VPC )环境上报,不传默认为 public
*/
NetworkMode?: string;
/**
* 语言,现支持 java, golang, php, python, dotNet, nodejs 语言上报,不传默认为 golang
*/
LanguageEnvironment?: string;
/**
* 上报方式,已弃用
* @deprecated
*/
ReportMethod?: string;
}
/**
* DescribeMetricRecords请求参数结构体
*/
export interface DescribeMetricRecordsRequest {
/**
* <p>业务系统 ID</p>
*/
InstanceId: string;
/**
* <p>指标列表</p>
*/
Metrics: Array<QueryMetricItem>;
/**
* <p>开始时间(单位为秒)</p>
*/
StartTime: number;
/**
* <p>结束时间(单位为秒)</p>
*/
EndTime: number;
/**
* <p>聚合维度</p>
*/
GroupBy: Array<string>;
/**
* <p>过滤条件</p>
*/
Filters?: Array<Filter>;
/**
* <p>Or 过滤条件</p>
*/
OrFilters?: Array<Filter>;
/**
* <p>排序<br>现支持的 Key 有:</p><ul><li>startTime(开始时间)</li><li>endTime(结束时间)</li><li>duration(响应时间)</li></ul><p>现支持的 Value 有:</p><ul><li>desc(降序排序)</li><li>asc(升序排序)</li></ul>
*/
OrderBy?: OrderBy;
/**
* <p>业务名称,控制台用户请填写taw。</p>
*/
BusinessName?: string;
/**
* <p>特殊处理查询结果</p>
*/
Type?: string;
/**
* <p>每页大小,默认为1000,合法取值范围为0~1000</p>
*/
Limit?: number;
/**
* <p>分页起始点</p>
*/
Offset?: number;
/**
* <p>页码</p>
*/
PageIndex?: number;
/**
* <p>页长</p>
*/
PageSize?: number;
/**
* <p>应用Id</p>
*/
ServiceID?: string;
}
/**
* DescribeGeneralMetricData请求参数结构体
*/
export interface DescribeGeneralMetricDataRequest {
/**
* 需要查询的指标名称,不可自定义输入,[详情请见。](https://cloud.tencent.com/document/product/248/101681)
*/
Metrics: Array<string>;
/**
* 业务系统 ID
*/
InstanceId: string;
/**
* 视图名称,不可自定义输入。[详情请见。](https://cloud.tencent.com/document/product/248/101681)
*/
ViewName: string;
/**
* 要过滤的维度信息,不同视图有对应的指标维度,[详情请见。](https://cloud.tencent.com/document/product/248/101681)
*/
Filters: Array<GeneralFilter>;
/**
* 聚合维度,不同视图有对应的指标维度,[详情请见。](https://cloud.tencent.com/document/product/248/101681)
*/
GroupBy?: Array<string>;
/**
* 起始时间的时间戳,支持查询30天内的指标数据。(单位:秒)
*/
StartTime?: number;
/**
* 结束时间的时间戳,支持查询30天内的指标数据。(单位:秒)
*/
EndTime?: number;
/**
* 是否按固定时间跨度聚合,填入1及大于1的值按1处理,不填按0处理。
- 填入0,则计算开始时间到截止时间的指标数据。
- 填入1,则会按照开始时间到截止时间的时间跨度选择聚合粒度:
- 时间跨度 (0,12) 小时,则按一分钟粒度聚合。
- 时间跨度 [12,48] 小时,则按五分钟粒度聚合。
- 时间跨度 (48, +∞) 小时,则按一小时粒度聚合。
*/
Period?: number;
/**
* 对查询指标进行排序:
Key 填写云 API 指标名称,[详情请见。](https://cloud.tencent.com/document/product/248/101681)
Value 填写排序方式:
- asc:对查询指标进行升序排序
- desc:对查询指标进行降序排序
*/
OrderBy?: OrderBy;
/**
* 查询指标的限制条数,目前最多展示50条数据,PageSize取值为1-50,上送PageSize则根据PageSize的值展示限制条数。
*/
PageSize?: number;
}
/**
* ModifyApmPrometheusRule请求参数结构体
*/
export interface ModifyApmPrometheusRuleRequest {
/**
* <p>规则ID</p>
*/
Id: number;
/**
* <p>业务系统ID</p>
*/
InstanceId: string;
/**
* <p>所要修改的规则名</p>
*/
Name?: string;
/**
* <p>规则状态:1(启用)、2(不启用)、3(删除)</p>
*/
Status?: number;
/**
* <p>规则生效的应用。生效于全部应用就传空(这个如果不修改也要传旧的规则)</p>
*/
ServiceName?: string;
/**
* <p>匹配类型:0精准匹配,1前缀匹配,2后缀匹配(这个如果不修改也要传旧的规则)</p>
*/
MetricMatchType?: number;
/**
* <p>客户定义的命中指标名规则。</p>
*/
MetricNameRule?: string;
/**
* <p>是否追加资源属性</p>
*/
AppendResourceAttributes?: boolean;
}
/**
* ModifyApmInstance返回参数结构体
*/
export interface ModifyApmInstanceResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 标签
*/
export interface SpanTag {
/**
* 标签类型
*/
Type: string;
/**
* 标签Key
注意:此字段可能返回 null,表示取不到有效值。
*/
Key: string;
/**
* 标签值
注意:此字段可能返回 null,表示取不到有效值。
*/
Value: string;
}
/**
* DescribeGeneralMetricData返回参数结构体
*/
export interface DescribeGeneralMetricDataResponse {
/**
* 指标结果集
*/
Records?: Array<Line>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 拓扑图应用节点状态
*/
export interface TopologyNodeStats {
/**
* 节点总数
*/
Total?: number;
/**
* 健康节点数量
*/
Healthy?: number;
/**
* 警告节点数量
*/
Warning?: number;
/**
* 异常节点数量
*/
Error?: number;
}
/**
* ModifyApmInstance请求参数结构体
*/
export interface ModifyApmInstanceRequest {
/**
* <p>业务系统 ID</p>
*/
InstanceId: string;
/**
* <p>业务系统名</p>
*/
Name: string;
/**
* <p>Tag 列表</p>
*/
Tags?: Array<ApmTag>;
/**
* <p>业务系统描述</p>
*/
Description?: string;
/**
* <p>Trace 数据保存时长(单位:天)</p>
*/
TraceDuration?: number;
/**
* <p>是否开启计费</p>
*/
OpenBilling?: boolean;
/**
* <p>业务系统上报额度</p>
*/
SpanDailyCounters?: number;
/**
* <p>错误率警示线,当应用的平均错误率超出该阈值时,系统会给出异常提示。</p>
*/
ErrRateThreshold?: number;
/**
* <p>采样率(单位:%)</p>
*/
SampleRate?: number;
/**
* <p>是否开启错误采样(0=关, 1=开)</p>
*/
ErrorSample?: number;
/**
* <p>采样慢调用保存阈值(单位:ms)</p>
*/
SlowRequestSavedThreshold?: number;
/**
* <p>是否开启日志功能(0=关, 1=开)</p>
*/
IsRelatedLog?: number;
/**
* <p>日志地域,开启日志功能后才会生效</p>
*/
LogRegion?: string;
/**
* <p>CLS 日志主题 ID,开启日志功能后才会生效</p>
*/
LogTopicID?: string;
/**
* <p>日志集,开启日志功能后才会生效</p>
*/
LogSet?: string;
/**
* <p>日志源,开启日志功能后才会生效</p>
*/
LogSource?: string;
/**
* <p>用户自定义展示标签列表</p>
*/
CustomShowTags?: Array<string>;
/**
* <p>修改计费模式(1为预付费,0为按量付费)</p>
*/
PayMode?: number;
/**
* <p>响应时间警示线</p>
*/
ResponseDurationWarningThreshold?: number;
/**
* <p>是否免费(0=付费版;1=TSF 受限免费版;2=免费版),默认0</p>
*/
Free?: number;
/**
* <p>是否关联 Dashboard(0=关,1=开)</p>
*/
IsRelatedDashboard?: number;
/**
* <p>关联的 Dashboard ID,开启关联 Dashboard 后才会生效</p>
*/
DashboardTopicID?: string;
/**
* <p>是否开启 SQL 注入检测(0=关,1=开)</p>
*/
IsSqlInjectionAnalysis?: number;
/**
* <p>是否开启组件漏洞检测(0=关,1=开)</p>
*/
IsInstrumentationVulnerabilityScan?: number;
/**
* <p>是否开启远程命令攻击检测</p>
*/
IsRemoteCommandExecutionAnalysis?: number;
/**
* <p>是否开启内存马检测</p>
*/
IsMemoryHijackingAnalysis?: number;
/**
* <p>CLS索引类型(0=全文索引,1=键值索引)</p>
*/
LogIndexType?: number;
/**
* <p>traceId的索引key: 当CLS索引类型为键值索引时生效</p>
*/
LogTraceIdKey?: string;
/**
* <p>是否开启删除任意文件检测(0-关闭,1-开启)</p>
*/
IsDeleteAnyFileAnalysis?: number;
/**
* <p>是否开启读取任意文件检测(0-关闭,1-开启)</p>
*/
IsReadAnyFileAnalysis?: number;
/**
* <p>是否开启上传任意文件检测(0-关闭,1-开启)</p>
*/
IsUploadAnyFileAnalysis?: number;
/**
* <p>是否开启包含任意文件检测(0-关闭,1-开启)</p>
*/
IsIncludeAnyFileAnalysis?: number;
/**
* <p>是否开启目录遍历检测(0-关闭,1-开启)</p>
*/
IsDirectoryTraversalAnalysis?: number;
/**
* <p>是否开启模板引擎注入检测(0-关闭,1-开启)</p>
*/
IsTemplateEngineInjectionAnalysis?: number;
/**
* <p>是否开启脚本引擎注入检测(0-关闭,1-开启)</p>
*/
IsScriptEngineInjectionAnalysis?: number;
/**
* <p>是否开启表达式注入检测(0-关闭,1-开启)</p>
*/
IsExpressionInjectionAnalysis?: number;
/**
* <p>是否开启JNDI注入检测(0-关闭,1-开启)</p>
*/
IsJNDIInjectionAnalysis?: number;
/**
* <p>是否开启JNI注入检测(0-关闭,1-开启)</p>
*/
IsJNIInjectionAnalysis?: number;
/**
* <p>是否开启Webshell后门检测(0-关闭,1-开启)</p>
*/
IsWebshellBackdoorAnalysis?: number;
/**
* <p>是否开启反序列化检测(0-关闭,1-开启)</p>
*/
IsDeserializationAnalysis?: number;
/**
* <p>URL长分段收敛阈值</p>
*/
UrlLongSegmentThreshold?: number;
/**
* <p>URL数字分段收敛阈值</p>
*/
UrlNumberSegmentThreshold?: number;
/**
* <p>spanId的索引key: 当CLS索引类型为键值索引时生效</p>
*/
LogSpanIdKey?: string;
/**
* <p>是否开启探针头采样</p><p>(受限)</p>
*/
EnableHeadSampler?: boolean;
/**
* <p>头采类型</p><p>枚举值:</p><ul><li>parentbased_traceidratio: 默认</li></ul><p>(受限)</p>
*/
HeadSamplerType?: string;
/**
* <p>头采采样率</p><p>取值范围:[0, 100]</p><p>(受限)</p>
*/
HeadSamplerArg?: number;
/**
* <p>是否禁用 AI 能力</p><p>单位:无</p>
*/
DisableAiAbility?: number;
}
/**
* Span日志部分
*/
export interface SpanLog {
/**
* 日志时间戳
*/
Timestamp: number;
/**
* 标签
*/
Fields: Array<SpanTag>;
}
/**
* 查询
*/
export interface QueryMetricItem {
/**
* 指标名
*/
MetricName: string;
/**
* 同比,现支持 CompareByYesterday (与昨天相比)和CompareByLastWeek (与上周相比)
*/
Compares?: Array<string>;
/**
* 同比,已弃用,不建议使用
*/
Compare?: string;
}
/**
* 应用详细信息
*/
export interface ServiceDetail {
/**
* <p>应用ID</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
ServiceID?: string;
/**
* <p>业务系统ID</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceKey?: string;
/**
* <p>用户appid</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
AppID?: number;
/**
* <p>主账号uin</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
CreateUIN?: string;
/**
* <p>应用名</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
ServiceName?: string;
/**
* <p>应用描述</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
ServiceDescription?: string;
/**
* <p>地域</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Region?: string;
/**
* <p>标签</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Tags?: Array<ApmTag>;
/**
* <p>业务系统名称</p>
*/
InstanceName?: string;
/**
* <p>阈值配置开关。true 表示使用应用级阈值;false 表示使用业务系统级阈值</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
EnableThresholdConfig?: boolean;
/**
* <p>错误率阈值(%),用于判断应用健康状态为"红色"</p><p>单位:%</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
ErrRateThreshold?: number;
/**
* <p>响应时间预警阈值(ms),用于判断应用健康状态为"黄色"</p><p>单位:ms</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
ResponseDurationWarningThreshold?: number;
}
/**
* DescribeApmInstances返回参数结构体
*/
export interface DescribeApmInstancesResponse {
/**
* <p>APM 业务系统列表</p>
*/
Instances?: Array<ApmInstanceDetail>;
/**
* <p>总数</p><p>单位:个</p>
*/
TotalCount?: number;
/**
* <p>页码,从1开始 </p><p>单位:页</p>
*/
PageIndex?: number;
/**
* <p>每页数量,默认20,最大100</p><p>单位:个</p>
*/
PageSize?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeApmPrometheusRule返回参数结构体
*/
export interface DescribeApmPrometheusRuleResponse {
/**
* 指标匹配规则
*/
ApmPrometheusRules?: Array<ApmPrometheusRules>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyApmSampleConfig返回参数结构体
*/
export interface ModifyApmSampleConfigResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeApmApplicationConfig请求参数结构体
*/
export interface DescribeApmApplicationConfigRequest {
/**
* 实例ID
*/
InstanceId: string;
/**
* 服务名称
*/
ServiceName: string;
}
/**
* CreateProfileTask返回参数结构体
*/
export interface CreateProfileTaskResponse {
/**
* 任务ID
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeApmVulnerabilityDetail返回参数结构体
*/
export interface DescribeApmVulnerabilityDetailResponse {
/**
* 漏洞详情
*/
Tags?: Array<ApmTag>;
/**
* 漏洞相关业务系统列表
*/
ServiceInstanceList?: Array<ApmVulnerabilityServiceDetail>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyApmPrometheusRule返回参数结构体
*/
export interface ModifyApmPrometheusRuleResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeMetricRecords返回参数结构体
*/
export interface DescribeMetricRecordsResponse {
/**
* <p>指标结果集</p>
*/
Records?: Array<ApmMetricRecord>;
/**
* <p>查询指标结果集条数</p>
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 维度(标签)对象
*/
export interface ApmTag {
/**
* 维度Key(列名,标签Key)
*/
Key: string;
/**
* 维度值(标签值)
*/
Value: string;
}
/**
* DescribeApmSQLInjectionDetail请求参数结构体
*/
export interface DescribeApmSQLInjectionDetailRequest {
/**
* 业务系统 ID
*/
InstanceId: string;
/**
* 限制
*/
Limit?: number;
/**
* 偏移量
*/
Offset?: number;
/**
* 秒级时间戳
*/
StartTime?: number;
/**
* 秒级时间戳
*/
EndTime?: number;
/**
* 排序
*/
OrderBy?: OrderBy;
/**
* 查询过滤条件
*/
Filters?: Array<Filter>;
/**
* 聚合维度
*/
GroupBy?: Array<string>;
/**
* 指标列表
*/
Metrics?: Array<QueryMetricItem>;
}
/**
* 查询过滤参数
*/
export interface Filter {
/**
* <p>过滤方式(=, !=, in)</p>
*/
Type: string;
/**
* <p>过滤维度名</p><p>详情参考实际接口字段描述</p>
*/
Key: string;
/**
* <p>过滤值,in过滤方式用逗号分割多个值</p>
*/
Value: string;
}
/**
* DescribeGeneralOTSpanList请求参数结构体
*/
export interface DescribeGeneralOTSpanListRequest {
/**
* <p>业务系统 ID</p>
*/
InstanceId: string;
/**
* <p>Span 查询开始时间戳(单位:秒)</p>
*/
StartTime: number;
/**
* <p>Span 查询结束时间戳(单位:秒)</p>
*/
EndTime: number;
/**
* <p>通用过滤参数 支持的过滤key如service.name</p>
*/
Filters?: Array<Filter>;
/**
* <p>排序<br>现支持的 Key 有:</p><ul><li>startTime(开始时间)</li><li>endTime(结束时间)</li><li>duration(响应时间)</li></ul><p>现支持的 Value 有:</p><ul><li>desc(降序排序)</li><li>asc(升序排序)</li></ul>
*/
OrderBy?: OrderBy;
/**
* <p>业务自身服务名,控制台用户请填写taw</p>
*/
BusinessName?: string;
/**
* <p>单页项目个数,默认为10000,合法取值范围为0~10000</p>
*/
Limit?: number;
/**
* <p>分页</p>
*/
Offset?: number;
}
/**
* 自动性能剖析配置
*/
export interface AutoProfilingConfig {
/**
* 自动CPU剖析任务开关
*/
CpuProfilingEnable?: boolean;
/**
* 自动内存剖析任务开关
*/
MemoryProfilingEnable?: boolean;
/**
* 自动CPU剖析任务阈值
*/
CpuProfilingThreshold?: number;
/**
* 自动内存剖析任务阈值
*/
MemoryProfilingThreshold?: number;
/**
* CPU自动剖析任务时长
*/
CpuProfilingDuration?: number;
/**
* 内存自动剖析任务时长
*/
MemoryProfilingDuration?: number;
}
/**
* DescribeGeneralApmApplicationConfig返回参数结构体
*/
export interface DescribeGeneralApmApplicationConfigResponse {
/**
* 应用配置项
*/
ApmApplicationConfigView?: ApmApplicationConfigView;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateApmInstance返回参数结构体
*/
export interface CreateApmInstanceResponse {
/**
* 业务系统 ID
*/
InstanceId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* APM应用实例漏洞相关信息
*/
export interface ApmVulnerabilityServiceDetail {
/**
* 应用实例
注意:此字段可能返回 null,表示取不到有效值。
*/
ServiceInstance?: string;
/**
* 漏洞所在jar包路径
注意:此字段可能返回 null,表示取不到有效值。
*/
Path?: string;
/**
* 最近发生时间
注意:此字段可能返回 null,表示取不到有效值。
*/
LastOccurTime?: number;
}
/**
* DescribeGeneralApmApplicationConfig请求参数结构体
*/
export interface DescribeGeneralApmApplicationConfigRequest {
/**
* 应用名
*/
ServiceName: string;
/**
* 业务系统ID
*/
InstanceId: string;
}
/**
* DescribeTopologyNew请求参数结构体
*/
export interface DescribeTopologyNewRequest {
/**
* <p>业务系统 ID</p>
*/
InstanceId: string;
/**
* <p>查询开始时间</p>
*/
StartTime: number;
/**
* <p>查询结束时间</p>
*/
EndTime: number;
/**
* <p>应用名</p>
*/
ServiceName?: string;
/**
* <p>上游层级</p>
*/
UpLevel?: number;
/**
* <p>应用实例信息</p>
*/
ServiceInstance?: string;
/**
* <p>下游层级</p>
*/
DownLevel?: number;
/**
* <p>视角</p>
*/
View?: string;
/**
* <p>过滤器</p>
*/
Filters?: Array<Filter>;
/**
* <p>表示Topic(MQ拓扑图用)</p>
*/
Topic?: string;
/**
* <p>视图筛选列表</p>
*/
Selectors?: Selectors;
/**
* <p>视图ID</p>
*/
Id?: string;
/**
* <p>TraceID</p>
*/
TraceID?: string;
/**
* <p>查询top5慢响应节点</p>
*/
IsSlowTopFive?: boolean;
/**
* <p>是否获取资源层信息</p>
*/
GetResource?: boolean;
/**
* <p>根据应用标签过滤</p>
*/
Tags?: Array<ApmTag>;
/**
* <p>不显示的节点类型</p>
*/
Hidden?: Selectors;
/**
* <p>是否开启云资源关联</p>
*/
EnableResourceLink?: boolean;
}
/**
* DescribeApmInstances请求参数结构体
*/
export interface DescribeApmInstancesRequest {
/**
* <p>Tag 列表</p>
*/
Tags?: Array<ApmTag>;
/**
* <p>按业务系统名过滤,支持模糊检索</p>
*/
InstanceName?: string;
/**
* <p>按业务系统 ID 过滤,支持模糊检索</p>
*/
InstanceId?: string;
/**
* <p>按业务系统 ID 过滤</p>
*/
InstanceIds?: Array<string>;
/**
* <p>是否查询官方 Demo 业务系统(0=非 Demo 业务系统,1=Demo 业务系统,默认为0)</p>
*/
DemoInstanceFlag?: number;
/**
* <p>是否查询全地域业务系统(0=不查询全地域,1=查询全地域,默认为0)</p>
*/
AllRegionsFlag?: number;
/**
* <p>页码,从1开始</p><p>单位:页</p>
*/
PageIndex?: number;
/**
* <p>每页数量,默认20,最大100</p><p>单位:个</p>
*/
PageSize?: number;
/**
* <p>搜索参数(OR 匹配 Name / InstanceKey)</p>
*/
Keyword?: string;
/**
* <p>排序类型:ASC | DESC</p>
*/
OrderDirection?: string;
/**
* <p>排序字段:ServiceCount / TotalCount</p>
*/
OrderBy?: string;
}
/**
* DeleteApmSampleConfig请求参数结构体
*/
export interface DeleteApmSampleConfigRequest {
/**
* 业务系统ID
*/
InstanceId: string;
/**
* 采样规则名
*/
SampleName: string;
}
/**
* DescribeApmVulnerabilityCount请求参数结构体
*/
export interface DescribeApmVulnerabilityCountRequest {
/**
* APM业务系统ID
*/
InstanceId: string;
/**
* APM应用名称
*/
ServiceName: string;
/**
* 秒级时间戳
*/
StartTime: number;
/**
* 秒级时间戳
*/
EndTime?: number;
/**
* 查询的数据类型,攻击检测为“attack_detect”
*/
Type?: string;
}
/**
* ModifyApmSampleConfig请求参数结构体
*/
export interface ModifyApmSampleConfigRequest {
/**
* 业务系统ID
*/
InstanceId: string;
/**
* 采样规则名
*/
SampleName: string;
/**
* 采样率
*/
SampleRate: number;
/**
* 应用名,生效于所有应用则填空
*/
ServiceName?: string;
/**
* 接口名
*/
OperationName?: string;
/**
* 采样tag
*/
Tags?: Array<APMKVItem>;
/**
* 采样开关 0关 1开 2删除
*/
Status?: number;
/**
* 配置Id
*/
Id?: number;
/**
* 0=精确匹配(默认);1=前缀匹配;2=后缀匹配
*/
OperationType?: number;
}
/**
* TerminateApmInstance请求参数结构体
*/
export interface TerminateApmInstanceRequest {
/**
* 业务系统ID
*/
InstanceId: string;
}
/**
* APM 业务系统信息
*/
export interface ApmInstanceDetail {
/**
* <p>业务系统 ID</p>
*/
InstanceId?: string;
/**
* <p>业务系统名</p>
*/
Name?: string;
/**
* <p>业务系统描述信息</p>
*/
Description?: string;
/**
* <p>业务系统状态。{<br>1: 初始化中; 2: 运行中; 4: 限流}</p>
*/
Status?: number;
/**
* <p>业务系统所属地域</p>
*/
Region?: string;
/**
* <p>业务系统 Tag 列表</p>
*/
Tags?: Array<ApmTag>;
/**
* <p>AppID 信息</p>
*/
AppId?: number;
/**
* <p>创建人 Uin</p>
*/
CreateUin?: string;
/**
* <p>存储使用量(单位:MB)</p>
*/
AmountOfUsedStorage?: number;
/**
* <p>该业务系统服务端应用数量</p>
*/
ServiceCount?: number;
/**
* <p>日均上报 Span 数</p>
*/
CountOfReportSpanPerDay?: number;
/**
* <p>Trace 数据保存时长(单位:天)</p>
*/
TraceDuration?: number;
/**
* <p>业务系统上报额度</p>
*/
SpanDailyCounters?: number;
/**
* <p>业务系统是否已开通计费(0=未开通,1=已开通)</p>
*/
BillingInstance?: number;
/**
* <p>错误警示线(单位:%)</p>
*/
ErrRateThreshold?: number;
/**
* <p>采样率(单位:%)</p>
*/
SampleRate?: number;
/**
* <p>是否开启错误采样(0=关, 1=开)</p>
*/
ErrorSample?: number;
/**
* <p>采样慢调用保存阈值(单位:ms)</p>
*/
SlowRequestSavedThreshold?: number;
/**
* <p>CLS 日志所在地域</p>
*/
LogRegion?: string;
/**
* <p>日志源</p>
*/
LogSource?: string;
/**
* <p>日志功能开关(0=关, 1=开)</p>
*/
IsRelatedLog?: number;
/**
* <p>日志主题 ID</p>
*/
LogTopicID?: string;
/**
* <p>该业务系统客户端应用数量</p>
*/
ClientCount?: number;
/**
* <p>该业务系统最近2天活跃应用数量</p>
*/
TotalCount?: number;
/**
* <p>CLS 日志集</p>
*/
LogSet?: string;
/**
* <p>Metric 数据保存时长(单位:天)</p>
*/
MetricDuration?: number;
/**
* <p>用户自定义展示标签列表</p>
*/
CustomShowTags?: Array<string>;
/**
* <p>业务系统计费模式(1为预付费,0为按量付费)</p>
*/
PayMode?: number;
/**
* <p>业务系统计费模式是否生效</p>
*/
PayModeEffective?: boolean;
/**
* <p>响应时间警示线(单位:ms)</p>
*/
ResponseDurationWarningThreshold?: number;
/**
* <p>是否免费(0=否,1=限额免费,2=完全免费),默认0</p>
*/
Free?: number;
/**
* <p>是否 TSF 默认业务系统(0=否,1=是)</p>
*/
DefaultTSF?: number;
/**
* <p>是否关联 Dashboard(0=关, 1=开)</p>
*/
IsRelatedDashboard?: number;
/**
* <p>关联的 Dashboard ID</p>
*/
DashboardTopicID?: string;
/**
* <p>是否开启组件漏洞检测(0=关, 1=开)</p>
*/
IsInstrumentationVulnerabilityScan?: number;
/**
* <p>是否开启 SQL 注入分析(0=关, 1=开)</p>
*/
IsSqlInjectionAnalysis?: number;
/**
* <p>限流原因。{<br>1: 正式版限额;<br>2: 试用版限额;<br>4: 试用版到期;<br>8: 账号欠费<br>}</p>
*/
StopReason?: number;
/**
* <p>是否开远程命令执行检测(0=关, 1=开)</p>
*/
IsRemoteCommandExecutionAnalysis?: number;
/**
* <p>是否开内存马执行检测(0=关, 1=开)</p>
*/
IsMemoryHijackingAnalysis?: number;
/**
* <p>CLS索引类型(0=全文索引,1=键值索引)</p>
*/
LogIndexType?: number;
/**
* <p>traceId的索引key: 当CLS索引类型为键值索引时生效</p>
*/
LogTraceIdKey?: string;
/**
* <p>是否开启删除任意文件检测(0-关闭,1-开启)</p>
*/
IsDeleteAnyFileAnalysis?: number;
/**
* <p>是否开启读取任意文件检测(0-关闭,1-开启)</p>
*/
IsReadAnyFileAnalysis?: number;
/**
* <p>是否开启上传任意文件检测(0-关闭,1-开启)</p>
*/
IsUploadAnyFileAnalysis?: number;
/**
* <p>是否开启包含任意文件检测(0-关闭,1-开启)</p>
*/
IsIncludeAnyFileAnalysis?: number;
/**
* <p>是否开启目录遍历检测(0-关闭,1-开启)</p>
*/
IsDirectoryTraversalAnalysis?: number;
/**
* <p>是否开启模板引擎注入检测(0-关闭,1-开启)</p>
*/
IsTemplateEngineInjectionAnalysis?: number;
/**
* <p>是否开启脚本引擎注入检测(0-关闭,1-开启)</p>
*/
IsScriptEngineInjectionAnalysis?: number;
/**
* <p>是否开启表达式注入检测(0-关闭,1-开启)</p>
*/
IsExpressionInjectionAnalysis?: number;
/**
* <p>是否开启JNDI注入检测(0-关闭,1-开启)</p>
*/
IsJNDIInjectionAnalysis?: number;
/**
* <p>是否开启JNI注入检测(0-关闭,1-开启)</p>
*/
IsJNIInjectionAnalysis?: number;
/**
* <p>是否开启Webshell后门检测(0-关闭,1-开启)</p>
*/
IsWebshellBackdoorAnalysis?: number;
/**
* <p>是否开启反序列化检测(0-关闭,1-开启)</p>
*/
IsDeserializationAnalysis?: number;
/**
* <p>业务系统鉴权 token</p>
*/
Token?: string;
/**
* <p>URL长分段收敛阈值</p>
*/
UrlLongSegmentThreshold?: number;
/**
* <p>URL数字分段收敛阈值</p>
*/
UrlNumberSegmentThreshold?: number;
/**
* <p>spanId的索引key: 当CLS索引类型为键值索引时生效</p>
*/
LogSpanIdKey?: string;
/**
* <p>是否禁用 AI 能力</p><p>单位:无</p>
*/
DisableAiAbility?: number;
}
/**
* Span 对象
*/
export interface Span {
/**
* Trace ID
*/
TraceID?: string;
/**
* 日志
*/
Logs?: Array<SpanLog>;
/**
* 标签
*/
Tags?: Array<SpanTag>;
/**
* 上报应用服务信息
*/
Process?: SpanProcess;
/**
* 产生时间戳(毫秒)
*/
Timestamp?: number;
/**
* Span 名称
*/
OperationName?: string;
/**
* 关联关系
*/
References?: Array<SpanReference>;
/**
* 产生时间戳(微秒)
*/
StartTime?: number;
/**
* 持续耗时(微妙)
*/
Duration?: number;
/**
* Span ID
*/
SpanID?: string;
/**
* 产生时间戳(毫秒)
*/
StartTimeMillis?: number;
/**
* Parent Span ID
*/
ParentSpanID?: string;
}
/**
* ModifyGeneralApmApplicationConfig请求参数结构体
*/
export interface ModifyGeneralApmApplicationConfigRequest {
/**
* 业务系统Id
*/
InstanceId: string;
/**
* 需要修改的字段key