tencent cloud

Feedback

DescribeImageReviewUsageData

Last updated: 2022-05-19 19:00:47

1. API Description

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

This API is used to query your daily usage of the image recognition feature in a specified time period.

  1. You can query statistics from the last 365 days.
  2. The maximum query period is 90 days.
  3. If the period specified is longer than one day, the statistics returned will be on a daily basis; otherwise, they will be on a 5-minute basis.

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: DescribeImageReviewUsageData.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region No String Common Params. This parameter is not required for this API.
StartTime Yes String The start date for the query in ISO date format.
EndTime Yes String The end date for the query in ISO date format. The end date must be later than the start date.
SubAppId No Integer The VOD subapplication ID. If you need to access a resource in a subapplication, set this parameter to the subapplication ID; otherwise, leave it empty.

3. Output Parameters

Parameter Name Type Description
ImageReviewUsageDataSet Array of ImageReviewUsageDataItem The image recognition usage statistics (the number of times the image recognition feature is used in the time period specified).
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying image recognition usage

Input Example

https://vod.tencentcloudapi.com/?Action=DescribeImageReviewUsageData
&StartTime=2020-09-07T00:00:00+08:00
&EndTime=2020-09-09T23:59:59+08:00
&<Common request parameters>

Output Example

{
  "Response": {
    "ImageReviewUsageDataSet": [
      {
        "Time": "2020-09-07T00:00:00+08:00",
        "Count": 2
      },
      {
        "Time": "2020-09-08T00:00:00+08:00",
        "Count": 2
      },
      {
        "Time": "2020-09-09T00:00:00+08:00",
        "Count": 2
      }
    ],
    "RequestId": "requestId"
  }
}

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.InvalidVodUser The VOD service is not activated.
InternalError Internal error.
InvalidParameterValue Incorrect parameter value.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support