tencent cloud

ModifyInspectionSettings
Last updated: 2025-11-13 20:49:09
ModifyInspectionSettings
Last updated: 2025-11-13 20:49:09

1. API Description

Domain name for API request: emr.intl.tencentcloudapi.com.

This API is used to set inspection task configurations.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: ModifyInspectionSettings.
Version Yes String Common Params. The value used for this API: 2019-01-03.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID.
Type Yes String Inspection type, FixedTime or RealTime.
Settings.N Yes Array of InspectionTaskSettings Task configurations.
StartTime No Integer Start timestamp.
EndTime No Integer End timestamp.
Strategy No String Inspection cycle, such as EveryDay, EveryWeek or EveryMonth.
Clock No String Start time of each day.
DayOfWeek No String Day of the week.
DayOfMonth No String Number of the day in a month.
JobId No String Inspection job ID.

3. Output Parameters

Parameter Name Type Description
Info String Description of the returned value.
JobId String ID of the successfully modified inspection task.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Inspection Task Configuration Setting

Input Example

POST / HTTP/1.1
Host: emr.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyInspectionSettings

{
    "StartTime": 1741795200,
    "EndTime": 1741837980,
    "InstanceId": "emr-mwyixwxp",
    "Type": "RealTime",
    "Settings": [
        {
            "Name": "CPU Utilization Exceeding the Threshold Consecutively",
            "Group": "Node",
            "TaskType": "CpuUsageMoreThanThreshold",
            "Selected": "true",
            "TaskSettings": [
                {
                    "Key": "Threshold",
                    "Name": "Threshold",
                    "Value": "85",
                    "Editable": "true"
                },
                {
                    "Key": "WindowSize",
                    "Name": "Duration (seconds)",
                    "Value": "1800",
                    "Editable": "true"
                }
            ]
        },
        {
            "Name": "CPU IOwait Mean Exceeding the Threshold",
            "Group": "Node",
            "TaskType": "CpuIOWaitAvgMoreThanThreshold",
            "Selected": "true",
            "TaskSettings": [
                {
                    "Key": "Threshold",
                    "Name": "Threshold",
                    "Value": "60",
                    "Editable": "true"
                },
                {
                    "Key": "WindowSize",
                    "Name": "Duration (seconds)",
                    "Value": "1800",
                    "Editable": "true"
                }
            ]
        },
        {
            "Name": "CPU Utilization Exceeding the Threshold Continuously",
            "Group": "Node",
            "TaskType": "MemoryFreeException",
            "Selected": "true",
            "TaskSettings": [
                {
                    "Key": "Threshold",
                    "Name": "Threshold",
                    "Value": "85",
                    "Editable": "true"
                },
                {
                    "Key": "WindowSize",
                    "Name": "Duration (seconds)",
                    "Value": "1800",
                    "Editable": "true"
                }
            ]
        },
        {
            "Name": "System Process Quantity Exceeding the Threshold Continuously",
            "Group": "Node",
            "TaskType": "ProcessCntMoreThanThreshold",
            "Selected": "true",
            "TaskSettings": [
                {
                    "Key": "Threshold",
                    "Name": "Threshold",
                    "Value": "10000",
                    "Editable": "true"
                },
                {
                    "Key": "WindowSize",
                    "Name": "Duration (seconds)",
                    "Value": "1800",
                    "Editable": "true"
                }
            ]
        },
        {
            "Name": "Metadatabase Exception",
            "Group": "Node",
            "TaskType": "MetaDBPingFail",
            "Selected": "true",
            "TaskSettings": []
        },
        {
            "Name": "HDFS Storage Space Utilization Exceeding the Threshold Continuously",
            "Group": "HDFS",
            "TaskType": "HDFSCapacityUsedRateMoreThanThreshold",
            "Selected": "true",
            "TaskSettings": [
                {
                    "Key": "Threshold",
                    "Name": "Threshold",
                    "Value": "85",
                    "Editable": "true"
                },
                {
                    "Key": "WindowSize",
                    "Name": "Duration (seconds)",
                    "Value": "1800",
                    "Editable": "true"
                }
            ]
        },
        {
            "Name": "NameNode Primary/Secondary Switch Occurs",
            "Group": "HDFS",
            "TaskType": "HDFSNameNodeSwitch",
            "Selected": "true",
            "TaskSettings": []
        },
        {
            "Name": "NameNode Full GC Occurs",
            "Group": "HDFS",
            "TaskType": "NameNodeFullGC",
            "Selected": "true",
            "TaskSettings": []
        },
        {
            "Name": "NameNode JVM Memory Utilization Exceeding the Threshold Continuously",
            "Group": "HDFS",
            "TaskType": "NameNodeJvmMemoryUsageMoreThanThreshold",
            "Selected": "true",
            "TaskSettings": [
                {
                    "Key": "Threshold",
                    "Name": "Threshold",
                    "Value": "85",
                    "Editable": "true"
                },
                {
                    "Key": "WindowSize",
                    "Name": "Duration (seconds)",
                    "Value": "1800",
                    "Editable": "true"
                }
            ]
        },
        {
            "Name": "ResourceManager Primary/Secondary Switch",
            "Group": "YARN",
            "TaskType": "YarnRMSwitch",
            "Selected": "true",
            "TaskSettings": []
        },
        {
            "Name": "ResourceManager Full GC Occurs",
            "Group": "YARN",
            "TaskType": "YarnRmFullGCMoreThanThreshold",
            "Selected": "true",
            "TaskSettings": []
        },
        {
            "Name": "ResourceManager JVM Memory Utilization Exceeding the Threshold Continuously",
            "Group": "YARN",
            "TaskType": "YarnRmJvmMemoryUsageMoreThanThreshold",
            "Selected": "true",
            "TaskSettings": [
                {
                    "Key": "Threshold",
                    "Name": "RM JVM Memory Utilization",
                    "Value": "85",
                    "Editable": "true"
                },
                {
                    "Key": "WindowSize",
                    "Name": "Duration (seconds)",
                    "Value": "1800",
                    "Editable": "true"
                }
            ]
        },
        {
            "Name": "RIT Cluster Region Quantity Exceeding the Threshold Continuously",
            "Group": "HBASE",
            "TaskType": "HbaseRitRegionNumMoreThanThreshold",
            "Selected": "true",
            "TaskSettings": [
                {
                    "Key": "Threshold",
                    "Name": "Rit Region Quantity",
                    "Value": "1",
                    "Editable": "true"
                },
                {
                    "Key": "WindowSize",
                    "Name": "Duration (seconds)",
                    "Value": "60",
                    "Editable": "true"
                }
            ]
        },
        {
            "Name": "HMaster JVM Memory Utilization Exceeding the Threshold Continuously",
            "Group": "HBASE",
            "TaskType": "HbaseHmJvmMemoryUsageMoreThanThreshold",
            "Selected": "true",
            "TaskSettings": [
                {
                    "Key": "Threshold",
                    "Name": "HMaster JVM Memory Utilization",
                    "Value": "85",
                    "Editable": "true"
                },
                {
                    "Key": "WindowSize",
                    "Name": "Duration (seconds)",
                    "Value": "1800",
                    "Editable": "true"
                }
            ]
        },
        {
            "Name": "HiveServer2 Full GC Occurs",
            "Group": "HIVE",
            "TaskType": "HiveServer2FullGC",
            "Selected": "true",
            "TaskSettings": []
        },
        {
            "Name": "HiveServer2 JVM Memory Utilization Exceeding the Threshold Continuously",
            "Group": "HIVE",
            "TaskType": "HiveServer2JvmMemoryUsageMoreThanThreshold",
            "Selected": "true",
            "TaskSettings": [
                {
                    "Key": "Threshold",
                    "Name": "HiveServer2 JVM Memory Utilization",
                    "Value": "85",
                    "Editable": "true"
                },
                {
                    "Key": "WindowSize",
                    "Name": "Duration (seconds)",
                    "Value": "1800",
                    "Editable": "true"
                }
            ]
        },
        {
            "Name": "Impala Beeswax API Client Connection Quantity Utilization Exceeding the Threshold",
            "Group": "IMPALA",
            "TaskType": "ImpalaThriftServerBeeswaxFrontendConnMoreThanThreshold",
            "Selected": "true",
            "TaskSettings": [
                {
                    "Key": "Threshold",
                    "Name": "Impala Beeswax API Client Connection Quantity",
                    "Value": "64",
                    "Editable": "true"
                }
            ]
        },
        {
            "Name": " Impala HS2 Client Connection Quantity Utilization Exceeding the Threshold",
            "Group": "IMPALA",
            "TaskType": "ImpalaThriftServerHS2ConnMoreThanThrshold",
            "Selected": "true",
            "TaskSettings": [
                {
                    "Key": "Threshold",
                    "Name": "Impala HS2 Client Connection Quantity",
                    "Value": "64",
                    "Editable": "true"
                }
            ]
        },
        {
            "Name": "JVM OLD Region Exception",
            "Group": "Cluster",
            "TaskType": "JVMOldException",
            "Selected": "true",
            "TaskSettings": []
        },
        {
            "Name": "Single-Disk INODES Utilization Exceeding the Threshold Continuously",
            "Group": "Node",
            "TaskType": "SingleDiskInMoreThanThreshold",
            "Selected": "true",
            "TaskSettings": [
                {
                    "Key": "Threshold",
                    "Name": "Threshold",
                    "Value": "85",
                    "Editable": "true"
                },
                {
                    "Key": "WindowSize",
                    "Name": "Duration (seconds)",
                    "Value": "1800",
                    "Editable": "true"
                }
            ]
        },
        {
            "Name": "Single-Disk I/O Device Utilization Exceeding the Threshold Continuously",
            "Group": "Node",
            "TaskType": "SingleDiskUtilMoreThanThreshold",
            "Selected": "true",
            "TaskSettings": [
                {
                    "Key": "Threshold",
                    "Name": "Threshold",
                    "Value": "85",
                    "Editable": "true"
                },
                {
                    "Key": "WindowSize",
                    "Name": "Duration (seconds)",
                    "Value": "1800",
                    "Editable": "true"
                }
            ]
        },
        {
            "Name": "Single-Disk Space Utilization Exceeding the Threshold Continuously",
            "Group": "Node",
            "TaskType": "SingleDiskSpaceMoreThanThreshold",
            "Selected": "true",
            "TaskSettings": [
                {
                    "Key": "Threshold",
                    "Name": "Threshold",
                    "Value": "85",
                    "Editable": "true"
                },
                {
                    "Key": "WindowSize",
                    "Name": "Duration (seconds)",
                    "Value": "1800",
                    "Editable": "true"
                }
            ]
        },
        {
            "Name": "HBase: Both HMaster Services in Standby Status",
            "Group": "HBASE",
            "TaskType": "HmStandbyStatusMoreThanThreshold",
            "Selected": "true",
            "TaskSettings": [
                {
                    "Key": "WindowSize",
                    "Name": "Both HMaster Nodes in Standby Status Simultaneously for Over 90 Seconds, Exceeding the Metric Value Range (second)",
                    "Value": "300",
                    "Editable": "true"
                }
            ]
        },
        {
            "Name": "HDFS: Both NameNode Services in Standby Status",
            "Group": "HDFS",
            "TaskType": "NNStandbyStatusMoreThanThreshold",
            "Selected": "true",
            "TaskSettings": [
                {
                    "Key": "WindowSize",
                    "Name": "Both NameNode Nodes in Standby Status Simultaneously for Over 90 seconds, Exceeding the Metric Value Range (seconds).",
                    "Value": "300",
                    "Editable": "true"
                }
            ]
        },
        {
            "Name": "UTC-to-NTP Time Offset of the Sub-machine Exceeding the Threshold",
            "Group": "Node",
            "TaskType": "NodeUTCNTPTimeOffsetMoreThanThreshold",
            "Selected": "true",
            "TaskSettings": [
                {
                    "Key": "Threshold",
                    "Name": "Threshold",
                    "Value": "30000",
                    "Editable": "true"
                }
            ]
        },
        {
            "Name": "HDFS: NameNode Entering the Security Mode",
            "Group": "HDFS",
            "TaskType": "HDFSNameNodeEnterSafeMode",
            "Selected": "true",
            "TaskSettings": []
        },
        {
            "Name": "HDFS: MissingBlocks Quantity Exceeds the Threshold Continuously",
            "Group": "HDFS",
            "TaskType": "HDFSMissingBlocksNumMoreThanThreshold",
            "Selected": "true",
            "TaskSettings": [
                {
                    "Key": "Threshold",
                    "Name": "Threshold",
                    "Value": "1",
                    "Editable": "true"
                },
                {
                    "Key": "WindowSize",
                    "Name": "Duration (seconds)",
                    "Value": "1800",
                    "Editable": "true"
                }
            ]
        },
        {
            "Name": "Node Fault",
            "Group": "Node",
            "TaskType": "NodeFailure",
            "Selected": "true",
            "TaskSettings": []
        },
        {
            "Name": "Node Disk I/O Exception",
            "Group": "Node",
            "TaskType": "DiskIOError",
            "Selected": "true",
            "TaskSettings": []
        },
        {
            "Name": "Service Role Health Status Exception",
            "Group": "Cluster",
            "TaskType": "ProcessDetectionAbnormal",
            "Selected": "true",
            "TaskSettings": [
                {
                    "Key": "WindowSize",
                    "Name": "Duration (seconds)",
                    "Value": "300",
                    "Editable": "true"
                }
            ]
        },
        {
            "Name": "Execution Failure of Auto-Scaling Policy",
            "Group": "Cluster",
            "TaskType": "AutoScaleStrategyFailure",
            "Selected": "true",
            "TaskSettings": []
        },
        {
            "Name": "Execution Timeout of Auto-Scaling Policy",
            "Group": "Cluster",
            "TaskType": "AutoScaleStrategyTimeOut",
            "Selected": "true",
            "TaskSettings": []
        },
        {
            "Name": "HMaster Primary/Secondary Switch Occurs",
            "Group": "HBASE",
            "TaskType": "HMasterSwitch",
            "Selected": "true",
            "TaskSettings": []
        },
        {
            "Name": "ZooKeeper Leader Switch Occurs",
            "Group": "ZOOKEEPER",
            "TaskType": "ZKLeaderSwitch",
            "Selected": "true",
            "TaskSettings": []
        },
        {
            "Name": "YARN ResourceManager Not Active",
            "Group": "YARN",
            "TaskType": "YarnRmNoActiveStatusMoreThanThreshold",
            "Selected": "true",
            "TaskSettings": [
                {
                    "Key": "WindowSize",
                    "Name": "Yarn ResourceManager Service Not Active, Duration (seconds)",
                    "Value": "90",
                    "Editable": "true"
                }
            ]
        },
        {
            "Name": "Process Killed by OOM Killer",
            "Group": "Cluster",
            "TaskType": "ProcessOutOfMemory",
            "Selected": "true",
            "TaskSettings": []
        },
        {
            "Name": "Instance Hard Disk Exception, Pending Authorization",
            "Group": "Node",
            "TaskType": "InstanceDiskErrorInquiring",
            "Selected": "true",
            "TaskSettings": []
        },
        {
            "Name": "Instance Running Exception, Pending Authorization",
            "Group": "Node",
            "TaskType": "InstanceRunningAbnormallyInquiring",
            "Selected": "true",
            "TaskSettings": []
        },
        {
            "Name": "Sub-machine NVMe Device Error",
            "Group": "Node",
            "TaskType": "NvmeError",
            "Selected": "true",
            "TaskSettings": []
        },
        {
            "Name": "Machine Restart",
            "Group": "Node",
            "TaskType": "GuestReboot",
            "Selected": "true",
            "TaskSettings": []
        },
        {
            "Name": "OOM",
            "Group": "Node",
            "TaskType": "GuestOom",
            "Selected": "true",
            "TaskSettings": []
        },
        {
            "Name": "Kernel Fault",
            "Group": "Node",
            "TaskType": "GuestCoreError",
            "Selected": "true",
            "TaskSettings": []
        },
        {
            "Name": "Read-Only Disk",
            "Group": "Node",
            "TaskType": "CvmDiskReadonly",
            "Selected": "true",
            "TaskSettings": []
        },
        {
            "Name": "Unreachable by Ping",
            "Group": "Node",
            "TaskType": "PingUnreachable",
            "Selected": "true",
            "TaskSettings": []
        },
        {
            "Name": "Enabled Public Network Access Exposing Security Group Ports to Risks",
            "Group": "Cluster",
            "TaskType": "NetworkSecurityHighRiskPortDetection",
            "Selected": "true",
            "TaskSettings": []
        },
        {
            "Name": "HDFS Directory Getting Full",
            "Group": "HDFS",
            "TaskType": "HdfsDirFull",
            "Selected": "true",
            "TaskSettings": [
                {
                    "Key": "Threshold",
                    "Name": "Percentage Threshold",
                    "Value": "95",
                    "Editable": "true"
                }
            ]
        },
        {
            "Name": "Trino Full-Table Scan Partition Table",
            "Group": "TRINO",
            "TaskType": "TrinoFullScanPartTable",
            "Selected": "false",
            "TaskSettings": []
        }
    ]
}

Output Example

{
    "Response": {
        "Info": "OK",
        "JobId": "499",
        "RequestId": "c1ff0d96-48a7-47ef-bdde-ab6bf1fc5f15"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InvalidParameter Invalid parameter.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback