Update Canary Release Rules via UpdateGreyTagRoute - Serverless App Engine - Alibaba Cloud - Serverless App Engine

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

sae:UpdateGreyTagRoute

update

*All Resource

*

None

Request syntax

PUT /pop/v1/sam/tagroute/greyTagRoute HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Description	string	No	The description of the rule.	Canary Release - Regions
ScRules	string	No	The grey tag route for a Spring Cloud application.	[{"condition":"OR","items":[{"cond":"==","name":"grey","operator":"rawvalue","type":"param","value":"true"},{"cond":"==","name":"grey","operator":"rawvalue","type":"cookie","value":"true"},{"cond":"==","name":"grey","operator":"rawvalue","type":"header","value":"true"}],"path":"/post-echo/hi"}]
DubboRules	string	No	The grey tag route for a Dubbo application.	[{"condition":"OR","group":"DUBBO","items":[{"cond":"==","expr":".key1","index":0,"operator":"rawvalue","value":"value1"},{"cond":"==","expr":".key2","index":0,"operator":"rawvalue","value":"value2"}],"methodName":"echo","serviceName":"com.alibaba.edas.boot.EchoService","version":"1.0.0"}]
GreyTagRouteId	integer	Yes	The grey tag route ID.	1
AlbRules	string	No	The grey tag route for an ALB gateway route.	[{"condition":"AND","items":[{"cond":"==","name":"grey","operator":"rawvalue","type":"sourceIp","value":"127.0.0.1"},{"cond":"==","name":"grey","operator":"rawvalue","type":"cookie","value":"true"},{"cond":"==","name":"grey","operator":"rawvalue","type":"header","value":"true"}],"path":"/post-echo/hi"}]

ScRules parameters

Parameter	Type	Example	Description
condition	String	OR	The logical operator for the conditions. Valid values: - AND: All conditions must be met. - OR: At least one of the conditions must be met.
path	String	/path	The application path to which the grey tag route applies.
items	Array of items		The list of conditions.

items parameters

Parameter	Type	Example	Description
name	String	test	The parameter name.
cond	String	==	The comparison operator. Valid values: >, <, >=, <=, == and !=.
type	String	cookie	The comparison type. Valid values: - param: Parameter. - cookie: Cookie. - header: Header.
value	String	test	The value to compare. The system compares this value with the value retrieved based on the type and name parameters.
operator	String	rawvalue	The operator. Valid values: - rawvalue: Indicates a direct comparison. - list: Indicates a whitelist. - mod: Indicates a modulo 100 operation. - deterministic_proportional_steaming_division: Indicates a percentage.

DubboRules parameters

Parameter	Type	Example	Description
condition	String	OR	The logical operator for the conditions. Valid values: - AND: All conditions must be met. - OR: At least one of the conditions must be met.
methodName	String	echo	The method name of the Dubbo service.
serviceName	String	com.alibaba.edas.boot.EchoService	The name of the Dubbo service.
version	String	1.0.0	The version of the Dubbo service.
items	Array of items		The list of conditions.
group	String	DUBBO	The Dubbo service group to which the grey tag route applies.

items parameters

Parameter	Type	Example	Description
index	Integer	0	The parameter index. 0 indicates the first parameter.
expr	String	.name	The expression used to retrieve the parameter value. Valid values: - If left empty, the value of the current parameter is retrieved directly. - .name: Retrieves the `name` attribute of the parameter, which is equivalent to `args0.getName()`. - .isEnabled(): Retrieves the `enabled` attribute of the parameter, which is equivalent to `args0.isEnabled()`. - [0]: Indicates that the parameter is an array. This retrieves the first element of the array, which is equivalent to `args0[0]`. Note that the expression does not start with a period (.). - .get(0): Indicates that the parameter is a List. This retrieves the first element of the List, which is equivalent to `args0.get(0)`. - .get("key"): Indicates that the parameter is a Map. This retrieves the value that corresponds to the specified key, which is equivalent to `args0.get("key")`.
cond	String	==	The comparison operator. Valid values: >, <, >=, <=, == and !=.
value	String	test	The value to compare. The system compares this value with the value retrieved based on the expr and index parameters.
operator	String	rawvalue	The operator. Valid values: - rawvalue: Indicates a direct comparison. - list: Indicates a whitelist. - mod: Indicates a modulo 100 operation. - deterministic_proportional_steaming_division: Indicates a percentage.

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	9D29CBD0-45D3-410B-9826-52F86F90****
Message	string	Additional information about the call result.	success
TraceId	string	The trace ID. You can use this ID to query the details of a call.	0a98a02315955564772843261e****
Data	object	The grey tag route information.
GreyTagRouteId	integer	The globally unique grey tag route ID.	1
ErrorCode	string	The error code. The ErrorCode parameter is not returned for successful requests. The ErrorCode parameter is returned for failed requests. For more information, see the Error codes section of this topic.
Code	string	The HTTP status code. Valid values: 2xx: The request is successful. 3xx: The request is redirected. 4xx: A client error occurred. 5xx: A server error occurred.	200
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "RequestId": "9D29CBD0-45D3-410B-9826-52F86F90****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "GreyTagRouteId": 1
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.NotEmpty	You must specify the parameter %s.
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s
400	Application.ChangerOrderRunning	An application change process is in progress. Please try again later.	An application change process is in progress. Please try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.