vue-driven-cloud-storage/backend/node_modules/@alicloud/cms20190101/dist/models/ModifyHostAvailabilityRequest.d.ts

import * as $dara from '@darabonba/typescript';
export declare class ModifyHostAvailabilityRequestAlertConfig extends $dara.Model {
    /**
     * @remarks
     * The end of the time range during which the alert rule is effective. Valid values: 0 to 23.
     *
     * For example, if the `AlertConfig.StartTime` parameter is set to 0 and the `AlertConfig.EndTime` parameter is set to 22, the alert rule is effective from 00:00:00 to 22:00:00.
     *
     * > Alert notifications are sent based on the specified threshold only if the alert rule is effective.
     *
     * @example
     * 22
     */
    endTime?: number;
    /**
     * @remarks
     * The alert notification methods. Valid values:
     *
     * 0: Alert notifications are sent by using emails and DingTalk chatbots.
     *
     * This parameter is required.
     *
     * @example
     * 0
     */
    notifyType?: number;
    /**
     * @remarks
     * The mute period during which new alerts are not sent even if the trigger conditions are met. Unit: seconds. Default value: 86400. The default value indicates one day.
     *
     * @example
     * 86400
     */
    silenceTime?: number;
    /**
     * @remarks
     * The beginning of the time range during which the alert rule is effective. Valid values: 0 to 23.
     *
     * For example, if the `AlertConfig.StartTime` parameter is set to 0 and the `AlertConfig.EndTime` parameter is set to 22, the alert rule is effective from 00:00:00 to 22:00:00.
     *
     * > Alert notifications are sent based on the specified threshold only if the alert rule is effective.
     *
     * @example
     * 0
     */
    startTime?: number;
    /**
     * @remarks
     * The callback URL.
     *
     * @example
     * https://www.aliyun.com/webhook.json
     */
    webHook?: string;
    static names(): {
        [key: string]: string;
    };
    static types(): {
        [key: string]: any;
    };
    validate(): void;
    constructor(map?: {
        [key: string]: any;
    });
}
export declare class ModifyHostAvailabilityRequestTaskOption extends $dara.Model {
    /**
     * @remarks
     * The header of the HTTP request. Format: `Parameter name:Parameter value`. Separate multiple parameters with carriage return characters. Example:
     *
     *     params1:value1
     *     params2:value2
     *
     * @example
     * params1:value1
     */
    httpHeader?: string;
    /**
     * @remarks
     * The HTTP request method. Valid values:
     *
     * *   GET
     * *   POST
     * *   HEAD
     *
     * > This parameter must be specified when TaskType is set to HTTP. For more information about how to configure the TaskType parameter, see [CreateHostAvailability](https://help.aliyun.com/document_detail/115317.html).
     *
     * @example
     * GET
     */
    httpMethod?: string;
    /**
     * @remarks
     * The method to trigger an alert. The alert can be triggered based on whether the specified alert rule is included in the response body. Valid values:
     *
     * *   true: If the HTTP response body includes the alert rule, an alert is triggered.
     * *   false: If the HTTP response does not include the alert rule, an alert is triggered.
     *
     * > This parameter must be specified when TaskType is set to HTTP. For more information about how to configure the TaskType parameter, see [CreateHostAvailability](https://help.aliyun.com/document_detail/115317.html).
     *
     * @example
     * true
     */
    httpNegative?: boolean;
    /**
     * @remarks
     * The content of the HTTP POST request.
     *
     * @example
     * params1=value1
     */
    httpPostContent?: string;
    /**
     * @remarks
     * The character set that is used in the HTTP response.
     *
     * > Only UTF-8 is supported.
     *
     * @example
     * UTF-8
     */
    httpResponseCharset?: string;
    /**
     * @remarks
     * The response to the HTTP request.
     *
     * @example
     * ok
     */
    httpResponseMatchContent?: string;
    /**
     * @remarks
     * The URI that you want to monitor. This parameter is required if the TaskType parameter is set to HTTP or Telnet.
     *
     * @example
     * https://www.aliyun.com
     */
    httpURI?: string;
    /**
     * @remarks
     * The interval at which detection requests are sent. Unit: seconds. Valid values: 15, 30, 60, 120, 300, 900, 1800, and 3600.
     *
     * > This parameter is available only for the CloudMonitor agent V3.5.1 or later.
     *
     * @example
     * 60
     */
    interval?: number;
    /**
     * @remarks
     * The domain name or IP address that you want to monitor.
     *
     * >  This parameter is required if the TaskType parameter is set to PING. For more information about how to set the TaskType parameter, see [CreateHostAvailability](https://help.aliyun.com/document_detail/115317.html).
     *
     * @example
     * www.aliyun.com
     */
    telnetOrPingHost?: string;
    static names(): {
        [key: string]: string;
    };
    static types(): {
        [key: string]: any;
    };
    validate(): void;
    constructor(map?: {
        [key: string]: any;
    });
}
export declare class ModifyHostAvailabilityRequestAlertConfigEscalationList extends $dara.Model {
    /**
     * @remarks
     * The method used to calculate the metric values that trigger alerts. Valid values of N: 1 to 21. The value of this parameter varies based on the metric. The following items show the correspondence between metrics and calculation methods:
     *
     * *   HttpStatus: Value
     * *   HttpLatency: Average
     * *   TelnetStatus: Value
     * *   TelnetLatency: Average
     * *   PingLostRate: Average
     *
     * > The value Value indicates the original value and is used for metrics such as status codes. The value Average indicates the average value and is used for metrics such as the latency and packet loss rate.
     *
     * @example
     * Value
     */
    aggregate?: string;
    /**
     * @remarks
     * The metric for which the alert feature is enabled. Valid values of N: 1 to 21. Valid values:
     *
     * *   HttpStatus: HTTP status code
     * *   HttpLatency: HTTP response time
     * *   TelnetStatus: Telnet status code
     * *   TelnetLatency: Telnet response time
     * *   PingLostRate: Ping packet loss rate
     *
     * This parameter is required.
     *
     * @example
     * HttpStatus
     */
    metricName?: string;
    /**
     * @remarks
     * The comparison operator that is used in the alert rule. Valid values of N: 1 to 21. Valid values:
     *
     * *   `>`
     * *   `>=`
     * *   `<`
     * *   `<=`
     * *   `=`
     *
     * @example
     * >
     */
    operator?: string;
    /**
     * @remarks
     * The consecutive number of times for which the metric value meets the alert condition before an alert is triggered. Valid values of N: 1 to 21.
     *
     * @example
     * 3
     */
    times?: number;
    /**
     * @remarks
     * The alert threshold. Valid values of N: 1 to 21.
     *
     * @example
     * 3
     */
    value?: string;
    static names(): {
        [key: string]: string;
    };
    static types(): {
        [key: string]: any;
    };
    validate(): void;
    constructor(map?: {
        [key: string]: any;
    });
}
export declare class ModifyHostAvailabilityRequestAlertConfigTargetList extends $dara.Model {
    /**
     * @remarks
     * The Alibaba Cloud Resource Name (ARN) of the resource.
     *
     * Format: `acs:{Service name abbreviation}:{regionId}:{userId}:/{Resource type}/{Resource name}/message`. Example: `acs:mns:cn-hangzhou:120886317861****:/queues/test123/message`. Fields:
     *
     * *   {Service name abbreviation}: the abbreviation of the service name. Set the value to Simple Message Queue (formerly MNS) (SMQ).
     *
     * *   {userId}: the ID of the Alibaba Cloud account.
     *
     * *   {regionId}: the region ID of the SMQ queue or topic.
     *
     * *   {Resource type}: the type of the resource for which alerts are triggered. Valid values:
     *
     *     *   **queues**
     *     *   **topics**
     *
     * *   {Resource name}: the resource name.
     *
     *     *   If the resource type is **queues**, the resource name is the queue name.
     *     *   If the resource type is **topics**, the resource name is the topic name.
     *
     * @example
     * acs:mns:cn-hangzhou:111:/queues/test/message
     */
    arn?: string;
    /**
     * @remarks
     * The ID of the resource for which alerts are triggered.
     *
     * @example
     * 1
     */
    id?: string;
    /**
     * @remarks
     * The parameters of the alert callback. The parameters are in the JSON format.
     *
     * @example
     * {"customField1":"value1","customField2":"$.name"}
     */
    jsonParams?: string;
    /**
     * @remarks
     * The alert level. Valid values:
     *
     * *   INFO
     * *   WARN
     * *   CRITICAL
     *
     * @example
     * ["INFO", "WARN", "CRITICAL"]
     */
    level?: string;
    static names(): {
        [key: string]: string;
    };
    static types(): {
        [key: string]: any;
    };
    validate(): void;
    constructor(map?: {
        [key: string]: any;
    });
}
export declare class ModifyHostAvailabilityRequest extends $dara.Model {
    alertConfig?: ModifyHostAvailabilityRequestAlertConfig;
    taskOption?: ModifyHostAvailabilityRequestTaskOption;
    /**
     * @remarks
     * The alert configurations.
     *
     * This parameter is required.
     */
    alertConfigEscalationList?: ModifyHostAvailabilityRequestAlertConfigEscalationList[];
    /**
     * @remarks
     * The information about the resources for which alerts are triggered.
     */
    alertConfigTargetList?: ModifyHostAvailabilityRequestAlertConfigTargetList[];
    /**
     * @remarks
     * The ID of the application group.
     *
     * This parameter is required.
     *
     * @example
     * 123456
     */
    groupId?: number;
    /**
     * @remarks
     * The ID of the availability monitoring task.
     *
     * This parameter is required.
     *
     * @example
     * 12345
     */
    id?: number;
    /**
     * @remarks
     * The ECS instances that are monitored. Valid values of N: 1 to 21.
     *
     * > This parameter must be specified when `TaskScope` is set to `GROUP_SPEC_INSTANCE`.
     *
     * @example
     * i-absdfkwl321****
     */
    instanceList?: string[];
    regionId?: string;
    /**
     * @remarks
     * The name of the availability monitoring task.
     *
     * This parameter is required.
     *
     * @example
     * task2
     */
    taskName?: string;
    /**
     * @remarks
     * The range of instances that are monitored by the availability monitoring task. Valid values:
     *
     * *   GROUP: All ECS instances in the application group are monitored.
     * *   GROUP_SPEC_INSTANCE: Specified ECS instances in the application group are monitored. The TaskScope parameter must be used in combination with the InstanceList parameter. The InstanceList parameter specifies the ECS instances to be monitored.
     *
     * @example
     * GROUP
     */
    taskScope?: string;
    static names(): {
        [key: string]: string;
    };
    static types(): {
        [key: string]: any;
    };
    validate(): void;
    constructor(map?: {
        [key: string]: any;
    });
}