ListAliases

Last updated: 2020-06-24 11:46:45

1. API Description

Domain name for API request: scf.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.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: scf.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: ListAliases.
Version Yes String Common parameter. The value used for this API: 2018-04-16.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
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

Input Example

https://scf.tencentcloudapi.com/?Action=ListAliases
&Namespace=<Namespace>
&FunctionName=<FunctionName>
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "d1b93f9c-ac3a-412a-a4f3-6f0697099f72",
    "Aliases": [
      {
        "FunctionVersion": "1",
        "Name": "al3",
        "RoutingConfig": {
          "AdditionalVersionWeights": [
            {
              "Version": "3",
              "Weight": 0.3
            },
            {
              "Version": "2",
              "Weight": 0.2
            }
          ]
        },
        "Description": ""
      }
    ]
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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.
ResourceNotFound.FunctionName The function does not exist.
UnauthorizedOperation.CAM CAM authentication failed.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help