Help Center> FunctionGraph> Developer Guide> Development Tools> Serverless Devs> Using Commands> alias> alias publish
Updated on 2023-10-19 GMT+08:00
View PDF

alias publish

alias publish is used to publish and update an alias.

You can run alias publish -h or alias publish --help to view the documentation.

Parameter Parsing

Table 1 Parameter description

Parameter Name

Abbreviation

Required in YAML

Required in CLI

Description

region

-

No

Yes

Region

function-name

-

No

Yes

Function name

alias-name

-

Yes

Yes

Alias

version-name

-

No

Yes

Version corresponding to the alias

description

-

No

No

Alias description

gversion

-

No

No

ID of an additional version for dark launch. This is required only when a weight is specified.

weight

-

No

No

Weight of the dark launch version. This parameter is required when the dark launch version ID is specified.

This command also supports some global parameters, such as -a/--access and --debug. For details, see Global Parameters of Serverless Devs.

Examples

  • If you have a resource description file (YAML), run s alias publish to publish or update an alias.
  • If you use CLI (without a YAML resource description file), specify the region and name of the service. For example, s cli fgs alias publish --region cn-north-4 --function-name fg-test --alias-name pre --version-name 1.

When using CLI, if the key is not default, add the access parameter. For example, s cli fgs alias publish --region cn-north-4 --function-name fg-test --alias-name pre --version-name 1 --access xxxx.

Execution result of the preceding command: 
fg-test:
  aliasName:               pre
  versionId:               1
  description:
  additionalVersionWeight:
  createdTime:             2021-11-08T06:51:36Z
  lastModifiedTime:        2021-11-08T06:51:36Z
To upgrade an alias, specify the alias and update the desired parameters. For example, to add a description for the preceding pre alias, specify the --description parameter and run the previous command again. The output is as follows: 
fc-deploy-test:
  aliasName:               pre
  versionId:               1
  description:             test publish version
  additionalVersionWeight:
  createdTime:             2021-11-08T06:51:36Z
  lastModifiedTime:        2021-11-08T06:54:02Z
Parent topic: alias