Querying Pay-per-use Image Scans Statistics

This API is used to query pay-per-use scan statistics for images.

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.

GET /v5/{project_id}/image/pay-per-scan/statistics

**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.

**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

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
repository_scan_num	Integer	Number of successful repository image scans
cicd_scan_num	Integer	Number of successful CICD image scans
free_quota_num	Integer	Free Scans
already_given	Boolean	Whether Free Times Have Been Rewarded
image_free_quota	Integer	Rewarded times for logging in to the container image page
high_risk	ImageTypeRiskInfo object	High-risk Images
has_risk	ImageTypeRiskInfo object	Risky image
total	ImageTypeRiskInfo object	Total number of images
unscan	ImageTypeRiskInfo object	Unscanned Images

None

Status code: 200

Pay-per-use image scan statistics.

{
  "repository_scan_num" : 5,
  "cicd_scan_num" : 10,
  "free_quota_num" : 2,
  "already_given" : true,
  "image_free_quota" : 10
}

Status Code	Description
200	Pay-per-use image scan statistics.

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.