All Products
Search
Document Center

Function Compute:UpdateAlias

Last Updated:Oct 10, 2024

Updates an alias.

Debugging

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

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
fc:UpdateAliasupdate
  • All Resources
    *
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
serviceNamestringYes

The name of the service.

demo-service
aliasNamestringYes

The name of the alias.

alias_test
bodyobjectNo

The definition of the alias.

additionalVersionWeightobjectNo

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.
floatNo

The traffic weight. Valid values: 0 to 1.

1
descriptionstringNo

The description of the alias.

test_description
versionIdstringNo

The ID of the version to which the alias points.

1
resolvePolicystringNo

The canary release mode. Default values: off. Valid values:

  • Random: random canary release.
  • Content: rule-based canary release.
Random
routePolicyRoutePolicyNo

The canary release rule. Traffic that meets the canary release rule is routed to the canary release instance.

If-MatchstringNo

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-IdstringNo

The ID of your Alibaba Cloud account.

188077086902****
X-Fc-DatestringNo

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-IdstringNo

The trace ID of the invocation request of Function Compute.

rid281s******

Response parameters

ParameterTypeDescriptionExample
headersobject
ETagstring

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.

additionalVersionWeightobject

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
aliasNamestring

The name of the alias.

test
createdTimestring

The time when the alias was created.

2016-08-15T16:06:05.000+0000
descriptionstring

The description of the alias.

test_description
lastModifiedTimestring

The time when the alias was last modified.

2016-08-15T16:06:05.000+0000
versionIdstring

The ID of the version to which the alias points.

1
resolvePolicystring

The canary release mode. Default values: off. Valid values:

  • Random: random canary release.
  • Content: rule-based canary release.
Random
routePolicyRoutePolicy

The 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": "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

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

Change history

Change timeSummary of changesOperation
2023-12-28The response structure of the API has changedView Change Details
2022-08-04The internal configuration of the API is changed, but the call is not affectedView Change Details
2021-06-29The request parameters of the API has changedView Change Details
2021-06-29The request parameters of the API has changedView Change Details
2021-06-29The request parameters of the API has changedView Change Details