CreateAlias - Function Compute (2.0) - Alibaba Cloud Documentation Center

Creates an alias.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

POST /2021-04-06/services/{serviceName}/aliases

Request parameters

Parameter	Type	Required	Description	Example
serviceName	string	Yes	The name of the service.	service_name
body	object	No	The definition of an 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 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.
	float	No	The traffic weight. Valid values: 0 to 1.	1
aliasName	string	Yes	The name of the alias. The name can contain letters, digits, underscores (_), and hyphens (-) only. The name cannot start with a digit or a hyphen (-). The name must be 1 to 128 characters in length. The name cannot be set to LATEST	alias_test
description	string	No	The description of the alias.	test_description
versionId	string	Yes	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. By default, this parameter is empty.	Random
routePolicy	RoutePolicy	No	The canary release rule. Traffic that meets the canary release rule is routed to the canary release instance.
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.	r9s89isisi****

Response parameters

Parameter	Type	Description	Example
headers	object
etag	string	The ETag that is used to modify the alias. The value is used to ensure that the modified alias is consistent with the alias that is expected to be modified.	5e547e5605e1dc17a78a6191bc18fbc5
	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.
	float	The traffic weight. Valid values: 0 to 1.	1
aliasName	string	The name of the alias.	alias_test
createdTime	string	The time when the alias was created.	2020-04-23T06:32:43Z
description	string	The description of the alias.	test_description
lastModifiedTime	string	The time when the alias was last modified.	2020-04-23T06:32:43Z
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	Canary release rule: The traffic that meets the conditions of the canary release rule is diverted to the canary release instances.

Examples

Sample success responses

JSONformat

{
  "additionalVersionWeight": {
    "key": 1
  },
  "aliasName": "alias_test",
  "createdTime": "2020-04-23T06:32:43Z",
  "description": "test_description",
  "lastModifiedTime": "2020-04-23T06:32:43Z",
  "versionId": "1",
  "resolvePolicy": "Random",
  "routePolicy": {
    "condition": "AND",
    "policyItems": [
      {
        "type": "Header",
        "key": "x-test-uid",
        "value": "11111",
        "operator": "="
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-12-28

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2022-08-04

The internal configuration of the API is changed, but the call is not affected

see changesets

Change item	Change content
	The internal configuration of the API is changed, but the call is not affected.

2021-06-29

The request parameters of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: X-Fc-Account-Id
	Added Input Parameters: X-Fc-Code-Checksum
	Added Input Parameters: X-Fc-Log-Type
	Added Input Parameters: X-Fc-Invocation-Type
	Added Input Parameters: X-Fc-Date
	Added Input Parameters: X-Fc-Trace-Id

2021-06-29

The request parameters of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: X-Fc-Account-Id

2021-06-29

The request parameters of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	delete Input Parameters: X-Fc-Account-Id