com.tencentcloudapi.monitor.v20180724

Class MonitorClient

java.lang.Object

com.tencentcloudapi.common.AbstractClient

com.tencentcloudapi.monitor.v20180724.MonitorClient

public class MonitorClient
extends AbstractClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors

Constructor and Description
MonitorClient(Credential credential, String region)
MonitorClient(Credential credential, String region, ClientProfile profile)

Method Summary

Modifier and Type	Method and Description
BindingPolicyObjectResponse	BindingPolicyObject(BindingPolicyObjectRequest req) This API is used to bind an alarm policy to a specific object.
CreateAlarmNoticeResponse	CreateAlarmNotice(CreateAlarmNoticeRequest req) This API is used to create a notification template.
CreateAlarmPolicyResponse	CreateAlarmPolicy(CreateAlarmPolicyRequest req) This API is used to create an alarm policy.
CreatePolicyGroupResponse	CreatePolicyGroup(CreatePolicyGroupRequest req) This API is used to add a policy group.
DeleteAlarmNoticesResponse	DeleteAlarmNotices(DeleteAlarmNoticesRequest req) This API is used to delete alarm notification templates.
DeleteAlarmPolicyResponse	DeleteAlarmPolicy(DeleteAlarmPolicyRequest req) This API is used to delete an alarm policy.
DeletePolicyGroupResponse	DeletePolicyGroup(DeletePolicyGroupRequest req) This API is used to delete an alarm policy group.
DescribeAccidentEventListResponse	DescribeAccidentEventList(DescribeAccidentEventListRequest req) This API is used to get the platform event list.
DescribeAlarmEventsResponse	DescribeAlarmEvents(DescribeAlarmEventsRequest req) This API is used to query the list of alarm events.
DescribeAlarmHistoriesResponse	DescribeAlarmHistories(DescribeAlarmHistoriesRequest req) This API is used to query the alarm records.
DescribeAlarmMetricsResponse	DescribeAlarmMetrics(DescribeAlarmMetricsRequest req) This API is used to query the list of alarm metrics.
DescribeAlarmNoticeResponse	DescribeAlarmNotice(DescribeAlarmNoticeRequest req) This API is used to query the details of a single notification template.
DescribeAlarmNoticeCallbacksResponse	DescribeAlarmNoticeCallbacks(DescribeAlarmNoticeCallbacksRequest req) This API is used to get all the callback URLs of an alarm notification template.
DescribeAlarmNoticesResponse	DescribeAlarmNotices(DescribeAlarmNoticesRequest req) This API is used to query the list of notification templates.
DescribeAlarmPoliciesResponse	DescribeAlarmPolicies(DescribeAlarmPoliciesRequest req) This API is used to query the list of alarm policies.
DescribeAlarmPolicyResponse	DescribeAlarmPolicy(DescribeAlarmPolicyRequest req) This API is used to get the details of a single alarm policy.
DescribeAllNamespacesResponse	DescribeAllNamespaces(DescribeAllNamespacesRequest req) This API is used to query all namespaces.
DescribeBaseMetricsResponse	DescribeBaseMetrics(DescribeBaseMetricsRequest req) This API is used to get the attributes of basic metrics.
DescribeBasicAlarmListResponse	DescribeBasicAlarmList(DescribeBasicAlarmListRequest req) This API is used to get the basic alarm list.
DescribeBindingPolicyObjectListResponse	DescribeBindingPolicyObjectList(DescribeBindingPolicyObjectListRequest req) This API is used to get the bound object list.
DescribeMonitorTypesResponse	DescribeMonitorTypes(DescribeMonitorTypesRequest req) This API is used to list all the monitor types supported by CM.
DescribePolicyConditionListResponse	DescribePolicyConditionList(DescribePolicyConditionListRequest req) This API is used to get basic alarm policy conditions.
DescribePolicyGroupInfoResponse	DescribePolicyGroupInfo(DescribePolicyGroupInfoRequest req) This API is used to get details of a basic policy group.
DescribePolicyGroupListResponse	DescribePolicyGroupList(DescribePolicyGroupListRequest req) This API is used to get the list of basic policy alarm groups.
DescribeProductEventListResponse	DescribeProductEventList(DescribeProductEventListRequest req) This API is used to get the list of product events by page.
DescribeStatisticDataResponse	DescribeStatisticData(DescribeStatisticDataRequest req) This API is used to query monitoring data by dimension conditions.
GetMonitorDataResponse	GetMonitorData(GetMonitorDataRequest req) This API is used to get the monitoring data of Tencent Cloud services except TKE.
ModifyAlarmNoticeResponse	ModifyAlarmNotice(ModifyAlarmNoticeRequest req) This API is used to edit an alarm notification template.
ModifyAlarmPolicyConditionResponse	ModifyAlarmPolicyCondition(ModifyAlarmPolicyConditionRequest req) This API is used to modify the trigger condition of an alarm policy.
ModifyAlarmPolicyInfoResponse	ModifyAlarmPolicyInfo(ModifyAlarmPolicyInfoRequest req) This API is used to edit the basic information of a v2.0 alarm policy, including policy name and remarks.
ModifyAlarmPolicyNoticeResponse	ModifyAlarmPolicyNotice(ModifyAlarmPolicyNoticeRequest req) This API is used to modify the alarm notification template bound to an alarm policy.
ModifyAlarmPolicyStatusResponse	ModifyAlarmPolicyStatus(ModifyAlarmPolicyStatusRequest req) This API is used to enable/disable an alarm policy.
ModifyAlarmPolicyTasksResponse	ModifyAlarmPolicyTasks(ModifyAlarmPolicyTasksRequest req) This API is used to modify the task triggered by an alarm policy.
ModifyAlarmReceiversResponse	ModifyAlarmReceivers(ModifyAlarmReceiversRequest req) This API is used to modify alarm recipients.
ModifyPolicyGroupResponse	ModifyPolicyGroup(ModifyPolicyGroupRequest req) This API is used to update policy group.
PutMonitorDataResponse	PutMonitorData(PutMonitorDataRequest req) The default API request rate limit is 50 requests/sec.
SendCustomAlarmMsgResponse	SendCustomAlarmMsg(SendCustomAlarmMsgRequest req) This API is used to send a custom alarm notification.
SetDefaultAlarmPolicyResponse	SetDefaultAlarmPolicy(SetDefaultAlarmPolicyRequest req) This API is used to set an alarm policy as the default policy in the current policy type under the current project.
UnBindingAllPolicyObjectResponse	UnBindingAllPolicyObject(UnBindingAllPolicyObjectRequest req) This API is used to delete all bound objects.
UnBindingPolicyObjectResponse	UnBindingPolicyObject(UnBindingPolicyObjectRequest req) This API is used to delete an object that is bound to a policy.

