Update an alias with the UpdateAlias operation - Function Compute - Alibaba Cloud -

Updates an alias.

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

fc:UpdateAlias

update

*All Resource

*

None

Request syntax

PUT /2021-04-06/services/{serviceName}/aliases/{aliasName} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
serviceName	string	Yes	The name of the service.	demo-service
aliasName	string	Yes	The name of the alias.	alias_test

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The definition of the alias.
additionalVersionWeight	object	No	The canary release version to which the alias points and the weight of the canary release version. The canary release version takes effect only when the function is invoked. The value consists of a version number and the corresponding weight. For example, 2:0.05 indicates that Version 2 is the canary release version and 5% of the traffic is routed to the canary release version when the function is invoked. The remaining 95% traffic is routed to the main version.
	number	No	The traffic weight. Valid values: 0 to 1.	1
description	string	No	The description of the alias.	test_description
versionId	string	No	The ID of the version to which the alias points.	1
resolvePolicy	string	No	The canary release mode. Default values: off. Valid values: Random: random canary release. Content: rule-based canary release.	Random
routePolicy	RoutePolicy	No	The canary release rule. Traffic that meets the canary release rule is routed to the canary release instance.
If-Match	string	No	If the ETag specified in the request matches the ETag value of the object, the object and 200 OK are returned. Otherwise, 412 Precondition Failed is returned. The ETag value of an object is used to check data integrity of the object. This parameter is empty by default.	e19d5cd5af0378da05f63f891c7467af
X-Fc-Account-Id	string	No	The ID of your Alibaba Cloud account.	188077086902****
X-Fc-Date	string	No	The time on which the function is invoked. The format of the value is: EEE,d MMM yyyy HH:mm:ss GMT.	Wed, 11 May 2022 09:00:00 GMT
X-Fc-Trace-Id	string	No	The trace ID of the invocation request of Function Compute.	rid281s******

Response elements

Element	Type	Description	Example
	object	The definition of the alias.
additionalVersionWeight	object	The additional version to which the alias points and the weight of the additional version. The additional version takes effect only when the function is invoked. The value consists of a version number and a specific weight. For example, 2:0.05 indicates that when a function is invoked, Version 2 is the canary release version, 5% of the traffic is distributed to the canary release version, and 95% of the traffic is distributed to the major version.
	number	The traffic weight. Valid values: 0 to 1.	1
aliasName	string	The name of the alias.	test
createdTime	string	The time when the alias was created.	2016-08-15T16:06:05.000+0000
description	string	The description of the alias.	test_description
lastModifiedTime	string	The time when the alias was last modified.	2016-08-15T16:06:05.000+0000
versionId	string	The ID of the version to which the alias points.	1
resolvePolicy	string	The canary release mode. Default values: off. Valid values: Random: random canary release. Content: rule-based canary release.	Random
routePolicy	RoutePolicy	The canary release rule. The traffic that meets the conditions of the canary release rule is diverted to the canary release instances.

Examples

Success response

JSON format

{
  "additionalVersionWeight": {
    "key": 1
  },
  "aliasName": "test",
  "createdTime": "2016-08-15T16:06:05.000+0000",
  "description": "test_description",
  "lastModifiedTime": "2016-08-15T16:06:05.000+0000",
  "versionId": "1",
  "resolvePolicy": "Random",
  "routePolicy": {
    "condition": "AND",
    "policyItems": [
      {
        "type": "Header",
        "key": "x-test-uid",
        "value": "11111",
        "operator": "="
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.