UpdateAlertStrategy - Alibaba Cloud Linux - Alibaba Cloud Documentation Center

Updates a push alert policy.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

sysom:UpdateAlertStrategy

none

*All Resource

*

None

Request syntax

POST /api/v1/alertPusher/alert/updateStrategy HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The HTTP request body.
enabled	boolean	Yes	Specifies whether the alert policy is enabled.	true
id	integer	Yes	The ID of the alert policy.	1
k8sLabel	boolean	No	The Kubernetes label.
name	string	Yes	The name of the alerting policy.	strategy1
strategy	object	Yes	The details of the alert policy.
clusters	array	No	The collection of clusters that receive alerts.
	string	No	The cluster name.	cluster1
destinations	array	No	The alert contacts.
	integer	No	The alert contacts.
items	array	No	The collection of exception items that receive alerts.
	string	No	The name of the exception item.	Node CPU Usage Detection

Response elements

Element	Type	Description	Example
	object	Schema of Response
code	string	The status code. `code == Success` indicates that the authorization is successful. Other status codes indicate that the authorization failed. Check the `message` field for the detailed fault information.	Success
data	any	The response data.	{ "uid": "uid-1", "name": "test-name", "strategy": { "clusters": ["test-cluster-1","test-cluster-2"], "items": ["test-item1","test-item2"] }, "enabled": True }
message	string	The error message. If `code == Success`, this field is empty. Otherwise, this field contains the error message of the request.	Failed to update alert policy
requestId	string	Id of the request	2D693121-C925-5154-8DF6-C09A8B369822

Examples

Success response

JSON format

{
  "code": "Success",
  "data": "{\n            \"uid\": \"uid-1\",\n            \"name\": \"test-name\",\n            \"strategy\": {\n                \"clusters\": [\"test-cluster-1\",\"test-cluster-2\"],\n                \"items\": [\"test-item1\",\"test-item2\"]\n            },\n            \"enabled\": True\n}",
  "message": "Failed to update the alert policy",
  "requestId": "2D693121-C925-5154-8DF6-C09A8B369822"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.