Methods inherited from class com.tencentcloudapi.common.AbstractClient

call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MonitorClient

public MonitorClient(Credential credential,
                     String region)

MonitorClient

public MonitorClient(Credential credential,
                     String region,
                     ClientProfile profile)

Method Detail

BindingPolicyObject

public BindingPolicyObjectResponse BindingPolicyObject(BindingPolicyObjectRequest req)
                                                throws TencentCloudSDKException

This API is used to bind an alarm policy to a specific object.

Parameters:

req - BindingPolicyObjectRequest

Returns:

BindingPolicyObjectResponse

Throws:

TencentCloudSDKException

CreateAlarmNotice

public CreateAlarmNoticeResponse CreateAlarmNotice(CreateAlarmNoticeRequest req)
                                            throws TencentCloudSDKException

This API is used to create a notification template.

Parameters:

req - CreateAlarmNoticeRequest

Returns:

CreateAlarmNoticeResponse

Throws:

TencentCloudSDKException

CreateAlarmPolicy

public CreateAlarmPolicyResponse CreateAlarmPolicy(CreateAlarmPolicyRequest req)
                                            throws TencentCloudSDKException

This API is used to create an alarm policy.

Parameters:

req - CreateAlarmPolicyRequest

Returns:

CreateAlarmPolicyResponse

