1. API Description
Domain name for API request: scf.intl.tencentcloudapi.com.
This API is used to get the alias details such as the name, description, version, and routing information.
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.
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: GetAlias. |
| 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. |
| FunctionName |
Yes |
String |
Function name |
| Name |
Yes |
String |
Alias name |
| Namespace |
No |
String |
Function namespace |
3. Output Parameters
| Parameter Name |
Type |
Description |
| FunctionVersion |
String |
Master version pointed to by the alias |
| Name |
String |
Alias name |
| RoutingConfig |
RoutingConfig |
Routing information of alias |
| Description |
String |
Alias description Note: this field may return null, indicating that no valid values can be obtained. |
| AddTime |
Timestamp |
Creation time Note: this field may return null, indicating that no valid values can be obtained. |
| ModTime |
Timestamp |
Update time Note: this field may return null, indicating that no valid values can be obtained. |
| RequestId |
String |
The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Querying alias details
https:
&Namespace=<Namespace>
&FunctionName=<FunctionName>
&Name=<AliasName>
&<Common request parameters>
Output Example
{
"Response": {
"ModTime": "2020-09-22 00:00:00",
"Description": "xx",
"AddTime": "2020-09-22 00:00:00",
"FunctionVersion": "xx",
"RequestId": "xx",
"RoutingConfig": {
"AdditionalVersionWeights": [
{
"Version": "xx",
"Weight": 0.3
},
{
"Version": "xx",
"Weight": 0.2
}
],
"AddtionVersionMatchs": [
{
"Version": "xx",
"Expression": "xx",
"Method": "xx",
"Key": "xx"
}
]
},
"Name": "xx"
}
}
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.GetAlias |
Failed to get the alias information. |
| InternalError.System |
Internal system error. |
| InvalidParameter.RoutingConfig |
Incorrect RoutingConfig parameter. |
| InvalidParameterValue.FunctionName |
The function does not exist. |
| InvalidParameterValue.Name |
Incorrect Name parameter. |
| InvalidParameterValue.Namespace |
Namespace error. |
| ResourceNotFound.Alias |
The alias does not exist. |
| ResourceNotFound.Function |
The function does not exist. |
| ResourceNotFound.FunctionName |
The function does not exist. |
| ResourceNotFound.Namespace |
Namespace does not exist. |
| UnauthorizedOperation.CAM |
CAM authentication failed. |