Help Center/ FunctionGraph/ API Reference (Kuala Lumpur Region)/ APIs/ Versions and Aliases/ Creating an Alias for a Function Version
Updated on 2023-07-06 GMT+08:00
View PDF
Share

Creating an Alias for a Function Version

Function

This API is used to create an alias for a function version.

URI

POST /v2/{project_id}/fgs/functions/{function_urn}/aliases

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID.

function_urn

Yes

String

Function URN. For details, see the function model description.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Alias to be queried.

version

Yes

String

Version corresponding to the alias.

description

No

String

Description of the alias.

additional_version_weights

No

Map<String,Integer>

Dark launch information.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

name

String

Alias to be queried.

version

String

Version corresponding to the alias.

description

String

Description of the alias.

last_modified

String

Time when the alias was last modified.

alias_urn

String

URN of the alias.

additional_version_weights

Map<String,Integer>

Dark launch information.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Create an alias for a function version.

POST https://{Endpoint}/v2/{project_id}/fgs/functions/{function_urn}/aliases

{
  "name" : "a1",
  "version" : "v1"
}

Example Responses

Status code: 200

ok

{
  "name" : "a1",
  "version" : "latest",
  "description" : "",
  "last_modified" : "2019-10-31 11:37:58",
  "alias_urn" : "urn:fss:{region}:46b6f338fc3445b8846c71dfb1fbxxxx:function:default:xxxxx:!a1"
}

Status code: 404

Not found.

{
  "error_code" : "FSS.1051",
  "error_msg" : "Not found the function"
}

Status Codes

Status Code

Description

200

ok

400

Bad request.

401

Unauthorized.

403

Forbidden.

404

Not found.

500

Internal server error.

Error Codes

See Error Codes.

Parent topic: Versions and Aliases