tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

CreateAlias

最后更新时间：2023-07-18 11:11:06

1. API Description

Domain name for API request: scf.tencentcloudapi.com.

This API is used to create an alias for a function version. You can use the alias to mark a specific function version such as DEV/RELEASE. You can also modify the version pointed to by the alias at any time.
An alias must point to a master version and can point to an additional version at the same time. If you specify an alias when invoking a function, the request will be sent to the versions pointed to by the alias. You can configure the ratio between the master version and additional version during request sending.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: CreateAlias.
Version Yes String Common Params. The value used for this API: 2018-04-16.
Region No String Common Params. This parameter is not required for this API.
Name Yes String Alias name, which must be unique in the function, can contain 1 to 64 letters, digits, _, and -, and must begin with a letter
FunctionName Yes String Function name
FunctionVersion Yes String Master version pointed to by the alias
Namespace No String Function namespace
RoutingConfig No RoutingConfig Request routing configuration of alias
Description No String Alias description

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating an alias

Input Example

https://scf.tencentcloudapi.com/?Action=CreateAlias
&Name=<AliasName>
&Namespace=<Namespace>
&FunctionName=<FunctionName>
&FunctionVersion=<FunctionVersion>
&RoutingConfig.AdditionalVersionWeights.0.Version=<OtherVersion>
&RoutingConfig.AdditionalVersionWeights.0.Weight=<Weight>
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
FailedOperation.CreateAlias Failed to create the alias.
InternalError.System Internal system error.
InvalidParameter.RoutingConfig Incorrect RoutingConfig parameter.
InvalidParameterValue.AdditionalVersionWeights Incorrect AdditionalVersionWeights parameter.
InvalidParameterValue.Description Description error.
InvalidParameterValue.Name Incorrect Name parameter.
InvalidParameterValue.RoutingConfig The value of RoutingConfig does not conform to the specification. Please fix it and try again. For more information, please visit https://tencentcs.com/5jXKFnBW.
LimitExceeded.Alias The number of aliases exceeds the upper limit.
ResourceInUse The resource is in use.
ResourceInUse.Alias The alias is in use.
ResourceNotFound.Function The function does not exist.
ResourceNotFound.FunctionName The function does not exist.
ResourceNotFound.FunctionVersion The function version does not exist.
UnauthorizedOperation.CAM CAM authentication failed.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款