UpdateNacosGrayConfig - Microservices Engine - Alibaba Cloud Documentation Center

Updates the canary release settings, including beta release and tag-based canary release.

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:UpdateNacosConfig

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	mse_prepaid_public_cn-st2212****
NamespaceId	string	No	The namespace ID. Default value: public.	6cf708a5-****-89f2-3ba62c5ee9ba
Group	string	No	The group name. Default value: DEFAULT_GROUP.	DEFAULT_GROUP
DataId	string	Yes	The data ID.	test
Content	string	No	The configuration content.	asdf
GrayType	string	Yes	The canary release type. Beta release (IP address-based canary release) and tag-based canary release are supported.	Tags
GrayRule	string	No	The canary release rule. For a beta release, you can specify one or more client IP addresses for this parameter. You must separate multiple IP addresses with commas (,). For a tag-based canary release, the value is in the format of Tag name=Tag value. You must separate multiple tag values with commas (,).	key=value1,value2
StopGray	boolean	No	Specifies whether to stop the canary release.	true
RegionId	string	No	The region.	cn-hangzhou
RequestPars	string	No	The extended request parameter in the JSON format.	{}
AppName	string	No	The application name.	spring-cloud-a
GrayRuleName	string	No	The canary version name.
GrayRulePriority	integer	No	The canary version priority.
OpType	string	No	The operation type. Valid values: Create (create a canary release configuration) and Update (update an existing canary release configuration).
AcceptLanguage	string	No	The language in which you want the results to be displayed. Valid values: zh (default): Chinese. en: English.	zh

Response elements

Parameter	Type	Description	Example
	object	RestResult
RequestId	string	The request ID.	316F5F64-F73D-42DC-8632-01E308B6****
Data	boolean	Indicates whether the request was successful.	true

Examples

Success response

JSON format

{
  "RequestId": "316F5F64-F73D-42DC-8632-01E308B6****",
  "Data": 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.