tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

GetRequestStatus

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

1. API Description

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

This API is used to query the status of a single function request.

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: GetRequestStatus.
Version Yes String Common Params. The value used for this API: 2018-04-16.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
FunctionName Yes String Function name
FunctionRequestId Yes String ID of the request to be queried
Namespace No String Function namespace
StartTime No String Start time of the query, for example 2017-05-16 20:00:00. If it’s left empty, it defaults to 15 minutes before the current time.
EndTime No String End time of the query. such as 2017-05-16 20:59:59. If StartTime is not specified, EndTime defaults to the current time. If StartTime is specified, EndTime is required, and it need to be later than the StartTime.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total running functions
Note: this field may return null, indicating that no valid values can be obtained.
Data Array of RequestStatus Details of the function running status
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 Obtaining the execution status of a function

Input Example

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

Output Example

{
    "Response": {
        "TotalCount": 1,
        "Data": [
            {
                "MemUsage": 0.0,
                "RetCode": 0,
                "RetMsg": "xx",
                "RequestId": "xx",
                "StartTime": "xx",
                "Duration": 0.0,
                "RetryNum": 0,
                "FunctionName": "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
FailedOperation Operation failed.
FailedOperation.TopicNotExist This topic does not exsit.
InternalError Internal error.
InternalError.System Internal system error.
InvalidParameter.Cls Log parameter error
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.DateTime DateTime error.
InvalidParameterValue.Function The value of FunctionName is incorrect. See https://tencentcs.com/5jXKFnBW
InvalidParameterValue.FunctionName The function does not exist.
InvalidParameterValue.FunctionRequestId Request ID error
InvalidParameterValue.RetCode Invalid RetCode
InvalidParameterValue.StartTime The start time is incorrect.
InvalidParameterValue.StartTimeOrEndTime You need to specify both the start time and the end time.
OperationDenied.AccountIsolate This account has been isolated.
OperationDenied.AccountNotExists
ResourceNotFound.Function The function does not exist.
ResourceNotFound.FunctionName The function does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy