Querying Image Password Complexity Policy Check Reports

Function

This API is used to generate reports on password complexity policy detection for images. Identify CI/CD images by speciying their type and ID. For other types of repositories, specify other parameters like organization name, image name, and version.

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}/image/baseline/password-complexity

**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.
limit	No	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10-200 Default Value 10
offset	No	Integer	Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value The default value is 0.
image_type	No	String	Definition Image type. Constraints N/A Range private_image: private image repository shared_image: shared image repository instance_image: enterprise image cicd : CI/CD image harbor: Harbor repository image registry: repository image Default Value N/A
namespace	No	String	Definition Organization Constraints N/A Range The value can contain 0 to 65,535 characters. Default Value N/A
image_name	No	String	Definition Image Constraints N/A Range The value can contain 0 to 65,535 characters. Default Value N/A
image_version	No	String	Definition Image tag name Constraints N/A Range The value can contain 0 to 65,535 characters. Default Value N/A
instance_id	No	String	Definition Enterprise repository instance ID. This API is not required for the SWR shared edition. Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A

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
region	No	String	Definition Region ID, which is used to query assets in the required region. For details about how to obtain a region ID, see Obtaining a Region ID. Constraints N/A Range The value can contain 1 to 128 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Long	Definition Total number of records. Range Minimum value: 0; maximum value: 2,147,483,647
data_list	Array of ImagePwdComplexityInfoResponseInfo objects	Definition List of password complexity policy detection. Range The value range is 0 to 2,147,483,647.

**Table 5** ImagePwdComplexityInfoResponseInfo
Parameter	Type	Description
image_id	String	Definition Image ID. Range The value can contain 0 to 128 characters.
namespace	String	Definition Organization name. This parameter is available only for private and shared images. Range The value can contain 0 to 65,535 characters.
image_name	String	Definition Image Range The value can contain 0 to 65,535 characters.
image_version	String	Definition Image tag name Range The value can contain 0 to 256 characters.
image_type	String	Definition Repository image type. Range SwrPrivate: SWR private image SwrShared: SWR shared repository SwrEnterprise: SWR enterprise repository Harbor: Harbor repository Jfrog: JFrog repository Other: other repository
latest_scan_time	Long	Definition Last detection time, in ms. Range The value range is 0 to 2,147,483,647.
min_length	Boolean	Definition Minimum password length Range true: yes. false: no.
uppercase_letter	Boolean	Definition Uppercase letters Range true: yes. false: no.
lowercase_letter	Boolean	Definition Lowercase letters Range true: yes. false: no.
number	Boolean	Definition Digits Range true: yes. false: no.
special_character	Boolean	Definition Special character. Range true: yes. false: no.
suggestion	String	Definition Modification suggestion. Range The value can contain 0 to 65,534 characters.

Example Requests

Query the check report of private image password complexity policies.

GET https://{endpoint}/v5/{project_id}/image/baseline/password-complexity?offset=0&limit=200&image_type=private_image&namespace=scc_hss_container&image_name=proxy-agent&image_version=24.5.0-x86_64&enterprise_project_id=all_granted_eps

Query the check report of the password complexity policies for the CI/CD image whose image ID is 111.

GET https://{endpoint}/v5/{project_id}/image/baseline/password-complexity?offset=0&limit=200&image_type=cicd&image_id=111&enterprise_project_id=all_granted_eps

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "number" : false,
    "suggestion" : "It is recommended that a password contain at least eight characters, including uppercase letters, lowercase letters, numbers, and special characters.",
    "namespace" : "glz",
    "image_name" : "webshell-ljx",
    "image_version" : "v1",
    "image_type" : "private_image",
    "min_length" : false,
    "uppercase_letter" : false,
    "lowercase_letter" : false,
    "special_character" : false
  } ]
}