Querying Free Virus Scans Count

Function

This API is used to query the number of free virus scans.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/antivirus/pay-per-scan/free-quotas

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
free_quota	Integer	Number of free virus scans
occupied_free_quota	Integer	Number of free scans occupied by the current scan job
antivirus_already_given	Boolean	Whether the free virus scan times have been rewarded on the virus scan screen.
antivirus_free_quota	Integer	Free times that should be rewarded on the virus scan page
report_already_given	Boolean	Whether the free times have been rewarded on the monthly report page
report_free_quota	Integer	Number of free times that should be rewarded on the monthly report page.

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "free_quota" : 1,
  "occupied_free_quota" : 0,
  "antivirus_already_given" : true,
  "antivirus_free_quota" : 2,
  "report_already_given" : false,
  "report_free_quota" : 2
}