tencent cloud

文档反馈

CopyFunction

最后更新时间:2023-05-09 15:35:16

    1. API Description

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

    This API is used to replicate a function. You can store the replicated function in a specified Region and Namespace.
    Note: This API does not replicate the following objects or attributes of the function:

    1. Function trigger
    2. Versions other than $LATEST
    3. CLS target of the logs configured in the function

    You can manually configure the function after replication as required.

    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: CopyFunction.
    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 Name of the function to be replicated
    NewFunctionName Yes String Name of the new function
    Namespace No String Namespace of the function to be replicated. The default value is default.
    TargetNamespace No String Namespace of the replicated function. The default value is default.
    Description No String Description of the new function
    TargetRegion No String Region of the target of the function replication. If the value is not set, the current region is used by default.
    Override No Boolean It specifies whether to replace the function with the same name in the target namespace. The default option is FALSE.
    (Note: The TRUE option results in deletion of the function in the target namespace. Please operate with caution.)
    TRUE: Replaces the function.
    FALSE: Does not replace the function.
    CopyConfiguration No Boolean It specifies whether to replicate the function attributes, including environment variables, memory, timeout, function description, labels, and VPC. The default value is TRUE.
    TRUE: Replicates the function configuration.
    FALSE: Does not replicate the function configuration.

    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 Replicating a function

    This example shows you how to replicate a function.

    Input Example

    https://scf.tencentcloudapi.com/?Action=CopyFunction
    &Namespace=default
    &FunctionName=myfunc
    &TargetNamespace=otherns
    &NewFunctionName=newfunc
    &TargetRegion=ap-shanghai
    &Override=FALSE
    &CopyConfiguration=TRUE
    &<Common request parameters>
    

    Output Example

    {
        "Response": {
            "RequestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
    }
    

    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.CopyAsyncRun CopyAsyncRun parameter error
    FailedOperation.CopyFailed Failed to replicate the function.
    FailedOperation.CopyFunction Replication to this region is not supported.
    InternalError Internal error.
    InternalError.Exception Internal service error
    InternalError.System Internal system error.
    InvalidParameterValue.Code Code error.
    InvalidParameterValue.Description Description error.
    InvalidParameterValue.Environment Environment error.
    InvalidParameterValue.FunctionName The function does not exist.
    InvalidParameterValue.Handler Handler error.
    InvalidParameterValue.Runtime Runtime error.
    LimitExceeded.Function If the number of functions exceeds the upper limit, you can apply for an increase by submitting a ticket.
    LimitExceeded.Memory The memory exceeds the upper limit.
    LimitExceeded.Timeout Timeout exceeds the upper limit.
    ResourceInUse.FunctionName This FunctionName already exists.
    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.
    UnauthorizedOperation.Region Region error.
    UnsupportedOperation.Region This region is not supported.