tencentcloud-sdk-nodejs
Version:
2,565 lines • 328 kB
TypeScript
/**
* DeleteAlarmShields请求参数结构体
*/
export interface DeleteAlarmShieldsRequest {
/**
* <p>模块名,这里填“monitor”</p>
*/
Module: string;
/**
* <p>屏蔽策略Id列表</p>
*/
Shields: Array<string>;
}
/**
* DescribePrometheusCreateInstanceQuota返回参数结构体
*/
export interface DescribePrometheusCreateInstanceQuotaResponse {
/**
* <p>prometheus实例创建配额</p>
*/
QuotaDetail?: PrometheusInstanceQuotaDetail;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyAlarmPolicyInfo请求参数结构体
*/
export interface ModifyAlarmPolicyInfoRequest {
/**
* 模块名,这里填“monitor”
*/
Module: string;
/**
* 告警策略 ID
*/
PolicyId: string;
/**
* 要修改的字段 NAME=策略名称 REMARK=策略备注
*/
Key: string;
/**
* 修改后的值
*/
Value: string;
}
/**
* 告警策略触发任务
*/
export interface AlarmPolicyTriggerTask {
/**
* <p>触发任务类型 AS=弹性伸缩</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Type: string;
/**
* <p>用 json 表示配置信息 {"Key1":"Value1","Key2":"Value2"}</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
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返回参数结构体
*/
export interface DescribePrometheusRegionsResponse {
/**
* 区域列表
*/
RegionSet: Array<PrometheusRegionItem>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeOnCallForm请求参数结构体
*/
export interface DescribeOnCallFormRequest {
/**
* 固定值,为"monitor"
*/
Module: string;
/**
* 值班id
*/
OnCallFormID: string;
}
/**
* DescribePrometheusInstancesOverview请求参数结构体
*/
export interface DescribePrometheusInstancesOverviewRequest {
/**
* 分页偏移量,默认为0
*/
Offset?: number;
/**
* 返回数量,默认为20,最大值为100
*/
Limit?: number;
/**
* 过滤实例,目前支持:
ID: 通过实例ID来过滤
Name: 通过实例名称来过滤
*/
Filters?: Array<Filter>;
}
/**
* ModifyGrafanaInstance返回参数结构体
*/
export interface ModifyGrafanaInstanceResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 查询策略输出的用户回调信息
*/
export interface DescribePolicyGroupInfoCallback {
/**
* <p>用户回调接口地址</p>
*/
CallbackUrl: string;
/**
* <p>用户回调接口状态,0表示未验证,1表示已验证,2表示存在url但没有通过验证</p>
*/
ValidFlag: number;
/**
* <p>用户回调接口验证码</p>
*/
VerifyCode: string;
}
/**
* ModifyGrafanaInstance请求参数结构体
*/
export interface ModifyGrafanaInstanceRequest {
/**
* <p>Grafana 实例 ID,例如:grafana-abcdefgh</p>
*/
InstanceId: string;
/**
* <p>Grafana 实例名称,例如:test</p>
*/
InstanceName: string;
}
/**
* 告警历史的指标信息
*/
export interface AlarmHistoryMetric {
/**
* 云产品监控类型查询数据使用的命名空间
*/
QceNamespace: string;
/**
* 指标名
*/
MetricName: string;
/**
* 统计周期
*/
Period: number;
/**
* 触发告警的数值
*/
Value: string;
/**
* 指标的展示名
*/
Description: string;
}
/**
* DescribeExternalClusterRegisterCommand返回参数结构体
*/
export interface DescribeExternalClusterRegisterCommandResponse {
/**
* 注册命令
*/
Command?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribePolicyGroupInfo返回参数结构体
*/
export interface DescribePolicyGroupInfoResponse {
/**
* <p>策略组名称</p>
*/
GroupName?: string;
/**
* <p>策略组所属的项目id</p>
*/
ProjectId?: number;
/**
* <p>是否为默认策略,0表示非默认策略,1表示默认策略</p>
*/
IsDefault?: number;
/**
* <p>策略类型</p>
*/
ViewName?: string;
/**
* <p>策略说明</p>
*/
Remark?: string;
/**
* <p>策略类型名称</p>
*/
ShowName?: string;
/**
* <p>最近编辑的用户uin</p>
*/
LastEditUin?: string;
/**
* <p>最近编辑时间</p>
*/
UpdateTime?: string;
/**
* <p>该策略支持的地域</p>
*/
Region?: Array<string>;
/**
* <p>策略类型的维度列表</p>
*/
DimensionGroup?: Array<string>;
/**
* <p>阈值规则列表</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
ConditionsConfig?: Array<DescribePolicyGroupInfoCondition>;
/**
* <p>产品事件规则列表</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
EventConfig?: Array<DescribePolicyGroupInfoEventCondition>;
/**
* <p>用户接收人列表</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
ReceiverInfos?: Array<DescribePolicyGroupInfoReceiverInfo>;
/**
* <p>用户回调信息</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Callback?: DescribePolicyGroupInfoCallback;
/**
* <p>模板策略组</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
ConditionsTemp?: DescribePolicyGroupInfoConditionTpl;
/**
* <p>是否可以设置成默认策略</p>
*/
CanSetDefault?: boolean;
/**
* <p>是否且规则</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IsUnionRule?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 告警通知内容模板支持的变量或者函数列表
*/
export interface NotificationContentTemplateSupport {
/**
* 监控类型
*/
MonitorType?: string;
/**
* 支持的变量
注意:此字段可能返回 null,表示取不到有效值。
*/
Variables?: Array<NotificationContentTemplateSupportDetail>;
/**
* 支持的函数
注意:此字段可能返回 null,表示取不到有效值。
*/
Functions?: Array<NotificationContentTemplateSupportDetail>;
}
/**
* 策略标签
*/
export interface PolicyTag {
/**
* <p>标签Key</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Key: string;
/**
* <p>标签Value</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Value: string;
}
/**
* DeletePrometheusClusterAgent请求参数结构体
*/
export interface DeletePrometheusClusterAgentRequest {
/**
* agent列表
*/
Agents: Array<PrometheusAgentInfo>;
/**
* 实例id
*/
InstanceId: string;
}
/**
* DescribePrometheusScrapeJobs请求参数结构体
*/
export interface DescribePrometheusScrapeJobsRequest {
/**
* 实例 ID
*/
InstanceId: string;
/**
* Agent ID
*/
AgentId: string;
/**
* 任务名
*/
Name?: string;
/**
* 任务 ID 列表
*/
JobIds?: Array<string>;
/**
* 偏移量,默认为0
*/
Offset?: number;
/**
* 返回数量,默认为20,最大值为100
*/
Limit?: number;
}
/**
* CreatePolicyGroup返回参数结构体
*/
export interface CreatePolicyGroupResponse {
/**
* 创建成功的策略组Id
*/
GroupId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeBaseMetrics返回参数结构体
*/
export interface DescribeBaseMetricsResponse {
/**
* 查询得到的指标描述列表
*/
MetricSet?: Array<MetricSet>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreatePrometheusMultiTenantInstancePostPayMode请求参数结构体
*/
export interface CreatePrometheusMultiTenantInstancePostPayModeRequest {
/**
* <p>实例名</p>
*/
InstanceName: string;
/**
* <p>VPC ID(可通过 vpc:DescribeVpcs 接口获取,与实例同地域)</p>
*/
VpcId: string;
/**
* <p>子网 ID(可通过 vpc:DescribeSubnets 接口获取)</p>
*/
SubnetId: string;
/**
* <p>数据存储时间(单位天),限制值为15, 30, 45, 90, 180, 365, 730之一</p>
*/
DataRetentionTime: number;
/**
* <p>可用区(与子网同可用区)</p>
*/
Zone: string;
/**
* <p>实例的标签</p>
*/
TagSpecification?: Array<PrometheusTag>;
/**
* <p>需要关联的 Grafana 实例</p>
*/
GrafanaInstanceId?: string;
/**
* <p>标识prom实例特殊属性</p><p>归档存储时长(天):<br>key: LongTermStorageRetentionTime<br>value: 60-730</p>
*/
InstanceAttributes?: Array<PrometheusRuleKV>;
}
/**
* DescribePolicyConditionListResponseDeprecatingInfo
*/
export interface DescribePolicyConditionListResponseDeprecatingInfo {
/**
* <p>是否隐藏</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Hidden?: boolean;
/**
* <p>新视图名称</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
NewViewNames?: Array<string>;
/**
* <p>描述</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Description?: string;
}
/**
* 云原生Prometheus模板可修改项
*/
export interface PrometheusTempModify {
/**
* <p>修改名称</p>
*/
Name?: string;
/**
* <p>修改描述</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Describe?: string;
/**
* <p>当Level为cluster时有效,<br>模板中的ServiceMonitor规则列表</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
ServiceMonitors?: Array<PrometheusConfigItem>;
/**
* <p>当Level为cluster时有效,<br>模板中的PodMonitors规则列表</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
PodMonitors?: Array<PrometheusConfigItem>;
/**
* <p>当Level为cluster时有效,<br>模板中的RawJobs规则列表</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
RawJobs?: Array<PrometheusConfigItem>;
/**
* <p>当Level为instance时有效,<br>模板中的聚合规则列表</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
RecordRules?: Array<PrometheusConfigItem>;
/**
* <p>修改内容,只有当模板类型是Alert时生效</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
AlertDetailRules?: Array<PrometheusAlertPolicyItem>;
}
/**
* UnBindingPolicyObject请求参数结构体
*/
export interface UnBindingPolicyObjectRequest {
/**
* 固定值,为"monitor"
*/
Module: string;
/**
* 策略组id,如传入 PolicyId 则该字段被忽略可传入任意值如 0
*/
GroupId: number;
/**
* 待删除对象实例的唯一id列表,UniqueId从调用[获取已绑定对象列表接口](https://cloud.tencent.com/document/api/248/40570)的出参的List中得到
*/
UniqueId: Array<string>;
/**
* 实例分组id,如果按实例分组删除的话UniqueId参数是无效的
*/
InstanceGroupId?: number;
/**
* 告警策略ID,使用此字段时 GroupId 会被忽略
*/
PolicyId?: string;
/**
* 事件配置的告警
*/
EbSubject?: string;
/**
* 是否配置了事件告警
*/
EbEventFlag?: number;
}
/**
* 策略类型信息
*/
export interface CommonNamespaceNew {
/**
* 命名空间标示
*/
Id: string;
/**
* 命名空间名称
*/
Name: string;
/**
* 监控类型
*/
MonitorType: string;
/**
* 维度信息
*/
Dimensions: Array<DimensionNew>;
}
/**
* 标签
*/
export interface Tag {
/**
* 标签key
*/
Key: string;
/**
* 标签value
*/
Value: string;
}
/**
* DescribePrometheusAgentInstances请求参数结构体
*/
export interface DescribePrometheusAgentInstancesRequest {
/**
* 集群id
可以是tke, eks, edge的集群id
*/
ClusterId: string;
}
/**
* UpdateServiceDiscovery请求参数结构体
*/
export interface UpdateServiceDiscoveryRequest {
/**
* Prometheus 实例 ID
*/
InstanceId: string;
/**
* <li>类型是 TKE,为对应的腾讯云容器服务集群 ID</li>
*/
KubeClusterId: string;
/**
* 用户 Kubernetes 集群类型:
<li> 1 = 容器服务集群(TKE) </li>
*/
KubeType: number;
/**
* 服务发现类型,取值如下:
<li> 1 = ServiceMonitor</li>
<li> 2 = PodMonitor</li>
<li> 3 = JobMonitor</li>
*/
Type: number;
/**
* 服务发现配置信息,YAML 格式,[具体YAML参数内容请参考](https://cloud.tencent.com/document/product/1416/55995#service-monitor)
*/
Yaml: string;
}
/**
* prometheus聚合规则实例详情,包含所属集群ID
*/
export interface PrometheusRecordRuleYamlItem {
/**
* 实例名称
*/
Name?: string;
/**
* 最近更新时间
*/
UpdateTime?: string;
/**
* 如果该聚合规则来至模板,则TemplateId为模板id
*/
TemplateId?: string;
/**
* Yaml内容
注意:此字段可能返回 null,表示取不到有效值。
*/
Content?: string;
/**
* 该聚合规则如果来源于用户集群crd资源定义,则ClusterId为所属集群ID
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterId?: string;
/**
* 状态
注意:此字段可能返回 null,表示取不到有效值。
*/
Status?: number;
/**
* id
注意:此字段可能返回 null,表示取不到有效值。
*/
Id?: string;
/**
* 规则数量
注意:此字段可能返回 null,表示取不到有效值。
*/
Count?: number;
}
/**
* k8s中标签,一般以数组的方式存在
*/
export interface Label {
/**
* map表中的Name
*/
Name: string;
/**
* map表中的Value
*/
Value: string;
}
/**
* ModifyConditionsTemplateRequestCondition,Condition入参字段值
*/
export interface ModifyConditionsTemplateRequestCondition {
/**
* <p>统计周期</p>
*/
CalcPeriod: string;
/**
* <p>统计方式</p>
*/
CalcType: string;
/**
* <p>持续周期</p>
*/
ContinuePeriod: string;
/**
* <p>指标ID</p>
*/
MetricID: number;
/**
* <p>统计值</p>
*/
CalcValue: string;
/**
* <p>告警通知周期</p>
*/
AlarmNotifyPeriod?: string;
/**
* <p>告警通知方式</p>
*/
AlarmNotifyType?: number;
/**
* <p>规则ID</p>
*/
RuleID?: number;
}
/**
* DescribeGrafanaIntegrations返回参数结构体
*/
export interface DescribeGrafanaIntegrationsResponse {
/**
* <p>集成数组</p>
*/
IntegrationSet: Array<GrafanaIntegrationConfig>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreatePrometheusMultiTenantInstancePostPayMode返回参数结构体
*/
export interface CreatePrometheusMultiTenantInstancePostPayModeResponse {
/**
* <p>实例 ID</p>
*/
InstanceId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpdatePrometheusAgentStatus返回参数结构体
*/
export interface UpdatePrometheusAgentStatusResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SyncPrometheusTemp返回参数结构体
*/
export interface SyncPrometheusTempResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpdateGrafanaWhiteList返回参数结构体
*/
export interface UpdateGrafanaWhiteListResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribePolicyGroupList返回参数结构体
*/
export interface DescribePolicyGroupListResponse {
/**
* <p>策略组列表</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
GroupList?: Array<DescribePolicyGroupListGroup>;
/**
* <p>策略组总数</p>
*/
Total?: number;
/**
* <p>备注信息</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Warning?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeGrafanaEnvironments请求参数结构体
*/
export interface DescribeGrafanaEnvironmentsRequest {
/**
* Grafana 实例 ID,例如:grafana-abcdefgh
*/
InstanceId: string;
}
/**
* DescribePrometheusCreateInstanceQuota请求参数结构体
*/
export type DescribePrometheusCreateInstanceQuotaRequest = null;
/**
* prometheus配置
*/
export interface PrometheusConfigItem {
/**
* 名称
*/
Name: string;
/**
* 配置内容
*/
Config: string;
/**
* 用于出参,如果该配置来至模板,则为模板id
注意:此字段可能返回 null,表示取不到有效值。
*/
TemplateId?: string;
/**
* 目标数
注意:此字段可能返回 null,表示取不到有效值。
*/
Targets?: Targets;
}
/**
* 告警策略详情
*/
export interface AlarmPolicy {
/**
* <p>告警策略 ID</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
PolicyId?: string;
/**
* <p>告警策略名称</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
PolicyName?: string;
/**
* <p>备注信息</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Remark?: string;
/**
* <p>监控类型 MT_QCE=云产品监控</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
MonitorType?: string;
/**
* <p>启停状态 0=停用 1=启用</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Enable?: number;
/**
* <p>策略组绑定的实例数</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
UseSum?: number;
/**
* <p>项目 Id -1=无项目 0=默认项目</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
ProjectId?: number;
/**
* <p>项目名</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
ProjectName?: string;
/**
* <p>告警策略类型</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Namespace?: string;
/**
* <p>触发条件模板 Id</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
ConditionTemplateId?: string;
/**
* <p>指标触发条件</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Condition?: AlarmPolicyCondition;
/**
* <p>事件触发条件</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
EventCondition?: AlarmPolicyEventCondition;
/**
* <p>通知规则 id 列表</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
NoticeIds?: Array<string>;
/**
* <p>通知规则 列表</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Notices?: Array<AlarmNotice>;
/**
* <p>触发任务列表</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
TriggerTasks?: Array<AlarmPolicyTriggerTask>;
/**
* <p>模板策略组<br>注意:此字段可能返回 null,表示取不到有效值。</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
ConditionsTemp?: ConditionsTemp;
/**
* <p>最后编辑的用户uin</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
LastEditUin?: string;
/**
* <p>更新时间<br>注意:此字段可能返回 null,表示取不到有效值。</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
UpdateTime?: number;
/**
* <p>创建时间<br>注意:此字段可能返回 null,表示取不到有效值。</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
InsertTime?: number;
/**
* <p>地域</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Region?: Array<string>;
/**
* <p>namespace显示名字</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
NamespaceShowName?: string;
/**
* <p>是否默认策略,1是,0否</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IsDefault?: number;
/**
* <p>能否设置默认策略,1是,0否</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
CanSetDefault?: number;
/**
* <p>实例分组ID</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceGroupId?: number;
/**
* <p>实例分组总实例数</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceSum?: number;
/**
* <p>实例分组名称</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceGroupName?: string;
/**
* <p>触发条件类型 STATIC=静态阈值 DYNAMIC=动态类型</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
RuleType?: string;
/**
* <p>用于实例、实例组绑定和解绑接口(BindingPolicyObject、UnBindingAllPolicyObject、UnBindingPolicyObject)的策略 ID</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
OriginId?: string;
/**
* <p>标签</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
TagInstances?: Array<TagInstance>;
/**
* <p>过滤条件</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Filter?: AlarmConditionFilter;
/**
* <p>聚合条件</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
GroupBy?: Array<AlarmGroupByItem>;
/**
* <p>策略关联的过滤维度信息</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
FilterDimensionsParam?: string;
/**
* <p>是否为一键告警策略</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IsOneClick?: number;
/**
* <p>一键告警策略是否开启</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
OneClickStatus?: number;
/**
* <p>高级指标数量</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
AdvancedMetricNumber?: number;
/**
* <p>策略是否是全部对象策略</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IsBindAll?: number;
/**
* <p>策略标签</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Tags?: Array<Tag>;
/**
* <p>是否支持告警标签</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IsSupportAlarmTag?: number;
/**
* <p>多标签交/并集关系</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
TagOperation?: string;
/**
* <p>通知模板绑定内容模板信息</p>
*/
NoticeTmplBindInfos?: Array<NoticeContentTmplBindInfo>;
/**
* <p>模板通知的等级</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
HierarchicalNotices?: Array<AlarmHierarchicalNotice>;
/**
* <p>通知模板绑定内容模板信息,同NoticeTmplBindInfos</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
NoticeContentTmplBindInfos?: Array<NoticeContentTmplBindInfo>;
/**
* <p>预设配置id</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
PredefinedConfigID?: string;
}
/**
* DeleteExporterIntegration请求参数结构体
*/
export interface DeleteExporterIntegrationRequest {
/**
* <p>实例 ID</p>
*/
InstanceId: string;
/**
* <p>类型(可通过 DescribeExporterIntegrations获取)</p>
*/
Kind: string;
/**
* <p>名字</p>
*/
Name: string;
/**
* <p>Kubernetes 集群类型,取值如下:</p><li> 1= 容器集群(TKE) </li><li> 2=弹性集群(EKS) </li><li> 3= Prometheus管理的弹性集群(MEKS) </li>
*/
KubeType?: number;
/**
* <p>集群 ID,可不填</p>
*/
ClusterId?: string;
}
/**
* prometheus 报警规则 KV 参数
*/
export interface PrometheusRuleKV {
/**
* <p>键</p>
*/
Key: string;
/**
* <p>值</p>
*/
Value: string;
}
/**
* DescribePolicyConditionList返回参数结构体
*/
export interface DescribePolicyConditionListResponse {
/**
* <p>告警策略条件列表</p>
*/
Conditions?: Array<DescribePolicyConditionListCondition>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* prometheus 报警规则集
*/
export interface PrometheusRuleSet {
/**
* <p>规则 ID</p>
*/
RuleId: string;
/**
* <p>规则名称</p>
*/
RuleName: string;
/**
* <p>规则状态码</p>
*/
RuleState: number;
/**
* <p>规则类别</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Type: string;
/**
* <p>规则标签列表</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Labels: Array<PrometheusRuleKV>;
/**
* <p>规则注释列表</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Annotations: Array<PrometheusRuleKV>;
/**
* <p>规则表达式</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Expr: string;
/**
* <p>规则报警持续时间</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Duration: string;
/**
* <p>报警接收组列表</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Receivers: Array<string>;
/**
* <p>规则运行健康状态,取值如下:</p><li>unknown 未知状态</li><li>pending 加载中</li><li>ok 运行正常</li><li>err 运行错误</li>
*/
Health: string;
/**
* <p>规则创建时间</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
CreatedAt: string;
/**
* <p>规则更新时间</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
UpdatedAt: string;
}
/**
* DescribeAllNamespaces返回参数结构体
*/
export interface DescribeAllNamespacesResponse {
/**
* 云产品的告警策略类型,已废弃
*/
QceNamespaces: CommonNamespace;
/**
* 其他告警策略类型,已废弃
*/
CustomNamespaces: CommonNamespace;
/**
* 云产品的告警策略类型
*/
QceNamespacesNew: Array<CommonNamespace>;
/**
* 其他告警策略类型,暂不支持
*/
CustomNamespacesNew: Array<CommonNamespace>;
/**
* 通用告警策略类型(包括:应用性能监控,前端性能监控,云拨测)
注意:此字段可能返回 null,表示取不到有效值。
*/
CommonNamespaces: Array<CommonNamespaceNew>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateAlarmShield请求参数结构体
*/
export interface CreateAlarmShieldRequest {
/**
* <p>模块名,这里填“monitor”</p>
*/
Module: string;
/**
* <p>屏蔽策略名称</p>
*/
Name: string;
/**
* <p>监控类型</p>
*/
MonitorType: string;
/**
* <p>命名空间即策略类型</p>
*/
NameSpace: string;
/**
* <p>屏蔽时间类型 FOREVER_SHIELD:永久屏蔽 PERIOD_SHIELD:绝对时间范围屏蔽 LOOP_SHIELD:相对时间范围屏蔽</p>
*/
ShieldTimeType: string;
/**
* <p>屏蔽对象</p>
*/
ShieldObject?: Array<string>;
/**
* <p>屏蔽指标 为空则为全部指标</p>
*/
ShieldMetric?: Array<string>;
/**
* <p>开始时间 相对时间范围:36000 绝对时间范围:1648742400 缺省:0</p>
*/
StartTime?: number;
/**
* <p>结束时间 相对时间范围:72000 绝对时间范围:1649088000 缺省:0</p>
*/
EndTime?: number;
/**
* <p>循环开始日期 2022/04/01 缺省:0</p>
*/
LoopStartDate?: number;
/**
* <p>循环结束日期 2022/04/05 缺省:0</p>
*/
LoopEndDate?: number;
/**
* <p>需要屏蔽的策略ID</p>
*/
ShieldPolicyId?: string;
/**
* <p>需要屏蔽的告警等级,取值范围Warn,Remind,Serious</p>
*/
ShieldAlarmLevel?: Array<string>;
/**
* <p>屏蔽类型,为OBJNAME是实例屏蔽,为POLICY是策略屏蔽</p>
*/
VersionTag?: string;
/**
* <p>屏蔽规则的描述</p>
*/
Description?: string;
/**
* <p>时区,东八区+8,西八区减8,以此类推</p>
*/
TimeZone?: number;
/**
* <p>屏蔽事件 为空则为全部指标</p>
*/
ShieldEvent?: Array<string>;
/**
* <p>是否对指标屏蔽 1=是 0=否</p>
*/
ShieldMetricFlag?: number;
/**
* <p>是否对事件屏蔽 1=是 0=否</p>
*/
ShieldEventFlag?: number;
}
/**
* CheckAddressByPrometheus请求参数结构体
*/
export interface CheckAddressByPrometheusRequest {
/**
* <p>实例id</p>
*/
InstanceId: string;
/**
* <p>探测地址</p>
*/
Target: string;
/**
* <p>探测方式。tcp或http,默认是tcp</p>
*/
ProbeProtocol?: string;
}
/**
* InstallPlugins返回参数结构体
*/
export interface InstallPluginsResponse {
/**
* 已安装插件 ID
注意:此字段可能返回 null,表示取不到有效值。
*/
PluginIds?: Array<string>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 云产品监控支持的产品简要信息
*/
export interface ProductSimple {
/**
* 命名空间
*/
Namespace: string;
/**
* 产品中文名称
*/
ProductName: string;
/**
* 产品英文名称
注意:此字段可能返回 null,表示取不到有效值。
*/
ProductEnName: string;
}
/**
* 告警策略触发条件
*/
export interface AlarmPolicyRule {
/**
* <p>指标名或事件名,支持的指标可以从 <a href="https://cloud.tencent.com/document/product/248/51283">DescribeAlarmMetrics</a> 查询,支持的事件可以从 <a href="https://cloud.tencent.com/document/product/248/51284">DescribeAlarmEvents</a> 查询 。</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
MetricName?: string;
/**
* <p>秒数 统计周期,支持的值可以从 <a href="https://cloud.tencent.com/document/product/248/51283">DescribeAlarmMetrics</a> 查询。</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Period?: number;
/**
* <p>英文运算符<br>intelligent=无阈值智能检测<br>eq=等于<br>ge=大于等于<br>gt=大于<br>le=小于等于<br>lt=小于<br>ne=不等于<br>day_increase=天同比增长<br>day_decrease=天同比下降<br>day_wave=天同比波动<br>week_increase=周同比增长<br>week_decrease=周同比下降<br>week_wave=周同比波动<br>cycle_increase=环比增长<br>cycle_decrease=环比下降<br>cycle_wave=环比波动<br>re=正则匹配<br>支持的值可以从 <a href="https://cloud.tencent.com/document/product/248/51283">DescribeAlarmMetrics</a> 查询。</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Operator?: string;
/**
* <p>阈值,支持的范围可以从 <a href="https://cloud.tencent.com/document/product/248/51283">DescribeAlarmMetrics</a> 查询。</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Value?: string;
/**
* <p>周期数 持续通知周期 1=持续1个周期 2=持续2个周期...,支持的值可以从 <a href="https://cloud.tencent.com/document/product/248/51283">DescribeAlarmMetrics</a> 查询</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
ContinuePeriod?: number;
/**
* <p>秒数 告警间隔 0=不重复 300=每5分钟告警一次 600=每10分钟告警一次 900=每15分钟告警一次 1800=每30分钟告警一次 3600=每1小时告警一次 7200=每2小时告警一次 10800=每3小时告警一次 21600=每6小时告警一次 43200=每12小时告警一次 86400=每1天告警一次</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
NoticeFrequency?: number;
/**
* <p>告警频率是否指数增长 0=否 1=是</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IsPowerNotice?: number;
/**
* <p>对于单个触发规则的过滤条件</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Filter?: AlarmPolicyFilter;
/**
* <p>指标展示名,用于出参</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Description?: string;
/**
* <p>单位,用于出参</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Unit?: string;
/**
* <p>触发条件类型 STATIC=静态阈值 DYNAMIC=动态阈值。创建或编辑策略时,如不填则默认为 STATIC。</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
RuleType?: string;
/**
* <p>是否为高级指标,0否,1是</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IsAdvanced?: number;
/**
* <p>高级指标是否开通,0否,1是</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IsOpen?: number;
/**
* <p>集成中心产品ID</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
ProductId?: string;
/**
* <p>最大值</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
ValueMax?: number;
/**
* <p>最小值</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
ValueMin?: number;
/**
* <p>告警分级阈值配置</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
HierarchicalValue?: AlarmHierarchicalValue;
/**
* <p>是否延迟指标</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IsLatenessMetric?: number;
}
/**
* CreateGrafanaIntegration请求参数结构体
*/
export interface CreateGrafanaIntegrationRequest {
/**
* <p>Grafana 实例 ID,例如:grafana-abcdefgh</p>
*/
InstanceId: string;
/**
* <p>集成类型(接口DescribeGrafanaIntegrationOverviews返回的集成信息中的Code字段)</p>
*/
Kind: string;
/**
* <p>集成配置</p>
*/
Content: string;
}
/**
* DescribePrometheusGlobalConfig请求参数结构体
*/
export interface DescribePrometheusGlobalConfigRequest {
/**
* 实例级别抓取配置
*/
InstanceId: string;
/**
* 是否禁用统计
*/
DisableStatistics?: boolean;
}
/**
* 实例对象的维度组合
*/
export interface Dimension {
/**
* 实例维度名称
注意:此字段可能返回 null,表示取不到有效值。
*/
Name: string;
/**
* 实例维度值
注意:此字段可能返回 null,表示取不到有效值。
*/
Value: string;
}
/**
* DescribeBindingPolicyObjectList返回参数结构体
*/
export interface DescribeBindingPolicyObjectListResponse {
/**
* <p>绑定的对象实例列表</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
List: Array<DescribeBindingPolicyObjectListInstance>;
/**
* <p>绑定的对象实例总数</p>
*/
Total: number;
/**
* <p>未屏蔽的对象实例数</p>
*/
NoShieldedSum: number;
/**
* <p>绑定的实例分组信息,没有绑定实例分组则为空</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceGroup: DescribeBindingPolicyObjectListInstanceGroup;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpdateAlertRuleState请求参数结构体
*/
export interface UpdateAlertRuleStateRequest {
/**
* 规则 ID 列表
*/
RuleIds: Array<string>;
/**
* Prometheus 实例 ID
*/
InstanceId: string;
/**
* 规则状态码,取值如下:
<li>2=RuleEnabled</li>
<li>3=RuleDisabled</li>
默认状态码为 2 启用。
*/
RuleState: number;
}
/**
* DescribeAlarmSmsQuota请求参数结构体
*/
export interface DescribeAlarmSmsQuotaRequest {
/**
* <p>固定值,为"monitor"</p>
*/
Module: string;
}
/**
* DescribePrometheusInstanceInitStatus返回参数结构体
*/
export interface DescribePrometheusInstanceInitStatusResponse {
/**
* 实例初始化状态,取值:
uninitialized 未初始化
initializing 初始化中
running 初始化完成,运行中
注意:此字段可能返回 null,表示取不到有效值。
*/
Status?: string;
/**
* 初始化任务步骤
注意:此字段可能返回 null,表示取不到有效值。
*/
Steps?: Array<TaskStepInfo>;
/**
* 实例eks集群ID
注意:此字段可能返回 null,表示取不到有效值。
*/
EksClusterId?: string;
/**
* eks集群内pod的安全组
注意:此字段可能返回 null,表示取不到有效值。
*/
SecurityGroupId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeProductEventList返回参数结构体
*/
export interface DescribeProductEventListResponse {
/**
* 事件列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Events: Array<DescribeProductEventListEvents>;
/**
* 事件统计
*/
OverView: DescribeProductEventListOverView;
/**
* 事件总数
注意:此字段可能返回 null,表示取不到有效值。
*/
Total: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 抓取目标数
*/
export interface Targets {
/**
* 总数
注意:此字段可能返回 null,表示取不到有效值。
*/
Total?: number;
/**
* 在线数
注意:此字段可能返回 null,表示取不到有效值。
*/
Up?: number;
/**
* 不在线数
注意:此字段可能返回 null,表示取不到有效值。
*/
Down?: number;
/**
* 未知状态数
注意:此字段可能返回 null,表示取不到有效值。
*/
Unknown?: number;
}
/**
* GetTopNMonitorData返回参数结构体
*/
export interface GetTopNMonitorDataResponse {
/**
* 指标名
*/
MetricName?: string;
/**
* 统计周期
*/
Period?: number;
/**
* topN
*/
N?: number;
/**
* 排序的监控数据
*/
OrderedDataPoints?: Array<SingleOrderedDataPoint>;
/**
* 返回信息
*/
Msg?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribePolicyObjectCount接口返回的地域统计
*/
export interface RegionPolicyObjectCount {
/**
* <p>地域</p>
*/
Region: string;
/**
* <p>绑定的实例数量</p>
*/
Count: number;
}
/**
* 聚合条件
*/
export interface AlarmGroupByItem {
/**
* <p>Item Id</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Id?: string;
/**
* <p>名称</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Name?: string;
}
/**
* DescribePrometheusIntegrationMetrics返回参数结构体
*/
export interface DescribePrometheusIntegrationMetricsResponse {
/**
* 集成指标详情分组
*/
IntegrationMetricSet?: Array<IntegrationMetricGroup>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribePrometheusInstanceUsage请求参数结构体
*/
export interface DescribePrometheusInstanceUsageRequest {
/**
* 按照一个或者多个实例ID查询。实例ID形如:prom-xxxxxxxx。
*/
InstanceIds: Array<string>;
/**
* 开始时间
*/
StartCalcDate: string;
/**
* 结束时间
*/
EndCalcDate: string;
}
/**
* DeleteSSOAccount请求参数结构体
*/
export interface DeleteSSOAccountRequest {
/**
* Grafana 实例 ID,例如:grafana-abcdefgh
*/
InstanceId: string;
/**
* 用户账号 ID ,例如:10000000
*/
UserId: string;
}
/**
* DescribePolicyObjectCount请求参数结构体
*/
export interface DescribePolicyObjectCountRequest {
/**
* <p>固定值,为"monitor"</p>
*/
Module: string;
/**
* <p>策略组Id</p>
*/
GroupId: number;
}
/**
* CreatePrometheusRecordRuleYaml请求参数结构体
*/
export interface CreatePrometheusRecordRuleYamlRequest {
/**
* 实例id
*/
InstanceId: string;
/**
* yaml的内容
*/
Content: string;
/**
* 规则名称
*/
Name?: string;
}
/**
* 实例维度组合数组
*/
export interface Instance {
/**
* 实例的维度组合
*/
Dimensions: Array<Dimension>;
}
/**
* DescribePrometheusAgentInstances返回参数结构体
*/
export interface DescribePrometheusAgentInstancesResponse {
/**
* 关联该集群的实例列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Instances?: Array<string>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAlarmNotices返回参数结构体
*/
export interface DescribeAlarmNoticesResponse {
/**
* <p>告警通知模板总数</p>
*/
TotalCount?: number;
/**
* <p>告警通知模板列表</p>
*/
Notices?: Array<AlarmNotice>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 关联集群时在集群内部署组件的pod额外配置
*/
export interface PrometheusClusterAgentPodConfig {
/**
* 是否使用HostNetWork
*/
HostNet?: boolean;
/**
* 指定pod运行节点
*/
NodeSelector?: Array<Label>;
/**
* 容忍污点
*/
Tolerations?: Array<Toleration>;
}
/**
* DeletePrometheusAlertGroups请求参数结构体
*/
export interface DeletePrometheusAlertGroupsRequest {
/**
* prometheus实例id
*/
InstanceId?: string;
/**
* 需要删除的告警分组ID,形如alert-xxxxx
*/
GroupIds?: Array<string>;
}
/**
* 查询 Grafana 实例时的实例类型
*/
export interface GrafanaInstanceInfo {
/**
* 实例名
*/
InstanceName?: string;
/**
* 实例 ID
*/
InstanceId?: string;
/**
* 地域
*/
Region?: string;
/**
* VPC ID
*/
VpcId?: string;
/**
* 子网 ID 数组
*/
SubnetIds?: Array<string>;
/**
* Grafana 公网地址
*/
InternetUrl?: string;
/**
* Grafana 内网地址
*/
InternalUrl?: string;
/**
* 创建时间
*/
CreatedAt?: string;
/**
* 运行状态(1:正在创建;2:运行中;3:异常;4:重启中;5:停机中; 6:已停机; 7: 已删除)
*/
InstanceStatus?: number;
/**
* 实例的标签
注意:此字段可能返回 null,表示取不到有效值。
*/
TagSpecification?: Array<PrometheusTag>;
/**
* 实例的可用区
*/
Zone?: string;
/**
* 计费模式(1:包年包月)
*/
InstanceChargeType?: number;
/**
* VPC 名称
*/
VpcName?: string;
/**
* 子网名称
*/
SubnetName?: string;
/**
* 地域 ID
*/
RegionId?: number;
/**
* 可访问此实例的完整 URL
*/
RootUrl?: string;
/**
* 是否开启 SSO
*/
EnableSSO?: boolean;
/**
* 版本号
*/
Version?: string;
/**
* SSO登录时是否开启cam鉴权
*/
EnableSSOCamCheck?: boolean;
}
/**
* DeletePrometheusConfig返回参数结构体
*/
export interface DeletePrometheusConfigResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribePolicyObjectCount返回参数结构体
*/
export interface DescribePolicyObjectCountResponse {
/**
* <p>是否为多地域</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IsMultiRegion?: boolean;
/**
* <p>地域统计列表</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
RegionList?: Array<RegionPolicyObjectCount>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreatePrometheusRecordRuleYaml返回参数结构体
*/
export interface CreatePrometheusRecordRuleYamlResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 指标数据的解释
*/
export interface MetricObjectMeaning {
/**
* 指标英文解释
*/
En: string;
/**
* 指标中文解释
*/
Zh: string;
}
/**
* 告警事件
*/
export interface AlarmEvent {
/**
* <p>事件名</p>
*/
EventName: string;
/**
* <p>展示的事件名</p>
*/
Description: string;
/**
* <p>告警策略类型</p>
*/
Namespace: string;
}
/**
* ModifyPolicyGroup返回参数结构体
*/
export interface ModifyPolicyGroupResponse {
/**
* <p>策略组id</p>
*/
GroupId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ReplacePrometheusAlertmanagerConfig返回参数结构体
*/
export interface ReplacePrometheusAlertmanagerConfigResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UninstallGrafanaPlugins返回参数结构体
*/
export interface UninstallGrafanaPluginsResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyPrometheusTemp请求参数结构体
*/
export interface ModifyPrometheusTempRequest {
/**
* 模板ID
*/
TemplateId: string;
/**
* 修改内容
*/
Template: PrometheusTempModify;
}
/**
* UpgradeGrafanaInstance返回参数结构体
*/
export interface UpgradeGrafanaInstanceResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeRemoteWrites返回参数结构体
*/
export interface DescribeRemoteWritesResponse {
/**
* 存储数据
*/
Count?: number;
/**
* 多写信息
*/
RemoteWrites?: Array<WriteDestination>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* BindingPolicyTag请求参数结构体
*/
export interface BindingPolicyTagRequest {
/**
* 固定取值 monitor
*/
Module: string;
/**
* 策略ID
*/
PolicyId: string;
/**
* 用于实例、实例组绑定和解绑接口(BindingPolicyObject、UnBindingAllPolicyObject、UnBindingPolicyObject)的策略 ID
*/
GroupId: string;
/**
* 产品类型
*/
ServiceType: string;
/**
* 策略标签
*/
Tag?: PolicyTag;
/**
* 实例分组ID
*/
InstanceGroupId?: number;
/**
* 批量绑定标签
*/
BatchTag?: Array<PolicyTag>;
/**
* 是否同步eb
*/
EbEventFlag?: number;
/**
* 事件配置的告警
*/
EbSubject?: string;
/**
* 标识标签取交/并集关系
*/
TagOperation?: string;
}
/**
* DeletePrometheusTempSync返回参数结构体
*/
export interface DeletePrometheusTempSyncResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDNSConfig请求参数结构体
*/
export interface DescribeDNSConfigRequest {
/**
* <p>Grafana 实例 ID,例如:grafana-abcdefgh</p>
*/
InstanceId: string;
}
/**
* 查询策略输出的模板策略组信息
*/
export interface DescribePolicyGroupInfoConditionTpl {
/**
* <p>策略组id</p>
*/
GroupId: number;
/**
* <p>策略组名称</p>
*/
GroupName: string;
/**
* <p>策略类型</p>
*/
ViewName: string;
/**
* <p>策略组说明</p>
*/
Remark: string;
/**
* <p>最后编辑的用户uin</p>
*/
LastEditUin: string;
/**
* <p>更新时间</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
UpdateTime: number;
/**
* <p>创建时间</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
InsertTime: number;
/**
* <p>是否且规则</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IsUnionRule: number;
}
/**
* UnBindingPolicyObject返回参数结构体
*/
export interface UnBindingPolicyObjectResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribePrometheusRecordRules请求参数结构体
*/
export interface DescribePrometheusRecordRulesRequest {
/**
* Prometheus 实例 ID
*/
InstanceId: string;
/**
* 偏移量,默认为0。
*/
Offset?: number;
/**
* 返回数量,默认为20,最大值为100。
*/
Limit?: number;
/**
* 仅支持按Name, Values字段过滤。
*/
Filters?: Array<Filter>;
}
/**
* ModifyAlarmPolicyStatus返回参数结构体
*/
export interface ModifyAlarmPolicyStatusResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeExporterIntegrations返回参数结构体
*/
export interface DescribeExporterIntegrationsResponse {
/**
* <p>集成配置列表</p>
*/
IntegrationSet?: Array<IntegrationConfiguration>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateOnCallForm请求参数结构体
*/
export interface CreateOnCallFormRequest {
/**
* 固定值,为"monitor"
*/
Module: string;
/**
* 值班表名称
*/
OnCallFormName: string;
/**
* 值班人员id组
*/
StaffInfos: Array<StaffInfo>;
/**
* 轮转类型
*/
RotationType: string;
/**
* 换班时间
*/
ShiftTime: string;
/**
* 有效期开始时间,单位s
*/
EffectiveStartTime: number;
/**
* 有效期结束时间,单位s
*/
EffectiveEndTime: number;
/**
* 时区(-12 - 12)
*/
TimeZone: number;
/**
* 值班表描述
*/
OnCallFormDesc?: string;
/**
* 轮班信息
*/
CoverStaffInfos?: Array<CoverStaffInfo>;
/**
* 模板绑定的标签
*/
Tags?: Array<Tag>;
}
/**
* UpdateAlertRule返回参数结构体
*/
export interface UpdateAlertRuleResponse {
/**
* 规则 ID
*/
RuleId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeBasicAlarmList返回的Alarms里的InstanceGroup
*/
export interface InstanceGroup {
/**
* <p>实例组ID</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceGroupId: number;
/**
* <p>实例组名</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceGroupName: string;
}
/**
* EnableGrafanaSSO请求参数结构体
*/
export interface EnableGrafanaSSORequest {
/**
* 是否开启 SSO,true为开启,false 为不开启
*/
EnableSSO: boolean;
/**
* Grafana 实例 ID,例如:grafana-abcdefgh
*/
InstanceId: string;
}
/**
* DescribePrometheusScrapeJobs返回参数结构体
*/
export interface DescribePrometheusScrapeJobsResponse {
/**
* 任务列表
注意:此字段可能返回 null,表示取不到有效值。
*/
ScrapeJobSet?: Array<PrometheusScrapeJob>;
/**
* 任务总量
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* EnableGrafanaInternet请求参数结构体
*/
export interface EnableGrafanaInternetRequest {
/**
* Grafana 实例 ID,例如:grafana-kleu3gt0
*/
InstanceID: string;
/**
* 开启或关闭公网访问,true为开启,false 为不开启
*/
EnableInternet: boolean;
}
/**
* DescribePluginOverviews返回参数结构体
*/
export interface DescribePluginOverviewsResponse {
/**
* 插件列表
*/
PluginSet?: Array<GrafanaPlugin>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* Grafana可视化服务 账号权限
*/
export interface GrafanaAccountRole {
/**
* 组织
*/
Organization?: string;
/**
* 权限(Admin、Editor、Viewer)
*/
Role?: string;
}
/**
* DestroyPrometheusInstance请求参数结构体
*/
export interface DestroyPrometheusInstanceRequest {
/**
* 实例 ID,该实例必须先被 terminate
*/
InstanceId: string;
}
/**
* 2018版策略模板列表接收人信息
*/
export interface PolicyGroupReceiverInfo {
/**
* <p>有效时段结束时间</p>
*/
EndTime: number;
/**
* <p>是否需要发送通知</p>
*/
NeedSendNotice: number;
/**
* <p>告警接收渠道</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
NotifyWay: Array<string>;
/**
* <p>电话告警对个人间隔(秒)</p>
*/
PersonInterval: number;
/**
* <p>消息接收组列表</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
ReceiverGroupList: Array<number | bigint>;
/**
* <p>接受者类型</p>
*/
ReceiverType: string;
/**
* <p>接收人列表。通过平台接口查询到的接收人id列表</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
ReceiverUserList: Array<number | bigint>;
/**
* <p>告警恢复通知方式</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
RecoverNotify: Array<string>;
/**
* <p>电话告警每轮间隔(秒)</p>
*/
RoundInterval: number;
/**
* <p>电话告警轮数</p>
*/
RoundNumber: number;
/**
* <p>电话告警通知时机。可选"OCCUR"(告警时通知),"RECOVER"(恢复时通知)</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
SendFor: Array<string>;
/**
* <p>有效时段开始时间</p>
*/
StartTime: number;
/**
* <p>电话告警接收者uid</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
UIDList: Array<number | bigint>;
}
/**
* 指标,可用于设置告警、查询数据
*/
export interface Metric {
/**
* <p>告警策略类型</p>
*/
Namespace?: string;
/**
* <p>指标名</p>
*/
MetricName?: string;
/**
* <p>指标展示名</p>
*/
Description?: string;
/**
* <p>最小值</p>
*/
Min?: number;
/**
* <p>最大值</p>
*/
Max?: number;
/**
* <p>维度列表</p>
*/
Dimensions?: Array<string>;
/**
* <p>单位</p>
*/
Unit?: string;
/**
* <p>指标配置</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
MetricConfig?: MetricConfig;
/**
* <p>是否为高级指标。1是 0否</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IsAdvanced?: number;
/**
* <p>高级指标是否开通。1是 0否</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IsOpen?: number;
/**
* <p>集成中心产品ID</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
ProductId?: number;
/**
* <p>匹配运算符</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Operators?: Array<Operator>;
/**
* <p>指标触发</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Periods?: Array<number | bigint>;
/**
* <p>是否延迟指标</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IsLatenessMetric?: number;
}
/**
* DescribeMidDimensionValueList的查询条件
*/
export interface MidQueryCondition {
/**
* 维度
*/
Key: string;
/**
* 操作符,支持=、in
*/
Operator: string;
/**
* 维度值,当Op是=时,只使用第一个元素
*/
Value: Array<string>;
}
/**
* DescribeGrafanaInstances请求参数结构体
*/
export interface DescribeGrafanaInstancesRequest {
/**
* 查询偏移量
*/
Offset: number;
/**
* 查询数量
*/
Limit: number;
/**
* Grafana 实例 ID 数组
*/
InstanceIds?: Array<string>;
/**
* Grafana 实例名,支持前缀模糊搜索
*/
InstanceName?: string;
/**
* 查询状态
*/
InstanceStatus?: Array<number | bigint>;
/**
* 标签过滤数组
*/
TagFilters?: Array<PrometheusTag>;
}
/**
* DescribePrometheusTargetsTMP返回参数结构体
*/
export interface DescribePrometheusTargetsTMPResponse {
/**
* 所有Job的targets信息
*/
Jobs?: Array<PrometheusJobTargets>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 告警通知模板 - 回调通知详情
*/
export interface URLNotice {
/**
* 回调 url(限长256字符)
注意:此字段可能返回 null,表示取不到有效值。
*/
URL: string;
/**
* 是否通过验证 0=否 1=是
注意:此字段可能返回 null,表示取不到有效值。
*/
IsValid?: number;
/**
* 验证码
注意:此字段可能返回 null,表示取不到有效值。
*/
ValidationCode?: string;
/**
* 通知开始时间 一天开始的秒数
注意:此字段可能返回 null,表示取不到有效值。
*/
StartTime?: number;
/**
* 通知结束时间 一天开始的秒数
注意:此字段可能返回 null,表示取不到有效值。
*/
EndTime?: number;
/**
* 通知周期 1-7表示周一到周日
注意:此字段可能返回 null,表示取不到有效值。
*/
Weekday?: Array<number | bigint>;
/**
* 组名
注意:此字段可能返回 null,表示取不到有效值。
*/
GroupMembers?: string;
}
/**
* DescribeProductList返回参数结构体
*/
export interface DescribeProductListResponse {
/**
* 产品信息列表
注意:此字段可能返回 null,表示取不到有效值。
*/
ProductList?: Array<ProductSimple>;
/**
* 产品总数
注意:此字段可能返回 null,表示取不到有效值。
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeletePrometheusTemp返回参数结构体
*/
export interface DeletePrometheusTempResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 创建策