UpdateRouteRule-阿里云帮助中心

Modifies a routing rule.

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

gemp:UpdateRouteRule

update

*All Resource

*

None

Request syntax

POST /routeRule/edit HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
ruleName	string	Yes	The name of the rule.	Rule name
relatedServiceId	integer	Yes	The ID of the associated service.	1000
routeRuleId	integer	Yes	The ID of the rule.	1001
routeType	string	Yes	The route type. Valid values: INCIDENT: Triggers an event. ALERT: Triggers only an alert.	ALERT
incidentLevel	string	Yes	The event level in descending order of severity. Valid values: P1 P2 P3 P4	P1
assignObjectId	integer	Yes	The ID of the object to which the event is assigned, such as a service group ID or a user ID.	1
assignObjectType	string	Yes	The object type of the event assignee. Valid values: SERVICEGROUP: Service group. USER: Individual user.	SERVICEGROUP
effection	string	Yes	The impact level. Valid values: LOW: Normal. HIGH: Severe.	LOW
timeWindow	integer	Yes	The time window.	10
timeWindowUnit	string	Yes	The unit of the time window. Valid values: MINUTE: Minutes. SECOND: Seconds.	MINUTE
matchCount	integer	Yes	The number of hits.	10
routeChildRules	array<object>	Yes	The child rules.
	array<object>	Yes	The child rules.
childRouteRuleId	integer	Yes	The ID of the child rule. If this parameter is left empty, a new child rule is created.	1
conditions	array<object>	Yes	The conditions.
	object	Yes	The conditions.
key	string	Yes	The key of the condition.	payload.summary
value	string	Yes	The value to match.	123
operationSymbol	string	Yes	The operator.	equals
monitorSourceId	integer	Yes	The ID of the monitoring source.	1
isValidChildRule	boolean	Yes	Specifies whether to delete the child rule. Valid values: true: Deletes the child rule. false: Modifies the child rule.	false
childConditionRelation	integer	No	The logical relation between child conditions. Valid values: 0: AND. 1: OR.	1
problemLevel	string	No	The fault level in descending order of severity. Valid values: P1 P2 P3 P4	P1
notifyChannels	array	Yes	The notification channels.
	string	Yes	The notification channels.	[SMS,PHONE]
clientToken	string	No	The client token.	C4BE3837-1A13-413B-A225-2C88188E8A43
childRuleRelation	string	No	The logical relation between child rules. Valid values: AND: AND. OR: OR.	AND
problemLevelGroup	object	No	The fault level group.	{"P1":{"childRuleRelation":1,"matchCount":1,"timeWindow":5,"timeWindowUnit":"MINUTE","enableUpgrade":false,"upgradeTimeWindow":5,"upgradeTimeWindowUnit":"minute"}}
	object	No	The fault level group.
childRuleRelation	integer	No	The logical relation between child rules. Valid values: 0: AND. 1: OR.	1
matchCount	integer	No	The number of hits for suppression.	1
timeWindow	integer	No	The time window for suppression.	5
timeWindowUnit	string	No	The unit of the time window for suppression.	MINUTE
enableUpgrade	boolean	No	Specifies whether to enable escalation.
upgradeTimeWindow	integer	No	The time window for escalation.	5
upgradeTimeWindowUnit	string	No	The unit of the time window for escalation.	minute
coverageProblemLevels	array	No	The coverage type.
	string	No	The coverage type.	P1
problemEffectionServices	array	No	The list of affected services.
	integer	No	The ID of the affected service.	1
convergenceFields	array	No	The set of convergence fields.
	string	No	The set of convergence fields.	app
convergenceType	integer	No	The convergence type. Valid values: 0: Routing rule convergence. 1: Field convergence.	0

Response elements

Element	Type	Description	Example
	object	The response structure.
requestId	string	The request ID.	C4BE3837-1A13-413B-A225-2C88188E8A43
data	integer	The returned results.	null

Examples

Success response

JSON format

{
  "requestId": "C4BE3837-1A13-413B-A225-2C88188E8A43",
  "data": 0
}

Error codes

HTTP status code	Error code	Error message	Description
400	RouteRuleNameAlreadyExisted	The rule name already exists.
404	RouteRuleNotExisted	The rule does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.