Implement Canary Releases for Message Queues via MSE API - Microservices Engine - Alibaba Cloud - Microservices Engine

Updates the message canary release configuration for an application.

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

mse:UpdateMessageQueueRoute

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Tags	array	No	The ignored tags for the untagged environments of the application.
	string	No	The ignored tags for the untagged environments of the application.	gray
Region	string	Yes	The region.	cn-hangzhou
Enable	boolean	No	Specifies whether message canary release is enabled. Valid values: `true`: Enabled. `false`: Disabled.	true
AppId	string	Yes	The application ID.	hkhon1po62@c3df23522baa898
FilterSide	string	No	The filtering side for message canary release.	Server
Namespace	string	No	The MSE namespace name.	default
AppName	string	No	The application name.	example-app
GrayBaseTags	array	No	The list of baseline environment labels for MSMQ grayscale rules.
	string	No	A baseline environment label for MSMQ grayscale.	base1
AcceptLanguage	string	No	The language of the returned information. Valid values: zh: Chinese. en: English.	zh

Response elements

Element	Type	Description	Example
	object	The data structure.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The ID of the request.	E3919C62-876A-5926-A0BC-18351A24FA35
Message	string	The returned message.	success
Data	string	The node data.	True
Code	integer	The status code. A status code of 200 indicates success, and other values indicate failure.	200
Success	boolean	Indicates whether the request is successful. Valid values: `true`: The request is successful. `false`: The request fails.	true

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "E3919C62-876A-5926-A0BC-18351A24FA35",
  "Message": "success",
  "Data": "True",
  "Code": 200,
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.