Throws:

TencentCloudSDKException

CreatePolicyGroup

public CreatePolicyGroupResponse CreatePolicyGroup(CreatePolicyGroupRequest req)
                                            throws TencentCloudSDKException

This API is used to add a policy group.

Parameters:

req - CreatePolicyGroupRequest

Returns:

CreatePolicyGroupResponse

Throws:

TencentCloudSDKException

DeleteAlarmNotices

public DeleteAlarmNoticesResponse DeleteAlarmNotices(DeleteAlarmNoticesRequest req)
                                              throws TencentCloudSDKException

This API is used to delete alarm notification templates.

Parameters:

req - DeleteAlarmNoticesRequest

Returns:

DeleteAlarmNoticesResponse

Throws:

TencentCloudSDKException

DeleteAlarmPolicy

public DeleteAlarmPolicyResponse DeleteAlarmPolicy(DeleteAlarmPolicyRequest req)
                                            throws TencentCloudSDKException

This API is used to delete an alarm policy.

Parameters:

req - DeleteAlarmPolicyRequest

Returns:

DeleteAlarmPolicyResponse

Throws:

TencentCloudSDKException

DeletePolicyGroup

public DeletePolicyGroupResponse DeletePolicyGroup(DeletePolicyGroupRequest req)
                                            throws TencentCloudSDKException

This API is used to delete an alarm policy group.

Parameters:

req - DeletePolicyGroupRequest

Returns:

DeletePolicyGroupResponse

Throws:

TencentCloudSDKException

DescribeAccidentEventList

public DescribeAccidentEventListResponse DescribeAccidentEventList(DescribeAccidentEventListRequest req)
                                                            throws TencentCloudSDKException

This API is used to get the platform event list.

Parameters:

req - DescribeAccidentEventListRequest

Returns:

DescribeAccidentEventListResponse

Throws:

TencentCloudSDKException

DescribeAlarmEvents

public DescribeAlarmEventsResponse DescribeAlarmEvents(DescribeAlarmEventsRequest req)
                                                throws TencentCloudSDKException

This API is used to query the list of alarm events.

Parameters:

req - DescribeAlarmEventsRequest

Returns:

DescribeAlarmEventsResponse

Throws:

TencentCloudSDKException

DescribeAlarmHistories

public DescribeAlarmHistoriesResponse DescribeAlarmHistories(DescribeAlarmHistoriesRequest req)
                                                      throws TencentCloudSDKException

