tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

GetProvisionedConcurrencyConfig

Last updated: 2023-07-18 11:11:04

1. API Description

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

This API is used to get the provisioned concurrency details of a function or its specified 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.

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: GetProvisionedConcurrencyConfig.
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 for which to get the provisioned concurrency details.
Namespace No String Function namespace. Default value: default.
Qualifier No String Function version number. If this parameter is left empty, the provisioned concurrency information of all function versions will be returned.

3. Output Parameters

Parameter Name Type Description
UnallocatedConcurrencyNum Integer Unallocated provisioned concurrency amount of function.
Allocated Array of VersionProvisionedConcurrencyInfo Allocated provisioned concurrency amount of function.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting the provisioned concurrency details of function

Input Example

https://scf.tencentcloudapi.com/?Action=GetProvisionedConcurrencyConfig
&FunctionName=test
&Qualifier=1
&<Common request parameters>

Output Example

{
    "Response": {
        "UnallocatedConcurrencyNum": 1,
        "Allocated": [
            {
                "Status": "xx",
                "Qualifier": "xx",
                "AvailableProvisionedConcurrencyNum": 1,
                "StatusReason": "xx",
                "AllocatedProvisionedConcurrencyNum": 1,
                "TriggerActions": [
                    {
                        "TriggerProvisionedConcurrencyNum": 1,
                        "TriggerCronConfig": "xx",
                        "TriggerName": "xx"
                    }
                ]
            }
        ],
        "RequestId": "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 Internal error.
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.FunctionName The function does not exist.
InvalidParameterValue.Namespace Namespace error.
InvalidParameterValue.Qualifier Unsupported function version.
MissingParameter Missing parameter.
ResourceNotFound.Function The function does not exist.
ResourceNotFound.FunctionVersion The function version does not exist.
ResourceNotFound.Namespace Namespace does not exist.
ResourceNotFound.Version The version does not exist.
UnauthorizedOperation Unauthorized operation.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy