Querying Image Options of the Container WTP Edition

Function

This API is used to query the image options of the container WTP edition.

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}/webtamper/image-options

**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.
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.
limit	No	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10-200 Default Value 10
registry_type	No	String	Definition Repository type of a repository image. Constraints N/A Range The value can contain 1 to 512 characters. Default Value N/A
image_namespace	No	String	Definition Organization name of a repository image. Constraints N/A Range The value can contain 1 to 512 characters. Default Value N/A
registry_name	No	String	Definition Repository name of a repository image. Constraints N/A Range The value can contain 1 to 512 characters. Default Value N/A
image_type	Yes	String	Definition Queried image type. Constraints N/A Range registry: repository image local: local image Default Value N/A
image_name	No	String	Definition Image Constraints N/A Range The value can contain 1 to 512 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

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Definition Total number. Range The value range is 0 to 2,147,483,647.
data_list	Array of WebTamperImageOptionsResponseInfo objects	data list

**Table 5** WebTamperImageOptionsResponseInfo
Parameter	Type	Description
image_name	String	Definition Image Range The value can contain 0 to 512 characters.
image_full_name	String	Definition Image Range The value can contain 0 to 512 characters.
image_id	String	Definition Image ID. Range The value can contain 0 to 64 characters.
image_version_list	Array of strings	Definition Image tag list. Constraints N/A Range 0 to 100 items Default Value N/A
image_namespace	String	Definition Organization name of a repository image. Range The value can contain 0 to 512 characters.
registry_name	String	Definition Image repository name. Range The value can contain 1 to 128 characters.
registry_type	String	Definition Image repository type. Range SwrPrivate: SWR private repository SwrShared: SWR shared repository SwrEnterprise: SWR enterprise repository Harbor: Harbor repository Jfrog: JFrog repository Other: other repository

Example Requests

GET https://{endpoint}/v5/{project_id}/webtamper/image-options?enterprise_project_id=all_granted_eps&image_type=local

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "image_name" : "test_image",
    "image_full_name" : "test/test_namespace/test_image",
    "image_version_list" : [ "v1" ],
    "image_namespace" : "test_namespace",
    "registry_type" : "test",
    "registry_name" : "test"
  } ]
}