1. API Description
Domain name for API request: scf.intl.tencentcloudapi.com.
This API is used to return the list of all aliases under a function. You can filter them by the specific function version.
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: ListAliases. |
| 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 |
| Namespace |
No |
String |
Function namespace |
| FunctionVersion |
No |
String |
If this parameter is provided, only aliases associated with this function version will be returned. |
| Offset |
No |
String |
Data offset. Default value: 0 |
| Limit |
No |
String |
Number of results to be returned. Default value: 20 |
3. Output Parameters
| Parameter Name |
Type |
Description |
| Aliases |
Array of Alias |
Alias list |
| TotalCount |
Integer |
Total number of aliases 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 all aliases under function
https:
&Namespace=<Namespace>
&FunctionName=<FunctionName>
&<Common request parameters>
Output Example
{
"Response": {
"TotalCount": 1,
"RequestId": "xx",
"Aliases": [
{
"ModTime": "2020-09-22 00:00:00",
"Name": "xx",
"AddTime": "2020-09-22 00:00:00",
"FunctionVersion": "xx",
"RoutingConfig": {
"AdditionalVersionWeights": [
{
"Version": "xx",
"Weight": 0.0
}
],
"AddtionVersionMatchs": [
{
"Version": "xx",
"Expression": "xx",
"Method": "xx",
"Key": "xx"
}
]
},
"Description": "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 |
| InternalError.System |
Internal system error. |
| InvalidParameterValue.FunctionName |
The function does not exist. |
| InvalidParameterValue.Namespace |
Namespace error. |
| 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. |