This API is used to query the alarm records. Note: **If you query the alarm records as a sub-user, you can only query those of authorized projects** or those of products which are not categorized by projects. For information on how to grant a sub-account the project permission, see [Project & Tag](https://intl.cloud.tencent.com/document/product/598/32738?from_cn_redirect=1).

Parameters:

req - DescribeAlarmHistoriesRequest

Returns:

DescribeAlarmHistoriesResponse

Throws:

TencentCloudSDKException

DescribeAlarmMetrics

public DescribeAlarmMetricsResponse DescribeAlarmMetrics(DescribeAlarmMetricsRequest req)
                                                  throws TencentCloudSDKException

This API is used to query the list of alarm metrics.

Parameters:

req - DescribeAlarmMetricsRequest

Returns:

DescribeAlarmMetricsResponse

Throws:

TencentCloudSDKException

DescribeAlarmNotice

public DescribeAlarmNoticeResponse DescribeAlarmNotice(DescribeAlarmNoticeRequest req)
                                                throws TencentCloudSDKException

This API is used to query the details of a single notification template.

Parameters:

req - DescribeAlarmNoticeRequest

Returns:

DescribeAlarmNoticeResponse

Throws:

TencentCloudSDKException

DescribeAlarmNoticeCallbacks

public DescribeAlarmNoticeCallbacksResponse DescribeAlarmNoticeCallbacks(DescribeAlarmNoticeCallbacksRequest req)
                                                                  throws TencentCloudSDKException

This API is used to get all the callback URLs of an alarm notification template.

Parameters:

req - DescribeAlarmNoticeCallbacksRequest

Returns:

DescribeAlarmNoticeCallbacksResponse

Throws:

TencentCloudSDKException

DescribeAlarmNotices

public DescribeAlarmNoticesResponse DescribeAlarmNotices(DescribeAlarmNoticesRequest req)
                                                  throws TencentCloudSDKException

This API is used to query the list of notification templates.

Parameters:

req - DescribeAlarmNoticesRequest

Returns:

DescribeAlarmNoticesResponse

Throws:

TencentCloudSDKException

DescribeAlarmPolicies

public DescribeAlarmPoliciesResponse DescribeAlarmPolicies(DescribeAlarmPoliciesRequest req)
                                                    throws TencentCloudSDKException

This API is used to query the list of alarm policies.

Parameters:

req - DescribeAlarmPoliciesRequest

Returns:

DescribeAlarmPoliciesResponse

Throws:

TencentCloudSDKException

DescribeAlarmPolicy

public DescribeAlarmPolicyResponse DescribeAlarmPolicy(DescribeAlarmPolicyRequest req)
                                                throws TencentCloudSDKException

This API is used to get the details of a single alarm policy.

Parameters:

req - DescribeAlarmPolicyRequest

Returns:

DescribeAlarmPolicyResponse

Throws:

TencentCloudSDKException

DescribeAllNamespaces

public DescribeAllNamespacesResponse DescribeAllNamespaces(DescribeAllNamespacesRequest req)
                                                    throws TencentCloudSDKException

This API is used to query all namespaces.

Parameters:

req - DescribeAllNamespacesRequest

Returns:

DescribeAllNamespacesResponse

Throws:

TencentCloudSDKException

DescribeBaseMetrics

public DescribeBaseMetricsResponse DescribeBaseMetrics(DescribeBaseMetricsRequest req)
                                                throws TencentCloudSDKException

This API is used to get the attributes of basic metrics.

Parameters:

req - DescribeBaseMetricsRequest

Returns:

DescribeBaseMetricsResponse

Throws:

TencentCloudSDKException

DescribeBasicAlarmList

public DescribeBasicAlarmListResponse DescribeBasicAlarmList(DescribeBasicAlarmListRequest req)
                                                      throws TencentCloudSDKException

This API is used to get the basic alarm list.

Parameters:

req - DescribeBasicAlarmListRequest

Returns:

DescribeBasicAlarmListResponse

Throws:

TencentCloudSDKException

DescribeBindingPolicyObjectList

public DescribeBindingPolicyObjectListResponse DescribeBindingPolicyObjectList(DescribeBindingPolicyObjectListRequest req)
                                                                        throws TencentCloudSDKException

This API is used to get the bound object list.

Parameters:

req - DescribeBindingPolicyObjectListRequest

Returns:

DescribeBindingPolicyObjectListResponse

Throws:

TencentCloudSDKException

DescribeMonitorTypes

public DescribeMonitorTypesResponse DescribeMonitorTypes(DescribeMonitorTypesRequest req)
                                                  throws TencentCloudSDKException

This API is used to list all the monitor types supported by CM.

Parameters:

req - DescribeMonitorTypesRequest

Returns:

DescribeMonitorTypesResponse

Throws:

TencentCloudSDKException

DescribePolicyConditionList

public DescribePolicyConditionListResponse DescribePolicyConditionList(DescribePolicyConditionListRequest req)
                                                                throws TencentCloudSDKException

This API is used to get basic alarm policy conditions.

Parameters:

req - DescribePolicyConditionListRequest

Returns:

DescribePolicyConditionListResponse

Throws:

TencentCloudSDKException

DescribePolicyGroupInfo

public DescribePolicyGroupInfoResponse DescribePolicyGroupInfo(DescribePolicyGroupInfoRequest req)
                                                        throws TencentCloudSDKException

This API is used to get details of a basic policy group.

Parameters:

req - DescribePolicyGroupInfoRequest

Returns:

DescribePolicyGroupInfoResponse

Throws:

TencentCloudSDKException

DescribePolicyGroupList

public DescribePolicyGroupListResponse DescribePolicyGroupList(DescribePolicyGroupListRequest req)
                                                        throws TencentCloudSDKException

This API is used to get the list of basic policy alarm groups.

Parameters:

req - DescribePolicyGroupListRequest

Returns:

DescribePolicyGroupListResponse

Throws:

TencentCloudSDKException

DescribeProductEventList

public DescribeProductEventListResponse DescribeProductEventList(DescribeProductEventListRequest req)
                                                          throws TencentCloudSDKException

This API is used to get the list of product events by page.

Parameters:

req - DescribeProductEventListRequest

Returns:

DescribeProductEventListResponse

Throws:

TencentCloudSDKException

DescribeStatisticData

public DescribeStatisticDataResponse DescribeStatisticData(DescribeStatisticDataRequest req)
                                                    throws TencentCloudSDKException

This API is used to query monitoring data by dimension conditions.

Parameters:

req - DescribeStatisticDataRequest

Returns:

DescribeStatisticDataResponse

Throws:

TencentCloudSDKException

GetMonitorData

public GetMonitorDataResponse GetMonitorData(GetMonitorDataRequest req)
                                      throws TencentCloudSDKException

This API is used to get the monitoring data of Tencent Cloud services except TKE. To pull TKE’s monitoring data, please use the API [DescribeStatisticData](https://intl.cloud.tencent.com/document/product/248/51845?from_cn_redirect=1). You can get the monitoring data of a Tencent Cloud service by passing in its namespace, object dimension description, and monitoring metrics. API call rate limit: 20 calls/second (1,200 calls/minute). A single request can get the data of up to 10 instances for up to 1,440 data points. If you need to call a large number of APIs to pull metrics or objects at a time, some APIs may fail to be called due to the rate limit. We suggest you evenly arrange API calls at a time granularity.

Parameters:

req - GetMonitorDataRequest

Returns:

GetMonitorDataResponse

Throws:

TencentCloudSDKException

ModifyAlarmNotice

public ModifyAlarmNoticeResponse ModifyAlarmNotice(ModifyAlarmNoticeRequest req)
                                            throws TencentCloudSDKException

This API is used to edit an alarm notification template.

Parameters:

req - ModifyAlarmNoticeRequest

Returns:

ModifyAlarmNoticeResponse

Throws:

TencentCloudSDKException

ModifyAlarmPolicyCondition

public ModifyAlarmPolicyConditionResponse ModifyAlarmPolicyCondition(ModifyAlarmPolicyConditionRequest req)
                                                              throws TencentCloudSDKException

This API is used to modify the trigger condition of an alarm policy.

Parameters:

req - ModifyAlarmPolicyConditionRequest

Returns:

ModifyAlarmPolicyConditionResponse

Throws:

TencentCloudSDKException

ModifyAlarmPolicyInfo

public ModifyAlarmPolicyInfoResponse ModifyAlarmPolicyInfo(ModifyAlarmPolicyInfoRequest req)
                                                    throws TencentCloudSDKException

This API is used to edit the basic information of a v2.0 alarm policy, including policy name and remarks.

Parameters:

req - ModifyAlarmPolicyInfoRequest

Returns:

ModifyAlarmPolicyInfoResponse

Throws:

TencentCloudSDKException

ModifyAlarmPolicyNotice

public ModifyAlarmPolicyNoticeResponse ModifyAlarmPolicyNotice(ModifyAlarmPolicyNoticeRequest req)
                                                        throws TencentCloudSDKException

This API is used to modify the alarm notification template bound to an alarm policy.

Parameters:

req - ModifyAlarmPolicyNoticeRequest

Returns:

ModifyAlarmPolicyNoticeResponse

Throws:

TencentCloudSDKException

ModifyAlarmPolicyStatus

public ModifyAlarmPolicyStatusResponse ModifyAlarmPolicyStatus(ModifyAlarmPolicyStatusRequest req)
                                                        throws TencentCloudSDKException

This API is used to enable/disable an alarm policy.

Parameters:

req - ModifyAlarmPolicyStatusRequest

Returns:

ModifyAlarmPolicyStatusResponse

Throws:

TencentCloudSDKException

ModifyAlarmPolicyTasks

public ModifyAlarmPolicyTasksResponse ModifyAlarmPolicyTasks(ModifyAlarmPolicyTasksRequest req)
                                                      throws TencentCloudSDKException

This API is used to modify the task triggered by an alarm policy. The `TriggerTasks` field contains the list of triggered tasks. If an empty array is passed in for `TriggerTasks`, it indicates to unbind all the triggered tasks from this policy.

Parameters:

req - ModifyAlarmPolicyTasksRequest

Returns:

ModifyAlarmPolicyTasksResponse

Throws:

TencentCloudSDKException

ModifyAlarmReceivers

public ModifyAlarmReceiversResponse ModifyAlarmReceivers(ModifyAlarmReceiversRequest req)
                                                  throws TencentCloudSDKException

This API is used to modify alarm recipients.

Parameters:

req - ModifyAlarmReceiversRequest

Returns:

ModifyAlarmReceiversResponse

Throws:

TencentCloudSDKException

ModifyPolicyGroup

public ModifyPolicyGroupResponse ModifyPolicyGroup(ModifyPolicyGroupRequest req)
                                            throws TencentCloudSDKException

This API is used to update policy group.

Parameters:

req - ModifyPolicyGroupRequest

Returns:

ModifyPolicyGroupResponse

Throws:

TencentCloudSDKException

PutMonitorData

public PutMonitorDataResponse PutMonitorData(PutMonitorDataRequest req)
                                      throws TencentCloudSDKException

The default API request rate limit is 50 requests/sec. The default upper limit on metrics of a single tenant is 100. A maximum of 30 metric/value pairs can be reported at a time. When an error is returned for a request, no metrics/values in the request will be saved. The reporting timestamp is the timestamp when you want to save the data. We recommend that you construct a timestamp at integer minutes. The time range of a timestamp is from 300 seconds before the current time to the current time. The data of the same IP metric/value pair must be reported by minute in chronological order.

Parameters:

req - PutMonitorDataRequest

Returns:

PutMonitorDataResponse

Throws:

TencentCloudSDKException

SendCustomAlarmMsg

public SendCustomAlarmMsgResponse SendCustomAlarmMsg(SendCustomAlarmMsgRequest req)
                                              throws TencentCloudSDKException

This API is used to send a custom alarm notification.

Parameters:

req - SendCustomAlarmMsgRequest

Returns:

SendCustomAlarmMsgResponse

Throws:

TencentCloudSDKException

SetDefaultAlarmPolicy

public SetDefaultAlarmPolicyResponse SetDefaultAlarmPolicy(SetDefaultAlarmPolicyRequest req)
                                                    throws TencentCloudSDKException

This API is used to set an alarm policy as the default policy in the current policy type under the current project. Alarm policies in the same type under the project will be set as non-default.

Parameters:

req - SetDefaultAlarmPolicyRequest

Returns:

SetDefaultAlarmPolicyResponse

Throws:

TencentCloudSDKException

UnBindingAllPolicyObject

public UnBindingAllPolicyObjectResponse UnBindingAllPolicyObject(UnBindingAllPolicyObjectRequest req)
                                                          throws TencentCloudSDKException

This API is used to delete all bound objects.

Parameters:

req - UnBindingAllPolicyObjectRequest

Returns:

UnBindingAllPolicyObjectResponse

Throws:

TencentCloudSDKException

UnBindingPolicyObject

public UnBindingPolicyObjectResponse UnBindingPolicyObject(UnBindingPolicyObjectRequest req)
                                                    throws TencentCloudSDKException

This API is used to delete an object that is bound to a policy.

Parameters:

req - UnBindingPolicyObjectRequest

Returns:

UnBindingPolicyObjectResponse

Throws:

TencentCloudSDKException