Editing Image Repository Access Information

Function

This API is used to edit image repository access information.

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

PUT /v5/{project_id}/image/registries/{id}

**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
id	Yes	String	Definition Repository ID. Constraints N/A Range Length: 1 to 64 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

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
api_version	No	String	Definition Image repository API version. Constraints N/A Range V1: V1 version V2: V2 version Default Value N/A
protocol	No	String	Definition Protocol type. Constraints N/A Range http: HTTP protocol https: HTTPS protocol Default Value N/A
registry_addr	No	String	Definition Image Repository Address Constraints URL or IP:Port. Example: myharbor.com Range Length: 1 to 256 characters Default Value N/A
registry_username	No	String	Definition Username for logging in to the image repository. Constraints N/A Range Length: 1 to 128 characters Default Value N/A
registry_password	No	String	Definition Password for logging in to the image repository. The image repository password is used only to access the image repository. HSS does not store your image repository password. Constraints N/A Range Length: 1 to 128 characters Default Value N/A
namespace	No	String	Definition Image repository project, which is used to specify the image repository directory that the scan component is to be uploaded to. This parameter is mandatory if get_scan_image_channel is set to Other. Constraints N/A Range Length: 1 to 128 characters Default Value N/A
connect_cluster_id	No	String	Definition Jumper cluster ID. Select a cluster that has been connected to HSS as the jumper cluster. The image synchronization component and scan component will run on the cluster as tasks to help HSS obtain your image information and scan for image security risks. Constraints N/A Range Length: 1 to 64 characters Default Value N/A
get_scan_image_channel	No	String	Definition Method of obtaining the scan component. Constraints N/A Range Swr: Access SWR to obtain the scan component. Other: Manually upload the scan component to the jumper cluster. If you select this mode, you need to call the /v5/{project_id}/image/registries/image-upload-command API to obtain the image upload command of the scan component. Default Value N/A

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Edit the access information of the third-party image repository.

PUT https://{endpoint}/v5/{project_id}/image/registries/ea325892-xxxx-4e2c-bca4-409b8853556b?enterprise_project_id=all_granted_eps

{
  "registry_username" : "me",
  "registry_password" : 123456
}